Jump to

• Request
• Response
• Examples

List Variations of an Item

get

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

Lists all variations of a given item.

Request

Path Parameters

• id: string
  id of the item.

Query Parameters

• links(optional): string
  This parameter accepts a comma-separated list of link names. By default, this parameter gives all the links applicable. Possible values are: self, canonical, describedby

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : ItemSubResourceListVariationsInfo

Type: object

Item SubResource.

Show Source

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

Nested Schema : data

Type: array

Show Source

• Array of: object VariationsInfo
  Variations Info.

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : VariationsInfo

Type: object

Variations Info.

Show Source

• items(optional): array items
  Content item variations.
• links(optional): array links
• masterItem(optional): string
  Master item.
• setId(optional): string
  Variation set id.
• varType(optional): string
  Variation type name.

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

Nested Schema : items

Type: array

Content item variations.

Show Source

• Array of: object Language
  LanguageItem

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : Language

Type: object

LanguageItem

Show Source

• id(optional): string
  id of the item.
• isPublished(optional): boolean
  Whether the item is ever published.
• links(optional): array links
• name(optional): string
  name of the item.
• status(optional): string
  status of item
• value(optional): string
  Language value

{
    "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"
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : Link

Type: object

Link of the resource.

Show Source

• href(optional): string
  The target resource's URI. It could be template URI. It is a required property in the get response.
• mediaType(optional): string
  Media type.
• method(optional): string
  What HTTP method can be used to access the target resource.
• profile(optional): string
  Link to the metadata that describes the target resource.
• rel(optional): string
  Relation type. It is a required property in the get response.
• templated(optional): boolean
  Whether the URI is a template.

{
    "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 Response

Not modified.

400 Response

Bad request.

403 Response

Forbidden.

404 Response

Not found.

500 Response

Internal server error.

Back to Top

Examples

The following example shows how to get item using an ID by submission of a GET request using cURL.

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

Example:

This lists variations of item id: CORECD67178407B04607A20A92CEBD637695.

/content/management/api/v1.1/items/CORECD67178407B04607A20A92CEBD637695/variations

Response Body

{
    "data": [
    {
      "varType": "language",
      "masterItem": "CORE03686186463D44D286FE9A7004AA36C6",
      "items": [
        {
      "id": "CORE03686186463D44D286FE9A7004AA36C6",
      "value": "en-US"
      },
        {
      "id": "CORECD67178407B04607A20A92CEBD637695",
      "value": "en-AU"
      },
        {
      "id": "CORE6D2AA74D80D44135BB8553695B13A93C",
      "value": "en-US"
      }
      ]
    }
    ],
    "links": [
    {
      "href": "https://host:port/content/management/api/v1.1/items/CORECD67178407B04607A20A92CEBD637695/variations",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    }
    ]
    }

Back to Top