機械翻訳について
  1. コンテンツ・プレビュー用のREST API
  2. タスク
  3. アイテム・バリエーション

バリエーション・タイプおよび値別に特定のアイテムのバリエーションをプレビュー

get

/content/preview/api/v1.1/items/{id}/variations/{variationType}/{varValue}

バリエーション・タイプおよびバリエーション値でフィルタされたアイテム変動の最新バージョンをプレビューします。

リクエスト

パス・パラメータ
問合せパラメータ
  • ターゲット・チャネルのチャネル・トークン。 チャネル・トークンは、問合せパラメータまたはリクエスト・ヘッダーのいずれかとして提供する必要があります。
  • Expandパラメータは、子リソース(参照アイテム)をアイテム・レスポンスとインラインで取得するオプションを提供します。 フィールド名またはallのコンマ区切りリストを受け入れます。 すべてのユーザー定義フィールド名にプレフィクスfieldsを付け、その後にピリオド(。)を付ける必要があります。 これらのフィールドが参照タイプである場合、リソースはレスポンス内でデータをインライン展開します。 フィールド名は大文字と小文字を区別します。 expandがall (小文字)として指定されると、リクエストされたアイテムの参照タイプのすべてのフィールドが展開されます。 展開が指定されていない場合、アイテム・レスポンスには参照されたアイテムへのリンクが含まれます。
    このフォームの展開は1つのレベルのみでサポートされています。参照先フィールドの最初のレベルを超えて拡張するリクエストは、HTTP 400レスポンスを生成します。     展開に、リクエストされたアイテムの型定義に従って存在しないフィールドが含まれている場合、リソースはHTTP 400を生成します。
    例:
      expand=fields.field1,fields.field2
      expand=all
    ここで、field1、field2は、このアイテムが属するタイプのユーザー定義フィールドの名前です。
トップに戻る

レスポンス

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

200レスポンス

操作の成功
本文()
ルート・スキーマ : アイテム
型: object
Item
Show Source
ネストされたスキーマ : createdDate
型: object
アイテムの作成日。 Map having value, timezone, and description
ネストされたスキーマ: fields
型: object
使用可能なその他のプロパティ
Show Source
ユーザー定義フィールドのデータ。 Map
ネストされたスキーマ : itemVariations
型: array
Show Source
ネストされたスキーマ : RenditionsBean
型: object
Show Source
ネストされたスキーマ : TaxonomiesBean
型: object
Show Source
ネストされたスキーマ : updatedDate
型: object
アイテムの最終更新日。 Map having value, timezone, and description
ネストされたスキーマ : additionalProperties
型: object
ネストされたスキーマ : ItemVariation
型: object
Show Source
ネストされたスキーマ: items
型: array
アイテム・レンディション。
Show Source
ネストされたスキーマ : RenditionBean
型: object
Show Source
ネストされたスキーマ: formats
型: array
Show Source
ネストされたスキーマ : RenditionFormatBean
型: object
Show Source
ネストされたスキーマ: items
型: array
アイテム・タクソノミ。
Show Source
ネストされたスキーマ : TaxonomyItem
型: object
TaxonomyItem
Show Source
ネストされたスキーマ : TaxonomyCategories
型: object
CategoriesBean
Show Source
ネストされたスキーマ: items
型: array
タクソノミ・カテゴリ
Show Source
ネストされたスキーマ : CategoryItem
型: object
CategoryItem
Show Source
ネストされたスキーマ : nodes
型: array
品目に割り当てられたカテゴリのノード。
Show Source
ネストされたスキーマ : CategoryNodeItem
型: object
CategoryNodeBean
Show Source

400レスポンス

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

403レスポンス

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

404レスポンス

リクエストされたリソースは見つかりませんでした。

500レスポンス

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

例

例1:

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行して、IDを持つアイテムの特定の言語バリエーションをプレビューする方法を示しています:

curl -X GET -H 'Accept: application/json' 'https://host:port/content/preview/api/v1.1/items/COREAB9F07B838004C17BD168DA317F3D2BE/variations/language/fr?channelToken=f60f162cd91243bab0aa0544668ab184'

