機械翻訳について

移動

• リクエスト
• レスポンス
• 例

アイテム・バリエーションをプレビュー

get

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

すべてのアイテム・バリエーションのプレビュー。

リクエスト

パス・パラメータ

• id: string
  アイテムの一意の識別子(ID)。

問合せパラメータ

• channelToken(optional): string
  ターゲット・チャネルのチャネル・トークン。 チャネル・トークンは、問合せパラメータまたはリクエスト・ヘッダーのいずれかとして提供する必要があります。
• links(optional): string
  クライアントが結果に必要とするrel (リレーション)リンクのコンマ区切りのリストを受け入れます。 デフォルトでは、リソース内のすべての適用可能なリンクがレスポンスに含まれます。 可能な値は次のとおりです: self, canonical, describedby。
  例: links=self,canonicalは、relプロパティselfまたはcanonicalを持つリンクのみを返します。

トップに戻る

レスポンス

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

• application/json

200レスポンス

操作の成功

本文()

ルート・スキーマ : ItemSubResourceListVariationsInfo

型: object

バリエーション

Show Source

• data(optional): array data
• links(optional): array links

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/VariationsInfo"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Variations"
}

ネストされたスキーマ : data

型: array

Show Source

• Array of: object VariationsInfo
  バリエーション情報。

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/VariationsInfo"
    }
}

ネストされたスキーマ: links

型: array

Show Source

• Array of: object Link
  リソースのリンク。

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

ネストされたスキーマ : VariationsInfo

型: object

バリエーション情報。

Show Source

• items(optional): array items
  コンテンツ・アイテムのバリエーション。
• links(optional): array links
• masterItem(optional): string
  マスター・アイテム。
• setId(optional): string
  変動セットId。
• varType(optional): string
  バリエーション・タイプ名です。

{
    "type":"object",
    "properties":{
        "setId":{
            "type":"string",
            "description":"Variation set id."
        },
        "varType":{
            "type":"string",
            "description":"Variation type name."
        },
        "masterItem":{
            "type":"string",
            "description":"Master item."
        },
        "items":{
            "type":"array",
            "description":"Content item variations.",
            "items":{
                "$ref":"#/definitions/Language"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Variations Info."
}

ネストされたスキーマ: items

型: array

コンテンツ・アイテムのバリエーション。

Show Source

• Array of: object Language
  LanguageItem

{
    "type":"array",
    "description":"Content item variations.",
    "items":{
        "$ref":"#/definitions/Language"
    }
}

ネストされたスキーマ: links

型: array

Show Source

• Array of: object Link
  リソースのリンク。

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

ネストされたスキーマ : 言語

型: object

LanguageItem

Show Source

• id(optional): string
  アイテムのId。
• links(optional): array links
• value(optional): string
  言語値

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the item."
        },
        "value":{
            "type":"string",
            "description":"Language value"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"LanguageItem"
}

ネストされたスキーマ: links

型: array

Show Source

• Array of: object Link
  リソースのリンク。

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

ネストされたスキーマ : リンク

型: object

リソースのリンク。

Show Source

• href(optional): string
  ターゲット・リソースURI。 それはテンプレートURIである可能性があります。 これはレスポンス取得の必須プロパティです。
• mediaType(optional): string
  メディア・タイプ。
• method(optional): string
  ターゲット・リソースへのアクセスに使用できるHTTPメソッド。
• profile(optional): string
  ターゲット・リソースを記述するメタデータにリンクします。
• rel(optional): string
  関係タイプ。 これはレスポンス取得の必須プロパティです。
• templated(optional): boolean
  URIがテンプレートであるかどうか。

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"The target resource's URI. It could be template URI. It is a required property in the get response."
        },
        "rel":{
            "type":"string",
            "description":"Relation type. It is a required property in the get response."
        },
        "templated":{
            "type":"boolean",
            "description":"Whether the URI is a template."
        },
        "method":{
            "type":"string",
            "description":"What HTTP method can be used to access the target resource."
        },
        "profile":{
            "type":"string",
            "description":"Link to the metadata that describes the target resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type."
        }
    },
    "description":"Link of the resource."
}

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/CORE96C8FDF1883C44AB908FC56FF618D225/variations?channelToken=37727fdc857c4d479513325888b69df0'

これはIDのアイテムのバリエーションのプレビューを読み取ります: CORE96C8FDF1883C44AB908FC56FF618D225、channelToken: 37727fdc857c4d479513325888b69df0。

レスポンス本文

 {
        "data": [
          {
            "varType": "language",
            "masterItem": "CORE96C8FDF1883C44AB908FC56FF618D225",
            "items": [
              {
                "id": "CORE2824D7CF303F4C80BD765983B2BFDB33",
                "value": "es"
              },
              {
                "id": "CORE96C8FDF1883C44AB908FC56FF618D225",
                "value": "en-US"
              }
            ]
          }
        ],
        "links": [
          {
            "href": "https://<hostname>/content/preview/api/v1.1/items/CORE96C8FDF1883C44AB908FC56FF618D225/variations?channelToken=37727fdc857c4d479513325888b69df0",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          }
        ]
      }

例2:

curl -X GET -H 'Accept: application/json' 'https://host:port/content/preview/api/v1.1/items/CONTE626E01775F9477999908D3B1DD1BBDD/variations?channelToken=37727fdc857c4d479513325888b69df0'

これはIDのアイテムのバリエーションのプレビューを読み取ります: CONTE626E01775F9477999908D3B1DD1BBDD、channelToken: 37727fdc857c4d479513325888b69df0。

レスポンス本文

 {
        "data": [
          {
            "varType": "language",
            "masterItem": "CONTE626E01775F9477999908D3B1DD1BBDD",
            "items": [
              {
                "id": "CONT7EB51110AF9A480DA200ABAD183B3B2B",
                "value": "es"
              },
              {
                "id": "CONTE626E01775F9477999908D3B1DD1BBDD",
                "value": "en-US"
              }
            ]
          }
        ],
        "links": [
          {
            "href": "https://<hostname>/content/preview/api/v1.1/items/CONTE626E01775F9477999908D3B1DD1BBDD/variations?channelToken=37727fdc857c4d479513325888b69df0",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          }
        ]
      }
    }

トップに戻る