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

公開されたカテゴリの検索

get

/content/published/api/v1.1/taxonomies/{id}/categories

この問合せを使用して、公開されたカテゴリを検索します。 フェッチ、ページ区切りおよびソートの対象となるカテゴリの数を制御できます。 さらに、このリソースは一致するアイテムのフィールド値を取得できます。
問合せ式構文は、フィールド値に一致する条件をサポートします。 問合せ条件は、AND/OR演算子を使用して結合でき、カッコ付きでグループ化できます。 以下は一般的な問合せの例です。
問合せ式 ?q=(name co "car")
このリソースで式の使用を問合せ /published/api/v1.1/taxonomies/{id}/categories?q=(name co "car")


一般に、このリソースではフィルタリングが1形式でサポートされています。
  • タクソノミ内のすべてのカテゴリの問合せ: タクソノミのすべてのカテゴリを問い合せます。 ただし、問合せ条件は標準フィールド(id、name、parent.id)またはオプション・フィールド(ancestors.id、ancestors.name、ancestors.apiName) (あるいはその両方)に制限されます。
    たとえば: /published/api/v1.1/taxonomies/{id}/categories?q=(id eq "B0A39B47122C4CE88A6CD52B90C15263")





オペレータ例サポートされるデータ型説明
eqq=(id eq "B0A39B47122C4CE88A6CD52B90C15263")

q=(name eq "Cars")

q=(parent.id eq "C7117D407B1845DEAABBE00526D112FB")

q=(ancestors.id eq "C7117D407B1845DEAABBE00526D112FB")

q=(ancestors.name eq "car")

q=(ancestors.apiName eq "tax-c-c1")		テキスト等しい演算子(eq)は、問合せで指定された正確な値と一致します。 この演算子に指定する値では、識別子フィールド(id、parent.id、ancestors.id)を除き、大/小文字は区別されません (name)。 この演算子は、値の中の特殊文字を考慮します。
coq=(name co "car red")

q=(ancestors.name co "car")

テキスト演算子(co)は、条件に指定されたすべての単語に一致します。 これには、少なくとも1つの単語(この例では、「車」またはred、あるいはその両方)が含まれる結果が示されます。 この演算子は、検索中に値の中の特殊文字を考慮しません。

単一値属性の場合、この演算子はtextに対して適用できます。 この演算子で指定された値は、大文字小文字を区別しません。
swq=(name sw "Car")

q=(ancestors.name sw "ca")		テキストStarts With演算子(sw)は、フィールド条件で指定された最初の文字値にのみ一致します。 この演算子で指定された値は、大文字小文字を区別しません。



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

リクエスト

