機械翻訳について
  1. コンテンツ・プレビュー用のREST API
  2. タスク
  3. タクソノミ

リスト・タクソノミ

get

/content/preview/api/v1.1/taxonomies

指定されたチャネルに公開されたすべてのタクソノミのプロモート済バージョンを返します。

リクエスト

問合せパラメータ
  • ターゲット・チャネルのチャネル・トークン。 チャネル・トークンは、問合せパラメータまたはリクエスト・ヘッダーのいずれかとして提供する必要があります。
  • 展開パラメータは、タクソノミ・レスポンスにインラインで子リソース(参照アイテム)を取得するオプションを提供します。 フィールド名またはallのコンマ区切りリストを受け入れます。 このフィールドは現在無視されています。
  • このパラメータは、負でない整数を受け入れ、結果のサイズの制御に使用します。 制限に使用できる最大値は500です。
    デフォルト値: 100
  • レスポンス行の開始インデックス。
    デフォルト値: 0
  • orderByパラメータを使用して、問合せ対象のタクソノミの順序(昇順または降順)を制御します。 このパラメータは問合せではオプションであり、既定では結果の順序はありません。 このパラメータには、コロン(:)で区切られたフィールド名を使用できます。ユーザーは、結果とソート順をソートする必要があります。
    形式: orderBy={fieldName}:{asc/des} (*注: ascは昇順を表し、降順はdesを表します。ascとdesは常に小文字です)。
    フィールド名は、name、createdDate、updatedDate (標準フィールド)です。     ソート順はオプションで、デフォルトでは昇順です。 問合せで指定された不正または無効なフィールド名は無視されます。

    例 : orderBy=name:asc
    昇順の名前ですべてのタクソノミを返します。
    例 : orderBy=updatedDate:asc
    updatedDateの昇順ですべてのタクソノミを返します。
  • ブール値を受け入れます。 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を使用してRESTリソースに対するGETリクエストを発行して、指定されたチャネルに公開されたタクソノミの昇格されたバージョンをリストする方法を示しています:

curl -X GET -H 'Accept: application/json' 'https://host:port/content/preview/api/v1.1/taxonomies?totalResults=true&offset=0&channelToken=c17cc9115c844500adcdb76557732b84'

channelToken:c17cc9115c844500adcdb76557732b84を使用して公開済タクソノミの昇格済バージョンをリストします。

レスポンス本文

{
        "hasMore": false,
        "offset": 0,
        "count": 2,
        "limit": 100,
        "totalResults": 2,
        "items": [
          {
            "id": "1143EFDC17EC47318DFA55D04F098433",
            "name": "allChannels-taxonomyPublished-1-Test1261401333683001",
            "description": "Taxonomy Description - 1",
            "shortName": "ALL",
            "createdDate": {
              "value": "2020-07-08T13:17:58.265Z",
              "timezone": "UTC"
            },
            "updatedDate": {
              "value": "2020-07-08T13:17:58.265Z",
              "timezone": "UTC"
            },
            "links": [
              {
                "href": "https://<hostname>/content/preview/api/v1.1/taxonomies/1143EFDC17EC47318DFA55D04F098433?channelToken=c17cc9115c844500adcdb76557732b84",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              }
            ]
          },
          {
            "id": "AAD120D5F976401384908E2E25ACCB62",
            "name": "twoChannels-taxonomyPublished-2-Test1261401333683001",
            "description": "Taxonomy Description - 2",
            "shortName": "TWO",
            "createdDate": {
              "value": "2020-07-08T13:18:14.091Z",
              "timezone": "UTC"
            },
            "updatedDate": {
              "value": "2020-07-08T13:18:14.091Z",
              "timezone": "UTC"
            },
            "links": [
              {
                "href": "https://<hostname>/content/preview/api/v1.1/taxonomies/AAD120D5F976401384908E2E25ACCB62?channelToken=c17cc9115c844500adcdb76557732b84",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              }
            ]
          }
        ],
        "links": [
          {
            "href": "https://<hostname>/content/preview/api/v1.1/taxonomies?channelToken=c17cc9115c844500adcdb76557732b84&totalResults=true&offset=0",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/preview/api/v1.1/taxonomies?channelToken=c17cc9115c844500adcdb76557732b84&totalResults=true&offset=0",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/preview/api/v1.1/metadata-catalog/taxonomies?channelToken=c17cc9115c844500adcdb76557732b84",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          },
          {
            "href": "https://<hostname>/content/preview/api/v1.1/taxonomies?channelToken=c17cc9115c844500adcdb76557732b84&totalResults=true&offset=0",
            "rel": "first",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/preview/api/v1.1/taxonomies?channelToken=c17cc9115c844500adcdb76557732b84&totalResults=true&offset=0",
            "rel": "last",
            "method": "GET",
            "mediaType": "application/json"
          }
        ]
      }
トップに戻る