機械翻訳について
  1. コンテンツ配信用のREST API
  2. タスク
  3. アイテム

公開アイテムの検索

get

/content/published/api/v1.1/items

公開されたコンテンツをフィルタするには、この問合せを使用します。 フェッチ、ページ付け、並べ替えるアイテムの数を制御することができます。 さらに、このリソースは一致するアイテムのフィールド値を取得できます。
問合せ式構文は、フィールド値に一致する条件をサポートします。 すべてのフィールドで特定のフレーズを問合せすることもできます。 このような問合せ条件の多くは、AND/OR演算子を使用して連結し、カッコでグループ化することができます。 以下は一般的な問合せの例です。
問合せ式 ?q=(type eq "Employee" AND (fields.emails co "example.com" OR fields.emails co "example.org"))
このリソースで式の使用を問合せ /published/api/v1.1/items?q=(type eq "Employee" AND (fields.emails co "example.com" OR fields.emails co "example.org"))

ノート: 問合せで使用されるフィールド名は、大文字と小文字が区別されます。

一般に、このリソースは2種類のフィルタリングをサポートしています。
  • タイプ内の問合せ: タイプ内の問合せは、そのタイプのフィールドに適用される問合せ条件を許可します。
    たとえば: /published/api/v1.1/items?q=(type eq "Employee" AND fields.role eq "Senior Developer")
    ここで、roleはEmployee型のフィールドです。
    2つのレベルのディープ検索(型付き検索のみ):
    品目のfirstレベル参照フィールドも検索できるため、品目フィールド階層に深く2つのレベルを削除する方法が効果的に提供されます。     2番目のレベルでは、アイテムのフィールドの検索時に提供されるセマンティクスと同じセマンティクスが提供されます。 Searchingでは、最初のレベルを越えて品目参照階層を再帰的に下げることはサポートされていません。 セカンド・レベル・フィールドによるソートはsupported.ではありません
    たとえば:
    /published/api/v1.1/items?q=(type eq "Employee" AND fields.address.street eq "Main St")
    ここで、'address'はタイプ'Employee'の参照タイプ・フィールドの名前で、'street'という名前のフィールドがあります。
  • タイプ間の問合せ: 問合せに型が指定されていない場合、すべての型が問合せされます。 また、複数タイプの問合せが許可され、指定方法に応じて、グローバル問合せまたは複数タイプの問合せとして扱われます。 大カッコ( )を使用して複数のタイプを参照する問合せは、グローバル問合せとして処理され、問合せ条件は標準フィールド(id、type、name、description、typeCategory、slug、translatable、language、createdBy、createdDate、updatedBy、updatedDate、fileExtension、taxonomies)のみに限定されます。
    例えば:
    /published/api/v1.1/items?q=(name eq "John" and (type eq "t1" or type eq "t2") )または/published/api/v1.1/items?q=(description co "users" and (type eq "t1" or type eq "t2") )。     中カッコ{ }を使用する複数タイプを参照する問合せは、標準およびユーザー定義フィールドへ参照できるタイプに渡る一般問合せとして扱われます。
    たとえば:
    /published/api/v1.1/items?q=name eq "John" and {type eq "t1" and fields.ud1 eq "ud1val"}または {type eq "t2"およびfields.ud2 eq "ud2val"}を使用して複数のタイプを参照する問合せ
    タイプ間のカッコ・スタイル問合せの特性。
    1. クロス・タイプ検索は、中カッコ { }の問合せ(q)パラメータの包含型述語で指定されます。
    2. 一致したカッコ・セットに指定できるタイプは1つのみです。
    3. ネストされたカッコは使用できません。
    4. 中カッコとカッコは結合できます。
    5. 中カッコの外側で指定された問合せ述語は、カッコを使用して指定したように動作します。
    6. 例 -
      • {type eq "t1" and fields.ud1 eq "ud1"} - "ud1"は、タイプ"t1"のフィールドである必要があります。 問合せの検証は、そうでない場合には失敗します。
      • {type eq "t1" and fields.ud1 eq "ud1"} または{type eq "t2" and fields.ud2 eq "ud2"} - "ud1"はタイプ"t1"のフィールドである必要があり、"ud2"はタイプ"t2"のフィールドである必要があります
      • {type eq "t2" and fields.ud2 eq "ud2"} またはeq "t1"およびfields.ud1 eq "ud1" ???と入力します。 "t1"と入力するために解決されるブラケット・スタイル検索および"t2"と入力するカッコ・スタイル検索で、"ud1"が"t1"のフィールドであり、"ud2"が"t2"のフィールドである場合は有効です。

どちらの形式でも、デフォルトの一致条件を指定することで、任意のフィールド(任意のフィールド)を検索して検索することができます。 このような基準は、すべてのフィールドのアイテムの値と一致する汎用問合せです。
たとえば:
/published/api/v1.1/items?default="coffee"
/published/api/v1.1/items?q=(type eq "Employee") &default="senior"

どちらの形式でも、標準フィールドを使用した問合せ時に、名前、説明、タイプ、typeCategory、スラグ、言語はtextデータ型(単一値)、idはreferenceデータ型(単一値)、createdDate、updatedDateはdatetimeデータ型(単一値)およびタクソノミは参照データ型(複数値)とみなされます。
オペレータ例サポートされるデータ型説明
eq?q=(name eq "John")

?q=(type eq "DigitalAsset")

?q=(type eq "Employee" and fields.DOB eq "1994/09/26T16:23:45.208")

?q=(type eq "File" and fileextension eq "docx")

?q=(taxonomies.categories.id eq "B9F568DC43C54803AC76012783FA5101")

?q=(taxonomies.categories.name eq "Cars")

?q=(taxonomies.categories.apiName eq "cars-unique")

?q=(taxonomies.categories.nodes.id eq "B9F568DC43C54803AC76012783FA5101")

