REST API for Content Preview

Preview item variations by variation type

get

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

Preview of all item variations filtered by variation type.

Request

Path Parameters

id: string

Unique identifier (ID) of an item.
variationType: string

Type of the variation. Possible value: language

Query Parameters

channelToken(optional): string

Channel token of the targeted channel. A channel token must be provided as either a query parameter or a request header.
links(optional): string

Accepts a comma-separated list of rel (relation) links, which the client requires in the results. By default, all the applicable links in a resource are included in the response. Possible values are: self, canonical, describedby.
Example: links=self,canonical will only return the links with the rel property self or canonical.

Response

Supported Media Types

application/json

200 Response

Successful operation.

Root 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.
links(optional): array links
value(optional): string

Language value

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

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

400 Response

Bad Request. The server is unable to process the request on the client side due to malformed syntax, invalid data or message framing.

403 Response

Forbidden. Client is not authorized to perform this request.

404 Response

The requested resource was not found.

500 Response

Internal server error. An unexpected error condition encountered in the system.

Examples

Example 1:

The following example shows how to preview variations of type language of item with id by submission of a GET request on the REST resource using cURL:

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

This reads preview of variations of type language for item with id: CORE96C8FDF1883C44AB908FC56FF618D225, channelToken: 37727fdc857c4d479513325888b69df0.

Response Body

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

Example 2:

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

This reads preview of variations of type language for item with id: CONTE626E01775F9477999908D3B1DD1BBDD, channelToken: 37727fdc857c4d479513325888b69df0.

Response Body

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