Jump to

• Request
• Response

Get Content Item for Item Variation

get

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

Gets the Content Item of the Item Variation specified by Variation Type and Variation Value

Request

Path Parameters

• id: string
  Unique identifier (ID) of an item.
• variationType: string
  Variation Type
• variationValue: string
  Variation Value

Query Parameters

• channelToken(optional): string
  Channel token of the publish target. A channel token must be provided as either a query parameter or a request header.
• expand(optional): string
  Expand parameter provides the option of getting child resources (referenced items) inline with the item's response. Accepts a comma-separated list of field names or all. All the user-defined field names should be provided with prefix fields and followed by a period (.). If these fields are of a reference type, then the resource expands their data inline in the response. Field names are case-sensitive. When expand is specified as all (in lowercase), all the fields of the reference type of the requested item are expanded. When expand is not specified, the item response contains links to the referenced items.
  Expansion of this form is supported for one level only, a request to expand beyond the first level of referenced fields will produce response HTTP 400. When the expand contains a nonexisting field as per the type definition of the requested item, the resource produces HTTP 400.
  Examples:
  

  expand=fields.field1,fields.field2

  expand=all

  where field1, field2 are names of the user-defined fields in the type to which this item belongs.
• 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.
  Example: links=self,canonical will only return the links with the rel property self or canonical.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Item.

Root Schema : Item

Type: object

Item.

Show Source

• createdDate(optional): object createdDate
  Created date of the item. Map having value, timezone, and description
• description(optional): string
  Description of the item.
• fields(optional): object fields
  Additional Properties Allowed: additionalProperties

  User-defined fields data. Map
• id(optional): string
  ID of the item.
• itemVariations(optional): array itemVariations
• language(optional): string
• links(optional): array links
  Links of the resource.
• name(optional): string
  Name of the item.
• slug(optional): string
• translatable(optional): boolean
• type(optional): string
  Type of the item.
• updatedDate(optional): object updatedDate
  Last updated date of the item. Map having value, timezone, and description

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID of the item."
        },
        "type":{
            "type":"string",
            "description":"Type of the item."
        },
        "name":{
            "type":"string",
            "description":"Name of the item."
        },
        "description":{
            "type":"string",
            "description":"Description of the item."
        },
        "slug":{
            "type":"string"
        },
        "language":{
            "type":"string"
        },
        "translatable":{
            "type":"boolean"
        },
        "createdDate":{
            "type":"object",
            "description":"Created date of the item. Map<String,String> having value, timezone, and description"
        },
        "updatedDate":{
            "type":"object",
            "description":"Last updated date of the item. Map<String,String> having value, timezone, and description"
        },
        "fields":{
            "type":"object",
            "description":"User-defined fields data. Map<String,Object>",
            "additionalProperties":{
                "type":"object"
            }
        },
        "links":{
            "type":"array",
            "description":"Links of the resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "itemVariations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ItemVariation"
            }
        }
    },
    "description":"Item."
}

Nested Schema : createdDate

Type: object

Created date of the item. Map having value, timezone, and description

Nested Schema : fields

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "description":"User-defined fields data. Map<String,Object>",
    "additionalProperties":{
        "type":"object"
    }
}

User-defined fields data. Map

Nested Schema : itemVariations

Type: array

Show Source

• Array of: object ItemVariation

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

Nested Schema : links

Type: array

Links of the resource.

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Links of the resource.",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : updatedDate

Type: object

Last updated date of the item. Map having value, timezone, and description

Nested Schema : additionalProperties

Type: object

Nested Schema : ItemVariation

Type: object

Show Source

• id(optional): string
• isMaster(optional): boolean
• lastModified(optional): string(date-time)
• links(optional): array links
• setId(optional): string
• sourceId(optional): string
• sourceVersion(optional): integer(int32)
• type(optional): string
• value(optional): string
• varType(optional): string

{
    "type":"object",
    "properties":{
        "sourceVersion":{
            "type":"integer",
            "format":"int32"
        },
        "type":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "sourceId":{
            "type":"string"
        },
        "varType":{
            "type":"string"
        },
        "setId":{
            "type":"string"
        },
        "isMaster":{
            "type":"boolean"
        },
        "lastModified":{
            "type":"string",
            "format":"date-time"
        },
        "id":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

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.

404 Response

Not found.

500 Response

Internal server error.

Back to Top