これは、IDの最新の管理アイテムの特定の言語バリエーション(fr)を読み取ります : COREAB9F07B838004C17BD168DA317F3D2BE、channelToken:f60f162cd91243bab0aa0544668ab184。

レスポンス本文

{
        "id": "CORE706541CFA5974657AD0298077D70F375",
        "type": "Test116269655126007",
        "name": "test116276480961009_fr",
        "description": "test116276480961009_fr",
        "typeCategory": "ContentType",
        "slug": "1481786138118-test116276480961009_fr",
        "language": "fr",
        "translatable": true,
        "createdDate": {
          "value": "2020-07-07T05:28:35.324Z",
          "timezone": "UTC"
        },
        "updatedDate": {
          "value": "2020-07-07T05:28:35.324Z",
          "timezone": "UTC"
        },
        "fileExtension": "contentItem",
        "mimeType": "contentItem",
        "fileGroup": "contentItem",
        "fields": {
          "Test116269547310005": {
            "id": "COREFA1B111F785A4DBEA7E77E52AF42A44B",
            "type": "Test116219564978003",
            "name": "Test116326198122003",
            "typeCategory": "ContentType",
            "links": [
              {
                "href": "https://<hostname>/content/preview/api/v1.1/items/COREFA1B111F785A4DBEA7E77E52AF42A44B?channelToken=f60f162cd91243bab0aa0544668ab184",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              }
            ]
          }
        },
        "links": [
          {
            "href": "https://<hostname>/content/preview/api/v1.1/items/COREAB9F07B838004C17BD168DA317F3D2BE/variations/language/fr?channelToken=f60f162cd91243bab0aa0544668ab184",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/preview/api/v1.1/items/COREAB9F07B838004C17BD168DA317F3D2BE/variations/language/fr?channelToken=f60f162cd91243bab0aa0544668ab184",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/preview/api/v1.1/metadata-catalog/items/COREAB9F07B838004C17BD168DA317F3D2BE/variations/language/fr?channelToken=f60f162cd91243bab0aa0544668ab184",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          }
        ]
      }

例2:

curl -X GET -H 'Accept: application/json' 'https://host:port/content/preview/api/v1.1/items/COREAB9F07B838004C17BD168DA317F3D2BE/variations/language/fr?expand=fields.Test116269547310005&channelToken=f60f162cd91243bab0aa0544668ab184'

これは、IDの管理アイテムの特定の言語バリエーション(fr)を読み取ります : COREAB9F07B838004C17BD168DA317F3D2BE、channelToken:f60f162cd91243bab0aa0544668ab184(名前が展開されるフィールド) : Test116269547310005。

レスポンス本文

{
        "id": "CORE706541CFA5974657AD0298077D70F375",
        "type": "Test116269655126007",
        "name": "test116276480961009_fr",
        "description": "test116276480961009_fr",
        "typeCategory": "ContentType",
        "slug": "1481786138118-test116276480961009_fr",
        "language": "fr",
        "translatable": true,
        "createdDate": {
          "value": "2020-07-07T05:28:35.324Z",
          "timezone": "UTC"
        },
        "updatedDate": {
          "value": "2020-07-07T05:28:35.324Z",
          "timezone": "UTC"
        },
        "fileExtension": "contentItem",
        "mimeType": "contentItem",
        "fileGroup": "contentItem",
        "fields": {
          "Test116269547310005": {
            "id": "COREFA1B111F785A4DBEA7E77E52AF42A44B",
            "type": "Test116219564978003",
            "name": "Test116326198122003",
            "description": "Test116326198198004",
            "slug": "1481786138099-test116326198122003",
            "language": "fr",
            "translatable": false,
            "createdDate": {
              "value": "2020-07-07T05:28:35.324Z",
              "timezone": "UTC"
            },
            "updatedDate": {
              "value": "2020-07-07T05:28:35.324Z",
              "timezone": "UTC"
            },
            "mimeType": "contentItem",
            "fileGroup": "contentItem",
            "fields": {
              "Test116219132928001": "test"
            },
            "links": [
              {
                "href": "https://<hostname>/content/preview/api/v1.1/items/COREFA1B111F785A4DBEA7E77E52AF42A44B?channelToken=f60f162cd91243bab0aa0544668ab184",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              }
            ]
          }
        },
        "links": [
          {
            "href": "https://<hostname>/content/preview/api/v1.1/items/COREAB9F07B838004C17BD168DA317F3D2BE/variations/language/fr?channelToken=f60f162cd91243bab0aa0544668ab184&expand=fields.Test116269547310005",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/preview/api/v1.1/items/COREAB9F07B838004C17BD168DA317F3D2BE/variations/language/fr?channelToken=f60f162cd91243bab0aa0544668ab184&expand=fields.Test116269547310005",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/preview/api/v1.1/metadata-catalog/items/COREAB9F07B838004C17BD168DA317F3D2BE/variations/language/fr?channelToken=f60f162cd91243bab0aa0544668ab184",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          }
        ]
      }

