List All Item Variations of a Variation Type
get
/content/management/api/v1.1/items/{id}/variations/{variationType}
Lists all item variations of a variation type.
Request
Path Parameters
-
id: string
id of the item.
-
variationType: string
Type of the variation. Possible value: language
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
Response
Supported Media Types
- application/json
200 Response
OK.
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.
Nested Schema : items
Type:
array
Content item variations.
Show Source
-
Array of:
object Language
LanguageItem
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
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.
304 Response
Not modified.
400 Response
Bad request.
403 Response
Forbidden.
404 Response
Not found.
500 Response
Internal server error.
Examples
The following example shows how to get the variation type using an item 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/{variationType}'
Example 1:
This lists all item variations of a variation type of item id: CORECD67178407B04607A20A92CEBD637695.
/content/management/api/v1.1/items/CORECD67178407B04607A20A92CEBD637695/variations/language
Response Body
{ "setId": "7C1BF504216E64A8E0534DB0F70AE2AB", "masterItem": "CORE03686186463D44D286FE9A7004AA36C6", "items": [ { "id": "CORE03686186463D44D286FE9A7004AA36C6", "value": "en-US", "status":"draft", "isPublished": true, "links": [ { "href": "https://<hostname>/content/management/api/v1.1/items/CORE03686186463D44D286FE9A7004AA36C6", "rel": "self", "method": "GET", "mediaType": "application/json" } ] }, { "id": "CORECD67178407B04607A20A92CEBD637695", "value": "fr-FR", "status":"draft", "isPublished": true, "links": [ { "href": "https://<hostname>/content/management/api/v1.1/items/CORECD67178407B04607A20A92CEBD637695", "rel": "self", "method": "GET", "mediaType": "application/json" } ] }, { "id": "CORE6D2AA74D80D44135BB8553695B13A93C", "value": "ar", "status":"draft", "isPublished": true, "links": [ { "href": "https://<hostname>/content/management/api/v1.1/items/CORE6D2AA74D80D44135BB8553695B13A93C", "rel": "self", "method": "GET", "mediaType": "application/json" } ] } ], "links": [ { "href": "https://<hostname>/content/management/api/v1.1/items/CORE03686186463D44D286FE9A7004AA36C6/variations/language", "rel": "self", "method": "GET", "mediaType": "application/json" }, { "href": "https://<hostname>/content/management/api/v1.1/items/CORE03686186463D44D286FE9A7004AA36C6/variations/language", "rel": "canonical", "method": "GET", "mediaType": "application/json" }, { "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/items/CORE03686186463D44D286FE9A7004AA36C6/variations/language", "rel": "describedby", "method": "GET", "mediaType": "application/schema+json" } ] }
Example 2:
This lists all item variations of a variation type of item id: CONTCD67178407B04607A20A92CEBD637695.
/content/management/api/v1.1/items/CONTCD67178407B04607A20A92CEBD637695/variations/language
Response Body
{ "setId": "7C1BF504216E64A8E0534DB0F70AE2AB", "masterItem": "CONT03686186463D44D286FE9A7004AA36C6", "items": [ { "id": "CONT03686186463D44D286FE9A7004AA36C6", "value": "en-US", "status":"draft", "isPublished": true, "links": [ { "href": "https://<hostname>/content/management/api/v1.1/items/CONT03686186463D44D286FE9A7004AA36C6", "rel": "self", "method": "GET", "mediaType": "application/json" } ] }, { "id": "CONTCD67178407B04607A20A92CEBD637695", "value": "fr-FR", "status":"draft", "isPublished": true, "links": [ { "href": "https://<hostname>/content/management/api/v1.1/items/CONTCD67178407B04607A20A92CEBD637695", "rel": "self", "method": "GET", "mediaType": "application/json" } ] }, { "id": "CONT6D2AA74D80D44135BB8553695B13A93C", "value": "ar", "status":"draft", "isPublished": true, "links": [ { "href": "https://<hostname>/content/management/api/v1.1/items/CONT6D2AA74D80D44135BB8553695B13A93C", "rel": "self", "method": "GET", "mediaType": "application/json" } ] } ], "links": [ { "href": "https://<hostname>/content/management/api/v1.1/items/CONT03686186463D44D286FE9A7004AA36C6/variations/language", "rel": "self", "method": "GET", "mediaType": "application/json" }, { "href": "https://<hostname>/content/management/api/v1.1/items/CONT03686186463D44D286FE9A7004AA36C6/variations/language", "rel": "canonical", "method": "GET", "mediaType": "application/json" }, { "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/items/CONT03686186463D44D286FE9A7004AA36C6/variations/language", "rel": "describedby", "method": "GET", "mediaType": "application/schema+json" } ] } }