パス・パラメータ
問合せパラメータ
  • パブリッシュ・ターゲットのチャネル・トークン。 チャネル・トークンは、問合せパラメータまたはリクエスト・ヘッダーのいずれかとして提供する必要があります。
  • フィールド・パラメータを使用して、問い合せたカテゴリで返されるフィールドと値を制御します。 このパラメータは、コンマで区切られたフィールド名または「すべて」のリストを受け入れます。 これらのフィールドは、問合せの対象となるカテゴリごとに返されます。 すべてのフィールド名で大文字と小文字が区別されるため、ユーザーは検索問合せで正しいフィールド名を指定する必要があります。 フィールドを「すべて」 (大/小文字を区別しない)として指定すると、すべての標準フィールドおよびオプションのフィールドが各カテゴリに返されます。 各カテゴリには、標準フィールド(id、name、description、parent)とオプション・フィールド(「祖先」、children)の両方があります。 idの標準フィールドは、常にレスポンスで返され、フィルタで除外できません。 このパラメータは問合せではオプションであり、デフォルトの問合せ結果では、レスポンスでid、nameおよびdescriptionのみが表示されます。 指定したフィールド名が正しくないか無効であると、エラーが発生します。

    例: ?q=(name co "car")&fields=name,description,parent,ancestors
    これにより、nameフィールドにcarを含むカテゴリの検索結果に、id、name、description、parentおよび祖先が返されます。
    例: ?fields=name,parent
    デフォルト制限内のすべてのカテゴリについて、標準フィールド(id、name、parentなど)のみが返されます。
    例: ?fields=name,children
    これにより、id、nameおよびデフォルト制限内のすべてのカテゴリのchildren件数のみが返されます。
    デフォルト値: name,description
  • このパラメータは、負でない整数を受け入れ、結果のサイズの制御に使用します。 制限に使用できる最大値は500です。
    デフォルト値: 100
  • レスポンス行の開始インデックス。
    デフォルト値: 0
  • orderByパラメータは、照会されたアイテムの順序(昇順または降順)を制御するために使用されます。 このパラメータは問合せではオプションであり、既定では結果の順序はありません。 このパラメータには、コロン(:)で区切られたフィールド名を使用できます。ユーザーは、結果とソート順をソートする必要があります。
    形式: orderBy={fieldName}:{asc/des} (*注: ascは昇順を表し、降順はdesを表します。ascとdesは常に小文字です)。
    カテゴリ問合せでは、fieldNameはnameまたはposition (標準フィールド)です。     positionで結果をソートする場合は、parent.idによる検索のみが実際に結果を得ることができることに注意してください。 カテゴリ位置は、特定のレベルまたは指定の親カテゴリ内でのみ一意です。 同じ位置の値を持つ異なるカテゴリがタクソノミの異なるレベルに存在します。 ソート順はオプションで、デフォルトでは昇順です。 指定したフィールド名が正しくないか無効であると、エラーが発生します。

    例 : orderBy=name:asc
    すべてのカテゴリをnameの昇順で返します。

    例 : orderBy=name:des
    すべてのカテゴリをnameの降順で返します。

    例: orderBy=position:asc
    すべてのカテゴリをpositionの昇順で返します。

    例: orderBy=position:des
    すべてのカテゴリをpositionの降順で返します。
  • このパラメータは、フィールド値に一致する問合せ式条件を受け入れます。 このような問合せ条件の多くは、AND/OR演算子を使用して結合でき、カッコで囲まれています。 問合せ条件の値は、{fieldName} {operator} "{fieldValue}"の形式に従います。 演算子で使用できる値は、eq (等しい)、co (含む)およびsw (で始まる)のみです。
    例:
    https://{cecsdomain}/content/published/api/v1.1/taxonomies/{id}/categories?q=(name eq "Furnitures")
    これにより、名前"Furnitures"と正確に一致するすべてのカテゴリが返されます。
    例:
    https://{cecsdomain}/content/published/api/v1.1/taxonomies/{id}/categories?q=(name co "chairs" OR name co "red")
    これにより、"chairs"や"red"という単語を含むすべてのカテゴリが返されます。
    例:
    https://{cecsdomain}/content/published/api/v1.1/taxonomies/{id}/categories?q=(name sw "cars")
    これにより、名前が"cars"で始まるすべてのカテゴリが返されます。
    例:
    https://{cecsdomain}/content/published/api/v1.1/taxonomies/{id}/categories?q=(apiName eq "cars-apiname")
    これにより、apiNameがcars-apinameと一致するすべてのカテゴリが返されます。
    例:
    https://{cecsdomain}/content/published/api/v1.1/taxonomies/{id}/categories?q=(id eq "B0A39B47122C4CE88A6CD52B90C15263")
    これは、指定された識別子を持つカテゴリを返します。
    例:
    https://{cecsdomain}/content/published/api/v1.1/taxonomies/{id}/categories?q=(ancestors.id eq "B0A39B47122C4CE88A6CD52B90C15263")
    これは、指定された識別子を持つ祖先を持つカテゴリを返します。
    例:
    https://{cecsdomain}/content/published/api/v1.1/taxonomies/{id}/categories?q=(ancestors.name eq "Furnitures")
    これにより、Furnituresという名前と完全に一致する祖先を持つすべてのカテゴリが返されます。
    例:
    https://{cecsdomain}/content/published/api/v1.1/taxonomies/{id}/categories?q=(ancestors.name co "chairs" OR ancestors.name co "red")
    これにより、「chairs」または「red」という単語を含む祖先を持つすべてのカテゴリが返されます。
    例:
    https://{cecsdomain}/content/published/api/v1.1/taxonomies/{id}/categories?q=(ancestors.name sw "cars")
    これにより、名前がcarsで始まる祖先を持つすべてのカテゴリが返されます。
    例:
    https://{cecsdomain}/content/published/api/v1.1/taxonomies/{id}/categories?q=(ancestors.apiName eq "cars-apiname")
    これにより、apiNameがcars-apinameと一致するすべてのカテゴリが返されます。
    例:
    https://{cecsdomain}/content/published/api/v1.1/taxonomies/{id}/categories?q=(parent.id eq "C7117D407B1845DEAABBE00526D112FB") &orderBy=position:asc
    これにより、指定された親識別子の下のすべての子カテゴリが、昇順でソートされて返されます。
    例:
    https://{cecsdomain}/content/published/api/v1.1/taxonomies/{id}/categories?q=(parent.id eq "C7117D407B1845DEAABBE00526D112FB" AND name co "blue")
    指定した親識別子の下にあるすべての子カテゴリの名前に青色の単語が含まれている場合、それらの子カテゴリがすべて返されます。
  • ブール値を受け入れます。 Trueに設定すると、レスポンスの結果フィールド合計が表示されます。
    デフォルト値: false
