Jump to

• Request
• Response
• Examples

Update Master Item of an Item Variations Set

put

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

Updates master item of an item variations set.

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

Header Parameters

• X-Requested-With: string
  A custom header to mitigate CSRF attacks.

  Allowed Values: [ "XMLHttpRequest" ]

Body ()

Item variation set payload

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.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the variation item. It is a required property in the get response and put request."
        },
        "name":{
            "type":"string",
            "description":"name of the variation item."
        },
        "value":{
            "type":"string",
            "description":"Variation value."
        },
        "status":{
            "type":"string",
            "description":"Variation status."
        },
        "isPublished":{
            "type":"boolean",
            "description":"Whether the item is ever published."
        },
        "isMaster":{
            "type":"boolean",
            "description":"Is Master."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item Variation Id."
}

Nested Schema : links

Type: array

Links

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Links",
    "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."
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

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.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the variation item. It is a required property in the get response and put request."
        },
        "name":{
            "type":"string",
            "description":"name of the variation item."
        },
        "value":{
            "type":"string",
            "description":"Variation value."
        },
        "status":{
            "type":"string",
            "description":"Variation status."
        },
        "isPublished":{
            "type":"boolean",
            "description":"Whether the item is ever published."
        },
        "isMaster":{
            "type":"boolean",
            "description":"Is Master."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item Variation Id."
}

Nested Schema : links

Type: array

Links

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Links",
    "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.

403 Response

Forbidden.

404 Response

Not found.

500 Response

Internal server error.

Back to Top

Examples

The following example shows how to set item variation as master by submitting a PUT request on the REST resource using cURL.

curl -X PUT -H 'Content-Type: application/json' -H 'X-Requested-With: XMLHttpRequest' 'https://host:port/content/management/api/v1.1/items/{id}/variations/{variationType}/master'

Example 1:

This updates master item of a item variations set to CORE262BC4A3B89B4E39A15E9B26E66C2793.

/content/management/api/v1.1/items/CORED55D9C45AFBD4897A38DF8F53CF3B7C8/variations/language/master

Request Payload

{
    "id": "CORE262BC4A3B89B4E39A15E9B26E66C2793"
}

Example 2:

This updates master item of a item variations set to CONT262BC4A3B89B4E39A15E9B26E66C2793.

content/management/api/v1.1/items/CONTD55D9C45AFBD4897A38DF8F53CF3B7C8/variations/language/master

Request Payload

{
        "id": "CONT262BC4A3B89B4E39A15E9B26E66C2793"
}

Back to Top