?q=(taxonomies.categories.nodes.name eq "red")

?q=(taxonomies.categories.nodes.apiName eq "cars")		text, reference, number, decimal, boolean, datetime.等しい演算子(eq)は、問合せで指定された正確な値と一致します。 この演算子は、複数値のデータ型には適用されません。 この演算子で提供される値は、標準フィールド(type)を除いて大文字小文字を区別しません。 この演算子は、値の中の特殊文字を考慮します。
ne?q=(name ne "John")text, reference, number, decimal, boolean, datetime.次と等しくない演算子(ne)は、問合せで指定した値と完全一致しないアイテムを照合します。 この演算子は、複数値のデータ型には適用されません。 この演算子で指定する値は、標準フィールドを除いて大/小文字が区別されません。 この演算子は、値の中の特殊文字を考慮します。
co?q=(type eq "Employee" AND name co "john alex")

?q=(type eq "Car" AND fields.features co "manual")

?q=(taxonomies.categories.name co "red")

?q=(taxonomies.categories.nodes.name co "cars")		text, reference, number, decimal, datetime, largetext演算子(co)は、条件に指定されたすべての単語に一致します。 単語は、値を特殊文字で分割することによって形成されます。 少なくとも1つの単語(この例では、johnまたはalexまたはその両方)を持つ結果が得られます。 この演算子は、検索中に値の中の特殊文字を考慮しません。 この演算子はストップ・ワードの検索を行いません。

この演算子は、単一値属性の場合は「テキスト、largetext」に適用できますが、複数値属性の場合は「テキスト、参照、数値、10進数、日時、largetext」に適用できます。 可能な日時フォーマットを理解するには、下記の「サポートされている日付/日時フォーマット(24時間)」表を参照してください。 この演算子で指定された値は、大文字小文字を区別しません。
nc?q=(name nc "john alex")text, reference, number, decimal, datetime, largetext次を含まない演算子(nc)は、co演算子と同じ条件が一致しないアイテムを照合します。
sw?q=(type eq "Employee" AND name sw "Joh")

?q=(type eq "Employee" AND fields.city sw "Los")

?q=(taxonomies.categories.name sw "cat")

?q=(taxonomies.categories.nodes.name sw "red")		テキストStarts With演算子(sw)は、フィールド条件で指定された最初の文字値にのみ一致します。 この演算子は、複数値のデータ型には適用されません。 この演算子で指定された値は、大文字小文字を区別しません。
ge?q=(type eq "Employee" AND fields.age ge "40")

?q=(type eq "DigitalAsset" AND updatedDate ge "20171026")		数値、小数点、日時演算子(ge)以上は、数値と日時の値にのみ一致します。 可能な日時フォーマットを理解するには、下記の「サポートされている日付/日時フォーマット(24時間)」表を参照してください。 この演算子は、複数値のデータ型には適用されません。
le?q=(type eq "Employee" AND fields.weight le "60.6")数値、小数点、日時演算子(le)以下は、数値と日時の値にのみ一致します。 可能な日時フォーマットを理解するには、下記の「サポートされている日付/日時フォーマット(24時間)」表を参照してください。 この演算子は、複数値のデータ型には適用されません。
gt?q=(type eq "Employee" AND fields.age gt "20")数値、小数点、日時より大きい演算子(gt)は、数値と日時の値にのみ一致します。 可能な日時フォーマットを理解するには、下記の「サポートされている日付/日時フォーマット(24時間)」表を参照してください。 この演算子は、複数値のデータ型には適用されません。
lt?q=(type eq "Employee" AND fields.age lt "20")

?q=(type eq "Employee" AND createdDate lt "1994/09/26T16:23:45.208")		数値、小数点、日時より小さい演算子(lt)は、数値と日時の値だけを照合します。 可能な日時フォーマットを理解するには、下記の「サポートされている日付/日時フォーマット(24時間)」表を参照してください。 この演算子は、複数値のデータ型には適用されません。
mt?q=(type eq "Car" AND fields.review mt "petrol 20KMPL")

?q=(type eq "Employee" AND name mt "Jo?n")

?q=(type eq "Employee" AND name mt "Jo*")

?q=(type eq "Employee" AND fields.role mt "senior*")		テキスト、largetextフレーズ問合せまたは近接検索(一致)演算子(mt)を使用すると、特定の距離内にある単語を検索できます。 結果はベスト・マッチでソートされます。 ガソリン20kmplという基準で指定された値が、petrol燃費が20KMPLをスピードで実行する可能性がある実際のコンテンツを検出する必要がある場合に、コンテンツ・アイテムを検索するのに便利です。

一致演算子ではワイルドカードを使用できます(?または*)が指定の値内の複数の文字に一致するようにします。 この演算子は、単一値型と複数値型の両方のデータ型に適用できます。 この演算子はストップ・ワードの検索を行いません。 この演算子で指定された値は、大文字小文字を区別しません。 完全に一致させるには、検索語を二重引用符で囲みます。 囲み二重引用符は、他のすべてのコンテキストで検索語の一部として扱われます。
smI?q=(type eq "Employee" And fields.city sm "Rome")テキスト、largetext類似問合せ演算子。 この演算子を使用すると、指定した条件と同じように聞こえる値を検索できます - ファジー検索とも呼ばれ、デフォルトでは照合結果の最大2つの編集が使用されます。 "ローマ"は"ドーム"に似ています。 この演算子は、単一値型と複数値型の両方のデータ型に適用できます。 この演算子で指定された値は、大文字小文字を区別しません。
AND?q=(type eq "Employee" AND name eq "John" AND fields.age ge "40")-NA-AND演算子を使用すると、複数の問合せ条件の間にAND条件を置くことができます。 これはORよりも優先されます。
OR?q=(type eq "Employee" AND (name eq "John" OR fields.age ge "40"))-NA-OR演算子を使用すると、複数の問合せ条件の間にOR条件を置くことができます。
( )?q=(type eq "Employee" AND (name eq "John" AND fields.age ge "40"))

