Get published item by slug for specified Item Variation

get

/content/published/api/v1.1/items/.by.slug/{slug}/variations/{varType}/{varValue}

Gets the published Item by slug for the Item Variation specified by Variation Type and Variation Value.

Request

Path Parameters
Query Parameters
  • Channel token of the publish target. A channel token must be provided as either a query parameter or a request header.
  • 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.
Back to Top

Response

Supported Media Types

200 Response

Successful operation.
Body ()
Root Schema : Item
Type: object
Item.
Show Source
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
User-defined fields data. Map
Nested Schema : itemVariations
Type: array
Show Source
Nested Schema : RenditionsBean
Type: object
Show Source
Nested Schema : TaxonomiesBean
Type: object
Show Source
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
Nested Schema : items
Type: array
Item renditions.
Show Source
Nested Schema : RenditionBean
Type: object
Show Source
Nested Schema : formats
Type: array
Show Source
Nested Schema : RenditionFormatBean
Type: object
Show Source
Nested Schema : items
Type: array
Item taxonomies.
Show Source
Nested Schema : TaxonomyItem
Type: object
TaxonomyItem
Show Source
Nested Schema : TaxonomyCategories
Type: object
CategoriesBean
Show Source
Nested Schema : items
Type: array
Taxonomy Categories
Show Source
Nested Schema : CategoryItem
Type: object
CategoryItem
Show Source
Nested Schema : nodes
Type: array
The nodes of the category assigned to the item.
Show Source
Nested Schema : CategoryNodeItem
Type: object
CategoryNodeBean
Show Source

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

Not found.

500 Response

Internal server error. An unexpected error condition encountered in the system.
Back to Top

Examples

The following example shows how to read particular language variation of type published item with slug.

curl -i -X GET -H "Accept:application/json" 'http://<hostname>/content/published/api/v1.1/items/.by.slug/{slug}/variations/{varType}/{varValue}'
Example 1

This reads particular language variation (fr) of published item with slug: 1481786138108-test116276480961009_en-us, channelToken: f60f162cd91243bab0aa0544668ab184.

/content/published/api/v1.1/items/.by.slug/1481786138108-test116276480961009_en-us/variations/language/fr?channelToken=f60f162cd91243bab0aa0544668ab184

Response Body

