Read Item Variations by Variation Type
get
/content/management/api/v1.1/items/{id}/variations/{variationType}/master
Read item variations of a variation type for given item id.
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 : ItemVariationId
Type:
object
Item Variation Id.
Show Source
-
id(optional):
string
id of the variation item. It is a required property in the get response and put request.
-
isMaster(optional):
boolean
Is Master.
-
isPublished(optional):
boolean
Whether the item is ever published.
-
links(optional):
array links
Links
-
name(optional):
string
name of the variation item.
-
status(optional):
string
Variation status.
-
value(optional):
string
Variation 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 master variation for a variation type 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}/master'
Example:
This reads master item variations of a variation type of item id: CORE6D2AA74D80D44135BB8553695B13A93C.
/content/management/api/v1.1/items/CORE6D2AA74D80D44135BB8553695B13A93C/variations/master
Response Body
{ "id": "CORE03686186463D44D286FE9A7004AA36C6", "value": "en-US", "isMaster": true, "links": [ { "href": "https://host:port/content/management/api/v1.1/items/CORE6D2AA74D80D44135BB8553695B13A93C/variations/language/master", "rel": "self", "method": "GET", "mediaType": "application/json" }, { "href": "https://host:port/content/management/api/v1.1/items/CORE6D2AA74D80D44135BB8553695B13A93C/variations/language/master", "rel": "canonical", "method": "GET", "mediaType": "application/json" }, { "href": "https://host:port/content/management/api/v1.1/metadata-catalog/items/CORE6D2AA74D80D44135BB8553695B13A93C/variations/language/master", "rel": "describedby", "method": "GET", "mediaType": "application/schema+json" }, { "href": "https://host:port/content/management/api/v1.1/items/CORE03686186463D44D286FE9A7004AA36C6", "rel": "alternate", "method": "GET", "mediaType": "application/json" } ] }