?q=(type eq "Employee" AND ((name eq "John" AND fields.age ge "40") OR fields.weight ge 60))		-NA-カッコ。条件内の条件をグループ化する演算子を囲みます。 これは、優先順位が最も高く、その後にANDが続き、ORが続きます。



リクエスト・ヘッダー(オプション):
ヘッダー名ヘッダー値
channelToken{有効なチャネル・トークン値}
Acceptapplication/json

その他のノート
特定の問合せを入力この問合せは常にeq演算子のみを使用します。eqは、大文字小文字を区別する型名で動作します。 マルチ・タイプ問合せがサポートされていますが、複数のタイプの問合せになります。
例:
q=(type eq "Employee")またはq=(type eq "DigitalAsset")は単一タイプの検索で、q=(type eq "Employee" OR type eq "Address")は複数タイプの検索であり、タイプを横断して問合せとみなされます。
日付問合せ日付問合せは、さまざまな日付書式が関連付けられているため、特別なタイプの問合せです。 すべての日時の値は、UTC (タイムゾーン)のみです。 したがって、問合せ結果は、すべての日時フィールドのUTCタイムゾーン形式になります。 データ型がdatetimeのフィールドは、範囲問合せに演算子ge、gt、le、ltを使用し、等価一致にeqを使用する必要があります。

例:
ge演算子を使用してmanufactureDate (datetime)フィールドで製品を問合せします。
https://cecsdomain/content/published/api/v1.1/items?q=(type eq "Product" AND fields.manufactureDate ge "1989-03-26")。 指定された日付形式はYYYY-MM-DDです。

「例」セクションの日付/日時に関する特定の問合せの例を詳しく調べてください。また、以下のセクションでサポートされている日付/日時フォーマットも理解できます。
小数点以下の値 小数問合せは小数点以下3桁までサポートされ、3桁以降の残りの桁は無視されます。https://cecsdomain/content/published/api/v1.1/items?q=(type eq "Product" AND fields.price ge 425.3214)では、価格が425.321以上のすべての製品が作成されます。
ラージ・テキスト・データ型問合せlargetextデータ型のフィールドは格納されないため、問合せ結果はその値を返すことができません。 しかし、フィールド値は問合せ条件で使用できます。
一般的な問合せの検索一般的な問合せの検索はデフォルトの検索問合せです。ユーザーがフィールド名や演算子を使用せずに値だけを検索できる場合に使用できます。 内部的に一般的な検索では、co演算子が使用されます。 この問合せはワイルドカード文字をサポートしていません。 この検索はストップ・ワードの検索を実行しません。
例:
?q=(type eq "Employee") &fields=all&default="John". これにより、値Johnがフィールド名、説明またはユーザー定義フィールドに一致する従業員タイプの検索結果が返されます。
例:
?q=(type eq "Article") &default="skating". これは、値skatingがフィールド名、説明、またはユーザー定義フィールドに一致する「記事」タイプの検索結果を返します。

defaultOperatorを使用して、デフォルトの問合せ式に複数の検索語を接続できます。 検索語はカンマseparated.defaultOperatorで、???または???および???演算子を使用します。
例:
?q=(type eq "Employee") &fields=all&default="John","skating"&defaultOperator=and. これにより、値Johnおよびskatingがフィールド名、説明またはユーザー定義フィールドに一致する従業員タイプの検索結果が返されます。
例:
?q=(type eq "Employee") &fields=all&default="John","skating"&defaultOperator=or. これにより、値Johnまたはskatingがフィールド名、説明またはユーザー定義フィールドに一致する従業員タイプの検索結果が返されます。
ID検索ID属性を使用する検索問合せ。
例:
?q=(type eq "Employee" AND id eq "COREAF29AC6ACA9644F9836E36C7B558F316") idの値は、それ自身で照会されているアイテムに属します。ここでは、Employee型のIDです。
問合せ式に複数のアイテムIDを含めることは可能です
例:
?q=(type eq "Employee" AND (id eq "COREAF29AC6ACA9644F9836E36C7B558F316" OR id eq "COREAF29AC6ACA9644F9836E36C7B558F987"))
カテゴリ検索特定のカテゴリId、カテゴリ名、カテゴリapiName、カテゴリ・ノードid、カテゴリ・ノード名またはカテゴリ・ノードapiName属性でカテゴリ化されたアイテムを検索します。
例:
?q=(taxonomies.categories.id eq "9E1A79EE600C4C4BB727FE3E39E95489")
taxonomies.categories.idの値は、問合せ対象の品目に割り当てられたカテゴリに属します。 問合せ式には複数のカテゴリIdまたは名前を含めることができます。
例:
?q=(taxonomies.categories.name co "cars" OR taxonomies.categories.name sw "red")
例:
?q=( taxonomies.categories.api Name eq "All-furnitures")
taxonomies.categories.api名の値は、問い合わされているアイテムに割り当てられているカテゴリに属します。 問合せ式には複数のカテゴリのapiName値を含めることができます。
例:
?q=(taxonomies.categories.nodes.id eq "9E1A79EE600C4C4BB727FE3E39E95489")
taxonomies.categories.nodes.idの値は、問合せの対象となるアイテムに割り当てられた任意のカテゴリに属します。 問合せ式には複数のカテゴリ・ノードIdまたはノード名を含めることができます。
例:
?q=( taxonomies.categories.nodes.name co "cars" OR taxonomies.categories.nodes.name sw "red")
例:
?q=( taxonomies.categories.nodes.api Name eq "All-furnitures" OR taxonomies.categories.nodes.api Name eq "all-accessories")
taxonomies.categories.nodes.api名の値は、問い合わされているアイテムに割り当てられているカテゴリのノードに属します。 問合せ式には、複数のカテゴリ・ノードのapiName値を含めることができます。
参照フィールドの検索参照属性を使用した検索問合せ。
例:
?q=(type eq "Employee" AND fields.department eq "COREAF29AC6ACA9644F9836E36C7B558F412")
departmentの値はDepartmentという型のアイテムのidに属します。
バイナリ・ファイル内の一致するテキストの問合せバイナリ・ファイル・テキストでの検索(型付き検索ではデジタル・アセットのみ)。 デジタル・アセットのバイナリ・ファイル・テキストでの検索は、タイプ内または特定のタイプ間の検索問合せでmetadata.extractedTextパラメータを使用してサポートされます。 サポートされている演算子は、co、ncおよびmtです。
例:
?q=(type eq "File" AND metadata.extractedText co "Employee")
?q=((type eq "cdt1" or type eq "cdt2") AND metadata.extractedText mt "installed")
任意のフィールドとバイナリ・ファイルの一致するテキストを問い合せますフィールドおよびバイナリ・ファイル・テキストの検索(型付き検索ではコンテンツまたはデジタル・アセットが検索されます)。 フィールドおよびバイナリ・ファイル・テキストの検索は、タイプ内または特定のタイプ間の検索問合せでanyFieldパラメータを使用してサポートされます。 サポートされている演算子は、co、ncおよびmtです。
例:
?q=(type eq "contentType1" AND anyField co "Employee")
?q=({type eq "contentType1" AND anyField mt "installed"} OR {type eq "cdt1" AND anyField mt "installed"})
サポートされている日付/日時フォーマット(24時間)
フォーマット例
YYYY-MM-DD1989-03-26
YYYY/MM/DD1989/03/26
DD-MM-YYYY26-03-1989
DD/MM/YYYY26/03/1989
YYYY-MM-DD''T''hh:mm:ss1989-03-26T18:32:38
YYYY/MM/DD''T''hh:mm:ss1989/03/26T18:32:38
DD-MM-YYYY''T''hh:mm:ss26-03-1989T18:32:38
DD/MM/YYYY''T''hh:mm:ss26/03/1989T18:32:38
YYYY-MM-DD''T''hh:mm:ss.SSS1989-03-26T18:32:38.840
YYYY/MM/DD''T''hh:mm:ss.SSS1989/03/26T18:32:38.840
DD-MM-YYYY''T''hh:mm:ss.SSS26-03-1989T18:32:38.840
DD/MM/YYYY''T''hh:mm:ss.SSS26/03/1989T18:32:38.840
YYYYMMDD19890326
YYYYMMDDhhmmss19890326183238
YYYYMMDDhhmmssSSS19880326183238840