{
        "id": "CORE706541CFA5974657AD0298077D70F375",
        "type": "Test116269655126007",
        "name": "test116276480961009_fr",
        "description": "test116276480961009_fr",
        "typeCategory": "ContentType",
        "slug": "1481786138118-test116276480961009_fr",
        "language": "fr",
        "translatable": true,
        "createdDate": {
          "value": "2020-07-07T05:28:35.324Z",
          "timezone": "UTC"
        },
        "updatedDate": {
          "value": "2020-07-07T05:28:35.324Z",
          "timezone": "UTC"
        },
        "fileExtension": "contentItem",
        "mimeType": "contentItem",
        "fileGroup": "contentItem",
        "fields": {
          "Test116269547310005": {
            "id": "COREFA1B111F785A4DBEA7E77E52AF42A44B",
            "type": "Test116219564978003",
            "name": "Test116326198122003",
            "typeCategory": "ContentType",
            "links": [
              {
                "href": "https://<hostname>/content/published/api/v1.1/items/.by.slug/1481786138099-test116326198122003?channelToken=f60f162cd91243bab0aa0544668ab184",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              }
            ]
          }
        },
        "links": [
          {
            "href": "https://<hostname>/content/published/api/v1.1/items/.by.slug/1481786138108-test116276480961009_en-us/variations/language/fr?channelToken=f60f162cd91243bab0aa0544668ab184",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/published/api/v1.1/items/.by.slug/1481786138108-test116276480961009_en-us/variations/language/fr?channelToken=f60f162cd91243bab0aa0544668ab184",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/published/api/v1.1/metadata-catalog/items/.by.slug/1481786138108-test116276480961009_en-us/variations/language/fr?channelToken=f60f162cd91243bab0aa0544668ab184",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          }
}
Example 2

This reads particular language variation (fr) of published item with slug: 1481786138108-test116276480961009_en-us, channelToken:f60f162cd91243bab0aa0544668ab184 with expanding field having name: Test116269547310005.

/content/published/api/v1.1/items/.by.slug/1481786138108-test116276480961009_en-us/variations/language/fr?expand=fields.Test116269547310005&channelToken=f60f162cd91243bab0aa0544668ab184

Response Body

{
        "id": "CORE706541CFA5974657AD0298077D70F375",
        "type": "Test116269655126007",
        "name": "test116276480961009_fr",
        "description": "test116276480961009_fr",
        "typeCategory": "ContentType",
        "slug": "1481786138118-test116276480961009_fr",
        "language": "fr",
        "translatable": true,
        "createdDate": {
          "value": "2020-07-07T05:28:35.324Z",
          "timezone": "UTC"
        },
        "updatedDate": {
          "value": "2020-07-07T05:28:35.324Z",
          "timezone": "UTC"
        },
        "fileExtension": "contentItem",
        "mimeType": "contentItem",
        "fileGroup": "contentItem",
        "fields": {
          "Test116269547310005": {
            "id": "COREFA1B111F785A4DBEA7E77E52AF42A44B",
            "type": "Test116219564978003",
            "name": "Test116326198122003",
            "description": "Test116326198198004",
            "typeCategory": "ContentType",
            "slug": "1481786138099-test116326198122003",
            "language": "fr",
            "translatable": false,
            "createdDate": {
              "value": "2020-07-07T05:28:35.324Z",
              "timezone": "UTC"
            },
            "updatedDate": {
              "value": "2020-07-07T05:28:35.324Z",
              "timezone": "UTC"
            },
            "fileExtension": "contentItem",
            "mimeType": "contentItem",
            "fileGroup": "contentItem",
            "fields": {
              "Test116219132928001": "test"
            },
            "links": [
              {
                "href": "https://<hostname>/content/published/api/v1.1/items/.by.slug/1481786138099-test116326198122003?channelToken=f60f162cd91243bab0aa0544668ab184",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              }
            ]
          }
        },
        "links": [
          {
            "href": "https://<hostname>/content/published/api/v1.1/items/.by.slug/1481786138108-test116276480961009_en-us/variations/language/fr?channelToken=f60f162cd91243bab0aa0544668ab184&expand=fields.Test116269547310005",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/published/api/v1.1/items/.by.slug/1481786138108-test116276480961009_en-us/variations/language/fr?channelToken=f60f162cd91243bab0aa0544668ab184&expand=fields.Test116269547310005",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/published/api/v1.1/metadata-catalog/items/.by.slug/1481786138108-test116276480961009_en-us/variations/language/fr?channelToken=f60f162cd91243bab0aa0544668ab184",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          }
        ]
      }
Example 3

This reads particular language variation (fr) of published digital item with slug: 1481786138108-test116276480961009_en-us, channelToken:f60f162cd91243bab0aa0544668ab184.

/content/published/api/v1.1/items/.by.slug/1481786138108-test116276480961009_en-us/variations/language/fr?channelToken=f60f162cd91243bab0aa0544668ab184

Response Body

{
        "id": "CONT706541CFA5974657AD0298077D70F375",
        "type": "Test116269655126007",
        "name": "Test522387760830005.jpg",
        "description": "Test522387760830005 description",
        "typeCategory": "DigitalAssetType",
        "slug": "1481786138118-test116276480961009_fr",
        "language": "fr",
        "translatable": true,
        "createdDate": {
          "value": "2020-07-07T05:28:35.324Z",
          "timezone": "UTC"
        },
        "updatedDate": {
          "value": "2020-07-07T05:28:35.324Z",
          "timezone": "UTC"
        },
        "fileExtension": "jpg",
        "mimeType": "contentItem",
        "fileGroup": "contentItem",
        ields": {
          "metadata": {
            "width": "5",
            "height": "5"
          },
          "size": 631,
          "native": {
            "links": [
              {
                "href": "https://<hostname>/content/published/api/v1.1/assets/.by.slug/1481786138108-test116276480961009_en-us/native/Test522387760830005.jpg?channelToken=f573b68c764a44f9bae0627140d8b0bd",
                "rel": "self",
                "method": "GET",
                "mediaType": "image/jpeg"
              }
            ]
          },
          "renditions": [
            {
              "name": "Thumbnail",
              "formats": [
                {
                  "format": "jpg",
                  "size": 631,
                  "mimeType": "image/jpeg",
                  "metadata": {
                    "width": "5",
                    "height": "5"
                  },
                  "links": [
                    {
                      "href": "https://<hostname>/content/published/api/v1.1/assets/.by.slug/1481786138108-test116276480961009_en-us/Thumbnail/Test522387760830005.jpg?format=jpg&type=responsiveimage&channelToken=f573b68c764a44f9bae0627140d8b0bd",
                      "rel": "self",
                      "method": "GET",
                      "mediaType": "image/jpeg"
                    }
                  ]
                },
                {
                  "format": "webp",
                  "size": 0,
                  "mimeType": "image/webp",
                  "metadata": {
                    "width": "5",
                    "height": "5"
                  },
                  "links": [
                    {
                      "href": "https://<hostname>/content/published/api/v1.1/assets/.by.slug/1481786138108-test116276480961009_en-us/Thumbnail/Test522387760830005.jpg?format=webp&type=responsiveimage&channelToken=f573b68c764a44f9bae0627140d8b0bd",
                      "rel": "self",
                      "method": "GET",
                      "mediaType": "image/webp"
                    }
                  ]
                }
              ],
              "type": "responsiveimage"
            },
            {
              "name": "Medium",
              "formats": [
                {
                  "format": "jpg",
                  "size": 631,
                  "mimeType": "image/jpeg",
                  "metadata": {
                    "width": "5",
                    "height": "5"
                  },
                  "links": [
                    {
                      "href": "https://<hostname>/content/published/api/v1.1/assets/.by.slug/1481786138108-test116276480961009_en-us/Medium/Test522387760830005.jpg?format=jpg&type=responsiveimage&channelToken=f573b68c764a44f9bae0627140d8b0bd",
                      "rel": "self",
                      "method": "GET",
                      "mediaType": "image/jpeg"
                    }
                  ]
                },
                {
                  "format": "webp",
                  "size": 0,
                  "mimeType": "image/webp",
                  "metadata": {
                    "width": "5",
                    "height": "5"
                  },
                  "links": [
                    {
                      "href": "https://<hostname>/content/published/api/v1.1/assets/.by.slug/1481786138108-test116276480961009_en-us/Medium/Test522387760830005.jpg?format=webp&type=responsiveimage&channelToken=f573b68c764a44f9bae0627140d8b0bd",
                      "rel": "self",
                      "method": "GET",
                      "mediaType": "image/webp"
                    }
                  ]
                }
              ],
              "type": "responsiveimage"
            },
            {
              "name": "Large",
              "formats": [
                {
                  "format": "jpg",
                  "size": 631,
                  "mimeType": "image/jpeg",
                  "metadata": {
                    "width": "5",
                    "height": "5"
                  },
                  "links": [
                    {
                      "href": "https://<hostname>/content/published/api/v1.1/assets/.by.slug/1481786138108-test116276480961009_en-us/Large/Test522387760830005.jpg?format=jpg&type=responsiveimage&channelToken=f573b68c764a44f9bae0627140d8b0bd",
                      "rel": "self",
                      "method": "GET",
                      "mediaType": "image/jpeg"
                    }
                  ]
                },
                {
                  "format": "webp",
                  "size": 0,
                  "mimeType": "image/webp",
                  "metadata": {
                    "width": "5",
                    "height": "5"
                  },
                  "links": [
                    {
                      "href": "https://<hostname>/content/published/api/v1.1/assets/.by.slug/1481786138108-test116276480961009_en-us/Large/Test522387760830005.jpg?format=webp&type=responsiveimage&channelToken=f573b68c764a44f9bae0627140d8b0bd",
                      "rel": "self",
                      "method": "GET",
                      "mediaType": "image/webp"
                    }
                  ]
                }
              ],
              "type": "responsiveimage"
            },
            {
              "name": "Small",
              "formats": [
                {
                  "format": "jpg",
                  "size": 631,
                  "mimeType": "image/jpeg",
                  "metadata": {
                    "width": "5",
                    "height": "5"
                  },
                  "links": [
                    {
                      "href": "https://<hostname>/content/published/api/v1.1/assets/.by.slug/1481786138108-test116276480961009_en-us/Small/Test522387760830005.jpg?format=jpg&type=responsiveimage&channelToken=f573b68c764a44f9bae0627140d8b0bd",
                      "rel": "self",
                      "method": "GET",
                      "mediaType": "image/jpeg"
                    }
                  ]
                },
                {
                  "format": "webp",
                  "size": 0,
                  "mimeType": "image/webp",
                  "metadata": {
                    "width": "5",
                    "height": "5"
                  },
                  "links": [
                    {
                      "href": "https://<hostname>/content/published/api/v1.1/assets/.by.slug/1481786138108-test116276480961009_en-us/Small/Test522387760830005.jpg?format=webp&type=responsiveimage&channelToken=f573b68c764a44f9bae0627140d8b0bd",
                      "rel": "self",
                      "method": "GET",
                      "mediaType": "image/webp"
                    }
                  ]
                }
              ],
              "type": "responsiveimage"
            }
          ],
          "mimeType": "image/jpeg",
          "fileType": "jpeg"
        },
        "links": [
          {
            "href": "https://<hostname>/content/published/api/v1.1/items/.by.slug/1481786138108-test116276480961009_en-us/variations/language/fr?channelToken=f60f162cd91243bab0aa0544668ab184",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/published/api/v1.1/items/.by.slug/1481786138108-test116276480961009_en-us/variations/language/fr?channelToken=f60f162cd91243bab0aa0544668ab184",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/published/api/v1.1/metadata-catalog/items/.by.slug/1481786138108-test116276480961009_en-us/variations/language/fr?channelToken=f60f162cd91243bab0aa0544668ab184",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          }
        ]
      }
    }
  ]
Back to Top