機械翻訳について

移動先

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

スラグ別のアイテムのバリエーションのリスト

get

/content/management/api/v1.1/items/.by.slug/{slug}/variations

スラグ別に特定のアイテムのバリエーションをすべてリストします。

リクエスト

パス・パラメータ

• slug: string
  最新の管理アイテムのスラグ値。 slug内の特殊文字はすべてエンコードする必要があります。

問合せパラメータ

• links(optional): string
  このパラメータは、リンク名のカンマ区切りのリストを受け入れます。 デフォルトでは、このパラメータによって、適用可能なすべてのリンクが指定されます。 可能な値は次のとおりです: self, canonical, describedby

トップに戻る

レスポンス

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

• application/json

200レスポンス

OK。

本文()

ルート・スキーマ : ItemSubResourceListVariationsInfo

型: object

アイテムSubResource。

ソースを表示

• data(optional): array data
• links(optional): array links
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/VariationsInfo"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

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

型: array

ソースを表示

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

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

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

型: array

ソースを表示

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

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

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

型: object

バリエーション情報。

ソースを表示

• 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

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

ソースを表示

• Array of: object Language
  LanguageItem

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

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

型: array

ソースを表示

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

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

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

型: object

LanguageItem

ソースを表示

• id(optional): string
  アイテムのId。
• isPublished(optional): boolean
  アイテムが公開されたかどうか。
• links(optional): array links
• name(optional): string
  アイテムの名前。
• status(optional): string
  アイテムのステータス
• value(optional): string
  言語値

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the item."
        },
        "name":{
            "type":"string",
            "description":"name of the item."
        },
        "value":{
            "type":"string",
            "description":"Language value"
        },
        "status":{
            "type":"string",
            "description":"status of item"
        },
        "isPublished":{
            "type":"boolean",
            "description":"Whether the item is ever published."
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"LanguageItem"
}

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

型: array

ソースを表示

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

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

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

型: object

リソースのリンク。

ソースを表示

• 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."
}

304 レスポンス

変更されていません。

400レスポンス

不正リクエスト

403レスポンス

禁止。

404レスポンス

見つかりません。

500レスポンス

内部サーバー・エラー

トップに戻る

例

次の例は、アイテムの差異をそのスラグ値別にリストする方法を示しています。

curl -X GET -H 'Accept: application/json' 'https://host:port/content/management/api/v1.1/items/.by.slug/{slug}/variations'

例1:

これは、項目の変動をslug:'.by.slug/content-item-1-type-1'とともにリストします。

/content/management/api/v1.1/items/.by.slug/content-item-1-type-1/variations

レスポンス本文

{
        "data": [
          {
            "varType": "language",
            "masterItem": "CORE03686186463D44D286FE9A7004AA36C6",
            "items": [
              {
                "id": "CORE03686186463D44D286FE9A7004AA36C6",
                "value": "en-US",
                "status": "draft",
                "isPublished": true
              },
              {
                "id": "CORECD67178407B04607A20A92CEBD637695",
                "value": "fr-FR",
                "status": "draft",
                "isPublished": true
              },
              {
                "id": "CORE6D2AA74D80D44135BB8553695B13A93C",
                "value": "ar",
                "status": "draft",
                "isPublished": true
              }
            ]
          }
        ],
        "links": [
          {
            "href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/content-item-1-type-1/variations",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          }
        ]
      }

例2:

次は、slug:'.by.slug/digital-asset-1-cdt-1'のアイテムのバリエーションを示しています。

/content/management/api/v1.1/items/.by.slug/digital-asset-1-cdt-1/variations

レスポンス本文

{
        "data": [
          {
            "varType": "language",
            "masterItem": "CONT03686186463D44D286FE9A7004AA36C6",
            "items": [
              {
                "id": "CONT03686186463D44D286FE9A7004AA36C6",
                "value": "en-US",
                "status": "draft",
                "isPublished": true
              },
              {
                "id": "CONTCD67178407B04607A20A92CEBD637695",
                "value": "fr-FR",
                "status": "draft",
                "isPublished": true
              },
              {
                "id": "CONT6D2AA74D80D44135BB8553695B13A93C",
                "value": "ar",
                "status": "draft",
                "isPublished": true
              }
            ]
          }
        ],
        "links": [
          {
            "href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/digital-asset-1-cdt-1/variations",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          }
        ]
      }
    }

先頭に戻る