リクエスト

問合せパラメータ
  • パブリッシュ・ターゲットのチャネル・トークン。 チャネル・トークンは、問合せパラメータまたはリクエスト・ヘッダーのいずれかとして提供する必要があります。
  • デフォルトの検索問合せ式。
  • デフォルトの検索問合せ演算子。 このパラメータはオプションです。 'or'および'and'演算子を受け入れます。 指定しない場合、defaultOperatorはorとみなされます。
  • fieldsパラメータは、照会されたアイテムの返されるフィールドと値を制御するために使用されます。 このパラメータは、コンマで区切られたフィールド名または「すべて」のリストを受け入れます。 すべてのユーザー定義フィールド名にプレフィクスfieldsを付け、その後にピリオド(。)を付ける必要があります。 これらのフィールドは照会された各アイテムごとに返されます。 すべてのフィールド名で大文字と小文字が区別されるため、ユーザーは検索問合せで正しいフィールド名を指定する必要があります。 フィールドが「すべて」 (大/小文字区別なし)として指定されている場合、タイプ固有の問合せの場合は、すべての標準フィールド、および大規模テキスト、json、ロケーション・データ型以外のユーザー定義フィールドが問合せ対象の各アイテムに対して戻されます。一方、すべてのタイプに対する問合せの場合は、すべての標準フィールドのみが戻されます。 標準フィールドidとtypeは常にレスポンスで返され、フィルタリングすることはできません。 このパラメータは問合せではオプションで、デフォルトでは問合せ結果にはID、名前、説明、およびタイプのみがレスポンスに表示されます。 問合せで指定された不正または無効なフィールド名は無視されます。

    ブレース・スタイルのクロス・タイプ問合せのコンテキストでは、構文name,{typename1:fields.userdefinedfieldname1, fields.userdefinedfieldname2},{typename2:fields.userdefinedfieldname1}を使用してタイプ固有のフィールドを指定できます。前述の例では、typename1タイプのすべてのアイテムにフィールドがあります - 名前、userdefinedfieldname1およびuserdefinedfieldname2。typename2タイプのすべてのアイテムにはフィールドが含まれます - 名前、userdefinedfieldname1。     型付きフィールド句で参照されているタイプにクロス・タイプの問合せが解決されない場合、エラーがスローされます。 例: ?q=(type eq "LocationType") &fields= fields.state, fields.country,updatedDate
    これにより、stateおよびcountryフィールドを含むLocationTypeの検索結果で、ID、タイプ、状態、国、updatedDateが返されます。
    例: ?q=(type eq "LocationType") &fields=all
    これにより、すべての標準フィールドと、largetext、json、locationデータ型を除くすべてのユーザー定義フィールドが返されます
    例: ?fields=all
    タイプは検索問合せで使用されないため(グローバル問合せとして動作する)標準フィールド(id、type、typeCategory、name、description、slug、language、createdDate、updatedDate、taxonomies、renditions)のみが返されます
    例: ?fields=name,createdDate
    タイプは検索問合せで使用されないため(グローバル問合せとして機能)、これは標準フィールド(ID、名前、createdDateおよびタイプなど)のみを返します
    デフォルト値: name,description,slug,language,translatable,createdDate,updatedDate,fileExtension
  • このパラメータは、負でない整数を受け入れ、結果のサイズの制御に使用します。 制限に使用できる最大値は500です。
    デフォルト値: 100
  • レスポンス行の開始インデックス。
    デフォルト値: 0
  • orderByパラメータは、照会されたアイテムの順序(昇順または降順)を制御するために使用されます。 このパラメータは問合せではオプションで、デフォルトでは結果は「検索スコア」の降順でソートされます。 このパラメータは、featured()またはコロン(:)で区切られたフィールド名を受け入れます。ユーザーはこれを使用して結果をソートし、順序をソートします。 複数のソート順序はセミコロン(;)で区切られます。
    format : orderBy={fieldName1}:{asc/desc};{fieldName2}:{asc/desc} (*ノート: ascは昇順を表し、desは降順を表します。ascとdesは常に小文字です。)
    型固有の問合せでは、フィールド名はname、createdDate、updatedDate (標準フィールド)またはユーザー定義フィールド(単一値データ型 - 「数値、小数点、日時」)です。     すべてのユーザー定義のフィールド名には、プレフィクス・フィールドとピリオド(。)を付ける必要があります。 クロス・タイプ検索のコンテキストでは、このパラメータに型付きセクションがあり、{typename1:fields.userdefinedfieldname1 :asc|desc};{typename2:fields.userdefinedfieldname1 :asc|desc}という形式をとることができます。 ソート・キー・パラメータは、一致するbraces.Theソート順序のセットごとに1つのフィールドのみをサポートし、デフォルトでは昇順です。 問合せで指定された不正または無効なフィールド名は無視されます。featured()が指定されている場合、結果は適用されたフィルタへのアイテムの関連性でソートされます。

    OrderByパラメータは、2つのレベルのフィールドによるソートもサポートしています。     レベルが2つのソート・フィールドがある場合は、OrderByパラメータの唯一のソート・フィールドにすることができます。
    OrderByパラメータでは、タクソノミ・ルート・カテゴリおよびルート・カテゴリのサブカテゴリによるソートもサポートされています。     追加のソート・パラメータは次のとおりです。
    taxonomies.shortName ["short name of taxonomy"]:{asc/desc}; taxonomies.categories.nodes.name ["short name of taxonomy"|"taxonomy name","category1","category2","category3"]、ここでcategory1,category2,category3など。
    指定されたタクソノミ"taxonomy name"のサブカテゴリです。

    例: orderBy=name:asc
    名前の昇順ですべてのアイテムを返します。
    例: orderBy=updateDate:asc
    updateDateの昇順ですべてのアイテムを返します。
    例 : orderBy= fields.age :des
    年齢の高い順にすべてのアイテムを返します。
    例: orderBy= fields.age
    年齢の低い順にすべてのアイテムを返します。
    例 : default=apples&orderBy=featured()
    アプレットに対するアイテムの関連性でソートされたすべてのアイテムを返します
    例 : orderBy= fields.blogauthor.authorage
    参照フィールド「blogauthor」によって参照される作成者の年齢の昇順にすべてのアイテムを返します。
    例 : orderBy= fields.blogauthor.fields.authorage &twolvl_v1_1=true
    参照フィールド「blogauthor」によって参照される作成者の年齢の昇順にすべてのアイテムを返します。
    例 : orderBy= taxonomies.shortName ["loc"]; taxonomies.categories.nodes.name ["loc"|"Location","emea","china","industry"];
    taxonomies.categories.nodes.name ["loc"|"Location","americas","brazil","industry"]
    パス"/Location/emea/china/industry""、パス"/Location/americas/brazil/industry"を持つカテゴリのサブカテゴリである"loc"のルート・カテゴリの昇順でソートされたすべてのアイテムを返します。
  • このパラメータは、フィールド値に一致する問合せ式条件を受け入れます。 このような問合せ条件の多くは、AND/OR演算子を使用して結合でき、カッコで囲まれています。 問合せ条件の値は、{fieldName} {operator} "{fieldValue}"の形式に従います。 タイプ間の問合せの場合、フィールド名は標準フィールド(id、type、name、description、typeCategory、slug、language、createdDate、updatedDate、「タクソノミ」)に制限されます。 ただし、型固有の問合せの場合、フィールド名は標準フィールドおよびユーザー定義フィールド(largeTextデータ型のフィールドを除く)に制限されます。 演算子で使用できる値は、eq (等しい)、co (含む)、sw (で開始)、ge (以上)、le (以下)、gt (より大きい)、lt (より小さい)、mt (一致)およびsm (類似)のみです。
    例:
    https://{cecsdomain}/content/published/api/v1.1/items?q=(name eq "John")
    例 :
    https://{cecsdomain}/content/published/api/v1.1/items?q=(type eq "Employee" AND name eq "John")
    例 :
    https://{cecsdomain}/content/published/api/v1.1/items?q=(type eq "Employee" AND ((name eq "John" AND field.age ge "40") OR fields.weight gt "70"))
    例 :
    https://{cecsdomain}/content/published/api/v1.1/items?q=( taxonomies.categories.id eq "9E1A79EE600C4C4BB727FE3E39E95489" OR ( taxonomies.categories.name co "cat" AND taxonomies.categories.name co "red"))
    例 :
    https://{cecsdomain}/content/published/api/v1.1/items?q=( taxonomies.categories.nodes.id eq "9E1A79EE600C4C4BB727FE3E39E95489" OR taxonomies.categories.nodes.name co "cars")
  • このパラメータを指定すると、検索APIから「スクロール」の動作が想定されます。 スクロールは、大きな結果セットを取得するための推奨メソッドです。 returnMasterが有効な場合、スクロールは使用できません。スクロールが有効な場合、hasMoreは常にfalseを返します。オフセット・パラメータ値が指定されている場合、スクロール・リクエストでは無視されます。制限パラメータ値はスクロールのコンテキストで解釈され、スクロール・セッションでは固定されます。 その後の制限の変更は、スクロール・セッションでは無視されます。 レスポンスが大きくなりすぎると、レスポンス・ステータスが413 (ペイロードが大きすぎます)になります。
    デフォルト値: false
  • このパラメータは、スクロールIDを指定するために使用されます。scrollTTLおよびqパラメータの元の値は、一貫した結果を得るためにscrollIdを使用するリクエストで常に必要です。 後続のスクロール・リクエストに常にqパラメータを含める必要は、現在のところ以前のリクエストに対して検証されず、同じスクロール・セッション内のパラメータへの変更は無視されます。
  • scrollTTL (ミリ秒) - デフォルト値と最大値30000ミリ秒)は、現在のスクロール・リクエストと次のスクロール・リクエストの間に許可される非アクティブ期間を指定します。 スクロールを使用して検索するすべてのレスポンスには、scrollIdが含まれます。 後続のスクロール・リクエストには、返されたscrollIdがリクエスト間で変更されることがあるため、前のレスポンスから返されたscrollIdが含まれている必要があります。 すべてのスクロール・リクエストはステートレスであるため、scrollTTLは常に予想されます。 scrollTTLの値はリクエスト間で同じである必要はありません。 元の検索問合せ(q)も、後続のスクロール・リクエストごとに想定されます。 scrollIdが無効または期限切れの場合、レスポンス・ステータスは400 (Bad Request)になります。
    デフォルト値: 30000
  • ブール値を受け入れます。 trueに設定すると、レスポンスの合計結果フィールドが表示されます。 検索が10000を超えるアイテムに一致する場合、戻り値は正確でない可能性があります。
    デフォルト値: false
  • このパラメータは値を必要とせず、使用すると、2つのレベルの検索APIが(i) fields.refname.fieldnameを使用して参照先タイプの名前や説明などのsystemフィールドを検索し、(ii) fields.refname.fields.userfieldnameを使用して参照先タイプの「ユーザー定義」フィールドを検索することを示します。 このパラメータを使用しない場合、「互換性モード」では2つのレベルの検索が動作し、fields.reftype.fieldnameのような検索のみがサポートされます。 さらに、fieldnameがシステム定義フィールド名と同じ場合、2つのレベルの検索はfields.reftype.fields.fieldnameと同様に動作します。