例3:

curl -X GET -H 'Accept: application/json' 'https://host:port/content/preview/api/v1.1/items/CONT3E3AFF31343940768BEBE5461F97A8BC/variations/language/fr?channelToken=f573b68c764a44f9bae0627140d8b0bd'

これは、IDの最新の管理アイテムの特定の言語バリエーション(fr)を読み取ります : CONT3E3AFF31343940768BEBE5461F97A8BC、channelToken:f573b68c764a44f9bae0627140d8b0bd。

レスポンス本文

 {
        "id": "CONT3E3AFF31343940768BEBE5461F97A8BC",
        "type": "DigitalAsset",
        "name": "Test522387760830005.jpg",
        "description": "",
        "slug": "cdt-digital-asset",
        "language": "fr",
        "typeCategory": "DigitalAssetType",
        "createdDate": {
          "value": "2020-07-03T07:22:31.732Z",
          "timezone": "UTC"
        },
        "updatedDate": {
          "value": "2020-07-03T07:22:31.732Z",
          "timezone": "UTC"
        },
        "fileExtension": "jpg",
        "fields": {
          "metadata": {
            "width": "5",
            "height": "5"
          },
          "size": 631,
          "native": {
            "links": [
              {
                "href": "https://<hostname>/content/preview/api/v1.1/assets/CONT3E3AFF31343940768BEBE5461F97A8BC/native/Test522387760830005.jpg?channelToken=f573b68c764a44f9bae0627140d8b0bd",
                "rel": "self",
                "method": "GET",
                "mediaType": "image/jpeg"
              }
            ]
          },
          "renditions": [
            {
              "name": "Thumbnail",
              "formats": [
                {
                  "format": "jpg",
                  "size": 631,
                  "mimeType": "image/jpeg",
                  "metadata": {
                    "width": "5",
                    "height": "5"
                  },
                  "links": [
                    {
                      "href": "https://<hostname>/content/preview/api/v1.1/assets/CONT3E3AFF31343940768BEBE5461F97A8BC/Thumbnail/Test522387760830005.jpg?format=jpg&type=responsiveimage&channelToken=f573b68c764a44f9bae0627140d8b0bd",
                      "rel": "self",
                      "method": "GET",
                      "mediaType": "image/jpeg"
                    }
                  ]
                },
                {
                  "format": "webp",
                  "size": 0,
                  "mimeType": "image/webp",
                  "metadata": {
                    "width": "5",
                    "height": "5"
                  },
                  "links": [
                    {
                      "href": "https://<hostname>/content/preview/api/v1.1/assets/CONT3E3AFF31343940768BEBE5461F97A8BC/Thumbnail/Test522387760830005.jpg?format=webp&type=responsiveimage&channelToken=f573b68c764a44f9bae0627140d8b0bd",
                      "rel": "self",
                      "method": "GET",
                      "mediaType": "image/webp"
                    }
                  ]
                }
              ],
              "type": "responsiveimage"
            },
            {
              "name": "Medium",
              "formats": [
                {
                  "format": "jpg",
                  "size": 631,
                  "mimeType": "image/jpeg",
                  "metadata": {
                    "width": "5",
                    "height": "5"
                  },
                  "links": [
                    {
                      "href": "https://<hostname>/content/preview/api/v1.1/assets/CONT3E3AFF31343940768BEBE5461F97A8BC/Medium/Test522387760830005.jpg?format=jpg&type=responsiveimage&channelToken=f573b68c764a44f9bae0627140d8b0bd",
                      "rel": "self",
                      "method": "GET",
                      "mediaType": "image/jpeg"
                    }
                  ]
                },
                {
                  "format": "webp",
                  "size": 0,
                  "mimeType": "image/webp",
                  "metadata": {
                    "width": "5",
                    "height": "5"
                  },
                  "links": [
                    {
                      "href": "https://<hostname>/content/preview/api/v1.1/assets/CONT3E3AFF31343940768BEBE5461F97A8BC/Medium/Test522387760830005.jpg?format=webp&type=responsiveimage&channelToken=f573b68c764a44f9bae0627140d8b0bd",
                      "rel": "self",
                      "method": "GET",
                      "mediaType": "image/webp"
                    }
                  ]
                }
              ],
              "type": "responsiveimage"
            },
            {
              "name": "Large",
              "formats": [
                {
                  "format": "jpg",
                  "size": 631,
                  "mimeType": "image/jpeg",
                  "metadata": {
                    "width": "5",
                    "height": "5"
                  },
                  "links": [
                    {
                      "href": "https://<hostname>/content/preview/api/v1.1/assets/CONT3E3AFF31343940768BEBE5461F97A8BC/Large/Test522387760830005.jpg?format=jpg&type=responsiveimage&channelToken=f573b68c764a44f9bae0627140d8b0bd",
                      "rel": "self",
                      "method": "GET",
                      "mediaType": "image/jpeg"
                    }
                  ]
                },
                {
                  "format": "webp",
                  "size": 0,
                  "mimeType": "image/webp",
                  "metadata": {
                    "width": "5",
                    "height": "5"
                  },
                  "links": [
                    {
                      "href": "https://<hostname>/content/preview/api/v1.1/assets/CONT3E3AFF31343940768BEBE5461F97A8BC/Large/Test522387760830005.jpg?format=webp&type=responsiveimage&channelToken=f573b68c764a44f9bae0627140d8b0bd",
                      "rel": "self",
                      "method": "GET",
                      "mediaType": "image/webp"
                    }
                  ]
                }
              ],
              "type": "responsiveimage"
            },
            {
              "name": "Small",
              "formats": [
                {
                  "format": "jpg",
                  "size": 631,
                  "mimeType": "image/jpeg",
                  "metadata": {
                    "width": "5",
                    "height": "5"
                  },
                  "links": [
                    {
                      "href": "https://<hostname>/content/preview/api/v1.1/assets/CONT3E3AFF31343940768BEBE5461F97A8BC/Small/Test522387760830005.jpg?format=jpg&type=responsiveimage&channelToken=f573b68c764a44f9bae0627140d8b0bd",
                      "rel": "self",
                      "method": "GET",
                      "mediaType": "image/jpeg"
                    }
                  ]
                },
                {
                  "format": "webp",
                  "size": 0,
                  "mimeType": "image/webp",
                  "metadata": {
                    "width": "5",
                    "height": "5"
                  },
                  "links": [
                    {
                      "href": "https://<hostname>/content/preview/api/v1.1/assets/CONT3E3AFF31343940768BEBE5461F97A8BC/Small/Test522387760830005.jpg?format=webp&type=responsiveimage&channelToken=f573b68c764a44f9bae0627140d8b0bd",
                      "rel": "self",
                      "method": "GET",
                      "mediaType": "image/webp"
                    }
                  ]
                }
              ],
              "type": "responsiveimage"
            }
          ],
          "mimeType": "image/jpeg",
          "fileType": "jpeg"
        },
        "links": [
          {
            "href": "https://<hostname>/content/preview/api/v1.1/items/CONT3E3AFF31343940768BEBE5461F97A8BC/variations/language/fr?channelToken=f573b68c764a44f9bae0627140d8b0bd",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/preview/api/v1.1/items/CONT3E3AFF31343940768BEBE5461F97A8BC/variations/language/fr?channelToken=f573b68c764a44f9bae0627140d8b0bd",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/preview/api/v1.1/metadata-catalog/items/CONT3E3AFF31343940768BEBE5461F97A8BC/variations/language/fr?channelToken=f573b68c764a44f9bae0627140d8b0bd",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          }
        ]
      }
    }
トップに戻る