トップに戻る

レスポンス

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

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>/content/published/api/v1.1/taxonomies/{id}/categories'
例1

タクソノミIDを持つ公開済タクソノミ・カテゴリを検索: 26950D77A5654D8BA407AC9F7DBCFF1F,カテゴリIDを持つ: 2069018ECE874C2DAA4051E9C16AD244とchannelToken: 1a3885a5a75b40baafe6495eb0b1125b.

/content/published/api/v1.1/taxonomies/26950D77A5654D8BA407AC9F7DBCFF1F/categories?q=%28+id+eq+%222069018ECE874C2DAA4051E9C16AD244%22%29&totalResults=true&offset=0&orderBy=name%3Aasc&channelToken=1a3885a5a75b40baafe6495eb0b1125b&fields=all

レスポンス本文

{
        ody": {
        "hasMore": false,
        "offset": 0,
        "count": 1,
        "limit": 1,
        "totalResults": 1,
        "items": [
          {
            "apiName": "t31-c-c-c1",
            "id": "2069018ECE874C2DAA4051E9C16AD244",
            "name": "car red medium",
            "description": "car red medium description",
            "position": 1,
            "parent": {
              "id": "50AE00A8234B4AE1B675D36989F8B9CF",
              "name": "car red",
              "apiName": "t31-c-c"
            },
            "ancestors": [
              {
                "id": "6775D3D56E184CC3B8EC59A32AF1DD73",
                "name": "car",
                "apiName": "t31-c"
              },
              {
                "id": "50AE00A8234B4AE1B675D36989F8B9CF",
                "name": "car red",
                "apiName": "t31-c-c"
              }
            ],
            "links": [
              {
                "href": "https://<hostname>/content/published/api/v1.1/taxonomies/26950D77A5654D8BA407AC9F7DBCFF1F/categories/2069018ECE874C2DAA4051E9C16AD244?channelToken=1a3885a5a75b40baafe6495eb0b1125b",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              }
            ]
          }
        ],
        "links": [
          {
            "href": "https://<hostname>/content/published/api/v1.1/taxonomies/26950D77A5654D8BA407AC9F7DBCFF1F/categories?q=( id eq \"2069018ECE874C2DAA4051E9C16AD244\")&totalResults=true&offset=0&orderBy=name:asc&channelToken=1a3885a5a75b40baafe6495eb0b1125b&fields=all",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/published/api/v1.1/taxonomies/26950D77A5654D8BA407AC9F7DBCFF1F/categories?q=( id eq \"2069018ECE874C2DAA4051E9C16AD244\")&totalResults=true&offset=0&orderBy=name:asc&channelToken=1a3885a5a75b40baafe6495eb0b1125b&fields=all",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/published/api/v1.1/metadata-catalog/taxonomies/26950D77A5654D8BA407AC9F7DBCFF1F/categories?channelToken=1a3885a5a75b40baafe6495eb0b1125b",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          },
          {
            "href": "https://<hostname>/content/published/api/v1.1/taxonomies/26950D77A5654D8BA407AC9F7DBCFF1F/categories?q=( id eq \"2069018ECE874C2DAA4051E9C16AD244\")&totalResults=true&offset=0&orderBy=name:asc&channelToken=1a3885a5a75b40baafe6495eb0b1125b&fields=all",
            "rel": "first",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/published/api/v1.1/taxonomies/26950D77A5654D8BA407AC9F7DBCFF1F/categories?q=( id eq \"2069018ECE874C2DAA4051E9C16AD244\")&totalResults=true&offset=0&orderBy=name:asc&channelToken=1a3885a5a75b40baafe6495eb0b1125b&fields=all",
            "rel": "last",
            "method": "GET",
            "mediaType": "application/json"
          }
例2

タクソノミIDを持つ公開済タクソノミ・カテゴリを検索 : カテゴリ名がcar blueと等しい26950D77A5654D8BA407AC9F7DBCFF1F(channelToken:1a3885a5a75b40baafe6495eb0b1125bを使用)

/content/published/api/v1.1/taxonomies/26950D77A5654D8BA407AC9F7DBCFF1F/categories?q=%28+name+eq+%22car+blue%22%29&totalResults=true&offset=0&orderBy=name%3Aasc&channelToken=1a3885a5a75b40baafe6495eb0b1125b&fields=all

レスポンス本文

{
        "hasMore": false,
        "offset": 0,
        "count": 1,
        "limit": 1,
        "totalResults": 1,
        "items": [
          {
            "apiName": "t31-car-blue-26950d77a5654d8ba407ac9f7dbcff1f",
            "id": "5096C5762F9540BCB23AA13001CA872E",
            "name": "car blue",
            "description": "car description",
            "position": 1,
            "parent": {
              "id": "6775D3D56E184CC3B8EC59A32AF1DD73",
              "name": "car",
              "apiName": "t31-c"
            },
            "ancestors": [
              {
                "id": "6775D3D56E184CC3B8EC59A32AF1DD73",
                "name": "car",
                "apiName": "t31-c"
              }
            ],
            "links": [
              {
                "href": "https://<hostname>/content/published/api/v1.1/taxonomies/26950D77A5654D8BA407AC9F7DBCFF1F/categories/5096C5762F9540BCB23AA13001CA872E?channelToken=1a3885a5a75b40baafe6495eb0b1125b",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              }
            ]
          }
        ],
        "links": [
          {
            "href": "https://<hostname>/content/published/api/v1.1/taxonomies/26950D77A5654D8BA407AC9F7DBCFF1F/categories?q=( name eq \"car blue\")&totalResults=true&offset=0&orderBy=name:asc&channelToken=1a3885a5a75b40baafe6495eb0b1125b&fields=all",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/published/api/v1.1/taxonomies/26950D77A5654D8BA407AC9F7DBCFF1F/categories?q=( name eq \"car blue\")&totalResults=true&offset=0&orderBy=name:asc&channelToken=1a3885a5a75b40baafe6495eb0b1125b&fields=all",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/published/api/v1.1/metadata-catalog/taxonomies/26950D77A5654D8BA407AC9F7DBCFF1F/categories?channelToken=1a3885a5a75b40baafe6495eb0b1125b",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          },
          {
            "href": "https://<hostname>/content/published/api/v1.1/taxonomies/26950D77A5654D8BA407AC9F7DBCFF1F/categories?q=( name eq \"car blue\")&totalResults=true&offset=0&orderBy=name:asc&channelToken=1a3885a5a75b40baafe6495eb0b1125b&fields=all",
            "rel": "first",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/published/api/v1.1/taxonomies/26950D77A5654D8BA407AC9F7DBCFF1F/categories?q=( name eq \"car blue\")&totalResults=true&offset=0&orderBy=name:asc&channelToken=1a3885a5a75b40baafe6495eb0b1125b&fields=all",
            "rel": "last",
            "method": "GET",
            "mediaType": "application/json"
          }
        ]
      }
    }
  ]
トップに戻る