→ filtersパラメータのless_than、greater_thanを利用して絞り込みが可能です。
利用例として、例えば【2023年11月1日 00時00分00秒000ミリ秒〜2023年11月30日 23時59分59秒999ミリ秒】の期間内に公開されたコンテンツを取得するケースを考えます。
こうしたケースでは、リスト形式のGET API(GET /api/v1/{endpoint})にて、リクエスト時にfiltersパラメータを付与し、取得条件を指定することでコンテンツの絞り込みをおこないます。
リクエスト例
具体的には、以下のようにリクエストすることで実現可能です。
client
.get({
endpoint: 'sample',
queries: { filters: 'createdAt[greater_than]2023-10-31T14:59:59.999Z[and]createdAt[less_than]2023-11-30T15:00:00.000Z' }
})
.then((res) => console.log(res));
解説
filtersパラメータで、以下の2つの条件を[and]構文で連結させています。なお、それぞれの日時はUTC形式で指定しています。
- createdAt[greater_than]2023-10-31T14:59:59.999Z
- createdAt[less_than]2023-11-30T15:00:00.000Z
1について
こちらは、「(日本標準時、管理画面内の表示において)2023/11/01 00時00分00秒000ミリ秒 以降」を表現しています。
2について
こちらは、「(日本標準時、管理画面内の表示において)2023/11/30 23時59分59秒999ミリ秒 以前」を表現しています。
上記1および2の条件を組み合わせることで、【2023年11月1日 00時00分00秒000ミリ秒〜2023年11月30日 23時59分59秒999ミリ秒】の期間内に公開されたコンテンツの取得を実現しています。
less_thanおよびgreater_thanのいずれも、同じ値の場合は取得されないので、それぞれ1ミリ秒ずつずらした指定となっています。