トップに戻る

レスポンス

サポートされているメディア・タイプ

200レスポンス

操作の成功
本文()
ルート・スキーマ : CollectionProperties
型: object
CollectionProperties.
Show Source
ネストされたスキーマ : aggregationResults
型: array
集計結果。
Show Source
ネストされたスキーマ: items
型: array
コレクションに含まれる特異なリソース。
Show Source
ネストされたスキーマ : 殺害
型: array
固定品目。 検索リストの上部に固定されたアイテムを表示
Show Source
ネストされたスキーマ: properties
型: object
使用可能なその他のプロパティ
Show Source
追加のコレクション・プロパティ。
ネストされたスキーマ : AggregationResult
型: object
Show Source
ネストされたスキーマ: items
型: object
ネストされたスキーマ : additionalProperties
型: object

400レスポンス

不正リクエスト。 サーバーは、不正な構文、無効なデータまたはメッセージ・フレーミングのために、クライアント側でリクエストを処理できません。

403レスポンス

禁止。 クライアントはこのリクエストを実行する権限がありません。

500レスポンス

内部サーバー・エラー システムで予期しないエラーが発生しました。
トップに戻る

例

次の例は、公開されたアイテムを検索する方法を示しています。

curl -i -X GET -H "Accept:application/json" 'http://<hostname>/published/api/v1.1/items'
例1

