GET APIにおけるクエリパラメータの指定
GET APIにおいて下記のクエリパラメータは、該当APIが持つスキーマ構造の内容によらずご利用いただけます。
draftKeylimitoffsetqidsdepth（コンテンツ参照、複数コンテンツ参照のみに適応されます）richEditorFormat（旧リッチエディタのみに適応されます）
一方、下記のクエリパラメータは、利用対象となるフィールドが限定され、またフィールドごとに利用方法が異なる場合もございます。
ordersfieldsfilters（equals,not_equals,less_than,greater_than,exists,not_exists,begins_with）
クエリパラメータごとの対象フィールドは以下の通りです。
orders | fields | filters | filters | filters | filters | filters | |
|---|---|---|---|---|---|---|---|
テキストフィールド | - | ◯ | ◯ | ◯ | - | ◯ | ◯ |
テキストエリア | - | ◯ | ◯ | ◯ | - | ◯ | ◯ |
リッチエディタ | - | ◯ | - | ◯ | - | ◯ | ◯（※3） |
旧リッチエディタ（非推奨） | - | ◯ | - | ◯ | - | ◯ | ◯（※3） |
画像 | - | ◯（※1） | - | - | - | ◯ | - |
複数画像 | - | ◯（※1） | - | - | - | ◯ | - |
日時 | ◯ | ◯ | ◯ | ◯ | ◯ | ◯ | ◯（※4） |
真偽値 | - | ◯ | ◯ | - | - | ◯（※2） | - |
セレクトフィールド | - | ◯ | - | ◯ | - | ◯ | - |
コンテンツ参照 | - | ◯ | ◯ | - | - | ◯ | - |
コンテンツ参照 | - | ◯ | - | - | - | - | - |
複数コンテンツ参照 | - | ◯ | - | ◯ | - | ◯ | - |
複数コンテンツ参照 | - | ◯ | - | - | - | - | - |
数字 | ◯ | ◯ | ◯ | - | ◯ | ◯ | - |
カスタムフィールド | - | ◯ | - | - | - | - | - |
カスタムフィールド | ◯ | - | ◯ | ◯ | ◯ | ◯ | ◯ |
繰り返しフィールド | - | ◯ | - | - | - | - | - |
繰り返しフィールド | ◯ | - | - | ◯ | - | ◯ | ◯ |
ファイル | - | ◯（※1） | - | - | - | ◯ | - |
拡張フィールド | - | ◯ | - | - | - | - | - |
拡張フィールド | - | - | ◯（※5） | ◯（※5） | - | ◯（※5） | ◯（※5） |
Information- 「-」と表記されている箇所については、未対応または動作不定となります。
- コンテンツ参照やカスタムフィールドなど、入れ子構造の構築が可能なフィールドについては、その下層のフィールドに対して各種クエリパラメータを指定した場合、動作が不定となる場合がございます。あらかじめご了承ください。
- 「カスタムフィールド（カスタムフィールド内のフィールド）」および「繰り返しフィールド（繰り返しフィールド内のフィールド）」において、「◯」とされている箇所についてはフィールドによっては利用できない場合もございます。
補足事項
（※1）画像やファイル内のキー（url、width、height など）については、指定できません。
（※2）ture or false、いずれの場合もコンテンツは存在するものとみなされます。
（※3）HTMLのタグを除いた文字列の前方一致となります。
（※4）開始期間の指定ではなく、日付の前方一致となります。
（※5）拡張フィールドのメタ情報のみ指定可能です。詳細については「拡張フィールドによる外部データ連携」をご確認ください。
目次