channelToken:b361a487716547d8a7527021a2d6628cを使用して、摘要がTest2739986407075001_2740145743267005摘要と等しい公開済品目を検索します。

/content/published/api/v1.1/items?q=description+eq+\"Test2739986407075001_2740145743267005 description\"&channelToken=3f37ec061f1a4c3a978d0dd81fda3e51&fields=all

レスポンス本文

{
        "hasMore": false,
        "offset": 0,
        "count": 2,
        "limit": 2,
        "items": [
          {
            "createdDate": {
              "value": "2020-07-10T06:22:38.994Z",
              "timezone": "UTC"
            },
            "taxonomies": {
              "items": []
            },
            "name": "Test2739986407075001_2740145743131004 item",
            "fileExtension": "contentItem",
            "description": "Test2739986407075001_2740145743267005 description",
            "language": "en",
            "links": [
              {
                "href": "https://<hostname>/content/published/api/v1.1/items/COREF81C484DA2A44BD4B9818DDBC186546D?channelToken=3f37ec061f1a4c3a978d0dd81fda3e51",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              }
            ],
            "id": "COREF81C484DA2A44BD4B9818DDBC186546D",
            "updatedDate": {
              "value": "2020-07-10T06:22:38.994Z",
              "timezone": "UTC"
            },
            "mimeType": "contentItem",
            "fileGroup": "contentItem",
            "type": "Test2740036455042000",
            "typeCategory": "ContentType",
            "slug": "1481786140084-test2739986407075001_2740145743131004-item"
          },
          {
            "createdDate": {
              "value": "2020-07-10T06:22:16.747Z",
              "timezone": "UTC"
            },
            "taxonomies": {
              "items": []
            },
            "name": "Test2739986407075001_2740145743131004 item",
            "fileExtension": "contentItem",
            "description": "Test2739986407075001_2740145743267005 description",
            "language": "en",
            "links": [
              {
                "href": "https://<hostname>/content/published/api/v1.1/items/CORED65D3CEE49534776B5EF4DC8D958CEA3?channelToken=3f37ec061f1a4c3a978d0dd81fda3e51",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              }
            ],
            "id": "CORED65D3CEE49534776B5EF4DC8D958CEA3",
            "updatedDate": {
              "value": "2020-07-10T06:22:16.747Z",
              "timezone": "UTC"
            },
            "mimeType": "contentItem",
            "fileGroup": "contentItem",
            "type": "Test2739990400576000",
            "typeCategory": "ContentType",
            "slug": "1481786139966-test2739986407075001_2740145743131004-item"
          }
        ],
        "links": [
          {
            "href": "https://<hostname>/content/published/api/v1.1/items?q=description eq \"Test2739986407075001_2740145743267005 description\"&channelToken=3f37ec061f1a4c3a978d0dd81fda3e51&fields=all",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/published/api/v1.1/items?q=description eq \"Test2739986407075001_2740145743267005 description\"&channelToken=3f37ec061f1a4c3a978d0dd81fda3e51&fields=all",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/published/api/v1.1/metadata-catalog/items?channelToken=3f37ec061f1a4c3a978d0dd81fda3e51",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          },
          {
            "href": "https://<hostname>/content/published/api/v1.1/items?q=description eq \"Test2739986407075001_2740145743267005 description\"&channelToken=3f37ec061f1a4c3a978d0dd81fda3e51&fields=all&offset=0",
            "rel": "first",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/published/api/v1.1/items?q=description eq \"Test2739986407075001_2740145743267005 description\"&channelToken=3f37ec061f1a4c3a978d0dd81fda3e51&fields=all&offset=0",
            "rel": "last",
            "method": "GET",
            "mediaType": "application/json"
          }
        ]
      }
例2

公開された次のタイプのアイテムを検索 : channelToken:b361a487716547d8a7527021a2d6628cを使用した、フィールドstringSingleの値としてのTest2739990400576000およびサンプル・テキストitem1。

/content/published/api/v1.1/items?q=type+eq+\"Test2739990400576000\"+and+fields.stringSingle+eq+\"sample+text+item1\"&channelToken=3f37ec061f1a4c3a978d0dd81fda3e51&fields=all

レスポンス本文

{
        "hasMore": false,
        "offset": 0,
        "count": 1,
        "limit": 1,
        "items": [
          {
            "createdDate": {
              "value": "2020-07-10T06:22:16.747Z",
              "timezone": "UTC"
            },
            "taxonomies": {
              "items": []
            },
            "name": "Test2739986407075001_2740145743131004 item",
            "fileExtension": "contentItem",
            "description": "Test2739986407075001_2740145743267005 description",
            "language": "en",
            "links": [
              {
                "href": "https://<hostname>/content/published/api/v1.1/items/CORED65D3CEE49534776B5EF4DC8D958CEA3?channelToken=3f37ec061f1a4c3a978d0dd81fda3e51",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              }
            ],
            "updatedDate": {
              "value": "2020-07-10T06:22:16.747Z",
              "timezone": "UTC"
            },
            "id": "CORED65D3CEE49534776B5EF4DC8D958CEA3",
            "type": "Test2739990400576000",
            "typeCategory": "ContentType",
            "mimeType": "contentItem",
            "fileGroup": "contentItem",
            "fields": {
              "booleanSingle": true,
              "referenceSingle": {
                "id": "CORE07D2B709CD4F443FAE0A2EF3EE7C1FA3",
                "type": "Test2740041803418992",
                "typeCategory": "ContentType",
                "links": [
                  {
                    "href": "https://<hostname>/content/published/api/v1.1/items/CORE07D2B709CD4F443FAE0A2EF3EE7C1FA3?channelToken=3f37ec061f1a4c3a978d0dd81fda3e51",
                    "rel": "self",
                    "method": "GET",
                    "mediaType": "application/json"
                  }
                ]
              },
              "intSingle": 100,
              "digitalAssetReferenceSingle": {
                "id": "CONT92D59C9D771844019E16BD47E2AA36C2",
                "type": "DigitalAsset",
                "typeCategory": "DigitalAssetType",
                "links": [
                  {
                    "href": "https://<hostname>/content/published/api/v1.1/items/CONT92D59C9D771844019E16BD47E2AA36C2?channelToken=3f37ec061f1a4c3a978d0dd81fda3e51",
                    "rel": "self",
                    "method": "GET",
                    "mediaType": "application/json"
                  }
                ]
              },
              "dateTimeSingle": {
                "value": "2017-10-30T10:10:29.208Z",
                "timezone": "UTC"
              },
              "floatSingle": 10.2,
              "stringSingle": "sample text item1",
              "largeTextSingle": "large text item1 large text item1"
            },
            "slug": "1481786139966-test2739986407075001_2740145743131004-item"
          }
        ],
        "links": [
          {
            "href": "https://<hostname>/content/published/api/v1.1/items?q=type eq \"Test2739990400576000\" and fields.stringSingle eq \"sample text item1\"&channelToken=3f37ec061f1a4c3a978d0dd81fda3e51&fields=all",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/published/api/v1.1/items?q=type eq \"Test2739990400576000\" and fields.stringSingle eq \"sample text item1\"&channelToken=3f37ec061f1a4c3a978d0dd81fda3e51&fields=all",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/published/api/v1.1/metadata-catalog/items?channelToken=3f37ec061f1a4c3a978d0dd81fda3e51",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          },
          {
            "href": "https://<hostname>/content/published/api/v1.1/items?q=type eq \"Test2739990400576000\" and fields.stringSingle eq \"sample text item1\"&channelToken=3f37ec061f1a4c3a978d0dd81fda3e51&fields=all&offset=0",
            "rel": "first",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/published/api/v1.1/items?q=type eq \"Test2739990400576000\" and fields.stringSingle eq \"sample text item1\"&channelToken=3f37ec061f1a4c3a978d0dd81fda3e51&fields=all&offset=0",
            "rel": "last",
            "method": "GET",
            "mediaType": "application/json"
          }
        ]
      }
例3

次のタイプの公開済アイテムを検索 : Test2746297847744000 with fieldValue Test2746294166794002にはサンプル・テキストが含まれており、fieldValue for Test2746294167170006はchannelToken:b361a487716547d8a7527021a2d6628c.で100を超えています。

/content/published/api/v1.1/items?q=type+eq+\"Test2746297847744000\"+and+fields.Test2746294166794002+co+\"sample+text\"+and+fields.Test2746294167170006+gt+\"100\"&channelToken=7a53863f0ca74c348f0d560646ffe56d&fields=all

レスポンス本文

{
        "hasMore": false,
        "offset": 0,
        "count": 2,
        "limit": 2,
        "items": [
          {
            "createdDate": {
              "value": "2020-07-10T06:32:25.230Z",
              "timezone": "UTC"
            },
            "taxonomies": {
              "items": []
            },
            "name": "Test2746293843126001_R2746387005673008",
            "fileExtension": "contentItem",
            "description": "Test2746293843126001_S2746387005767999 description",
            "language": "en",
            "links": [
              {
                "href": "https://<hostname>/content/published/api/v1.1/items/CORE831CE98B1BDF44D59AB82F8955305682?channelToken=7a53863f0ca74c348f0d560646ffe56d",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              }
            ],
            "updatedDate": {
              "value": "2020-07-10T06:32:25.230Z",
              "timezone": "UTC"
            },
            "mimeType": "contentItem",
            "fileGroup": "contentItem",
            "id": "CORE831CE98B1BDF44D59AB82F8955305682",
            "type": "Test2746297847744000",
            "typeCategory": "ContentType",
            "fields": {
              "Test2746294166794002": "sample text",
              "Test2746294167106004": "large text item3 large text item3",
              "Test2746294167170006": 10000,
              "Test2746294167331002": {
                "value": "2019-10-30T10:10:29.208Z",
                "timezone": "UTC"
              },
              "Test2746294167378004": {
                "id": "CORE722325FBA720421EA711500EFAB0A1AD",
                "type": "Test2746335321277004",
                "typeCategory": "ContentType",
                "links": [
                  {
                    "href": "https://<hostname>/content/published/api/v1.1/items/CORE722325FBA720421EA711500EFAB0A1AD?channelToken=7a53863f0ca74c348f0d560646ffe56d",
                    "rel": "self",
                    "method": "GET",
                    "mediaType": "application/json"
                  }
                ]
              },
              "Test2746294167224008": 100.1,
              "Test2746294167277990": false
            },
            "slug": "1481786140778-test2746293843126001_r2746387005673008"
          },
          {
            "createdDate": {
              "value": "2020-07-10T06:32:14.364Z",
              "timezone": "UTC"
            },
            "taxonomies": {
              "items": []
            },
            "name": "Test2746293843126001_R2746372598337004",
            "fileExtension": "contentItem",
            "description": "Test2746293843126001_S2746372598582995 description",
            "language": "en",
            "links": [
              {
                "href": "https://<hostname>/content/published/api/v1.1/items/CORE9D97CD95074544FBAE84218C609EC282?channelToken=7a53863f0ca74c348f0d560646ffe56d",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              }
            ],
            "updatedDate": {
              "value": "2020-07-10T06:32:14.364Z",
              "timezone": "UTC"
            },
            "id": "CORE9D97CD95074544FBAE84218C609EC282",
            "type": "Test2746297847744000",
            "typeCategory": "ContentType",
            "mimeType": "contentItem",
            "fileGroup": "contentItem",
            "fields": {
              "Test2746294166794002": "sample text",
              "Test2746294167106004": "large text item2 large text item2",
              "Test2746294167170006": 1000,
              "Test2746294167331002": {
                "value": "2018-10-30T10:10:29.208Z",
                "timezone": "UTC"
              },
              "Test2746294167378004": {
                "id": "CORE4E2BE1B708DE4C4494235C4D398006B2",
                "type": "Test2746335321277004",
                "typeCategory": "ContentType",
                "links": [
                  {
                    "href": "https://<hostname>/content/published/api/v1.1/items/CORE4E2BE1B708DE4C4494235C4D398006B2?channelToken=7a53863f0ca74c348f0d560646ffe56d",
                    "rel": "self",
                    "method": "GET",
                    "mediaType": "application/json"
                  }
                ]
              },
              "Test2746294167224008": 20.1,
              "Test2746294167277990": false
            },
            "slug": "1481786140749-test2746293843126001_r2746372598337004"
          }
        ],
        "links": [
          {
            "href": "https://<hostname>/content/published/api/v1.1/items?q=type eq \"Test2746297847744000\" and fields.Test2746294166794002 eq \"sample text\" and fields.Test2746294167170006 gt \"100\"&channelToken=7a53863f0ca74c348f0d560646ffe56d&fields=all",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/published/api/v1.1/items?q=type eq \"Test2746297847744000\" and fields.Test2746294166794002 eq \"sample text\" and fields.Test2746294167170006 gt \"100\"&channelToken=7a53863f0ca74c348f0d560646ffe56d&fields=all",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/published/api/v1.1/metadata-catalog/items?channelToken=7a53863f0ca74c348f0d560646ffe56d",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          },
          {
            "href": "https://<hostname>/content/published/api/v1.1/items?q=type eq \"Test2746297847744000\" and fields.Test2746294166794002 eq \"sample text\" and fields.Test2746294167170006 gt \"100\"&channelToken=7a53863f0ca74c348f0d560646ffe56d&fields=all&offset=0",
            "rel": "first",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/published/api/v1.1/items?q=type eq \"Test2746297847744000\" and fields.Test2746294166794002 eq \"sample text\" and fields.Test2746294167170006 gt \"100\"&channelToken=7a53863f0ca74c348f0d560646ffe56d&fields=all&offset=0",
            "rel": "last",
            "method": "GET",
            "mediaType": "application/json"
          }
        ]
      }
    }
  ]
}
トップに戻る