Jump to

• Request
• Response
• Examples

Preview an item by slug

get

/content/preview/api/v1.1/items/.by.slug/{slug}

Previews the latest management version of the item by slug value that is ready for publishing or published. An item is uniquely identified by slug.
Each preview item has the following information:

1. Standard fields: These are fields created by the system.
   
   • id: ID of the item.
   • type: Type of the item.
   • name: Name of the item.
   • typeCategory: Category of the type.
   • description: Description of the item.
   • slug : A URL part that identifies the item in human-readable format.
   • language : Language of the Item.
   • createdDate: Created date of the item on the channel requested.
   • updatedDate: Updated date of the item on the channel requested.
2. User-defined fields: These are fields created by the user when the type is defined. All user fields are available under the fields node.

Request Headers :


Is required	Header Name	Header Value
Required	channelToken	{valid channel token value}
Optional	Accept	application/json

Request

Path Parameters

• slug: string
  Slug value of the item to be previewed.

Query Parameters

• channelToken(optional): string
  Channel token of the targeted channel. 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 non-existing 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. Possible values are: self, canonical, describedby.
  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

Successful operation.

Body ()

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
• fileExtension(optional): string
  Extension of the file.
• fileGroup(optional): string
• id(optional): string
  ID of the item.
• itemVariations(optional): array itemVariations
• language(optional): string
• links(optional): array links
  Links of the resource.
• mimeType(optional): string
• name(optional): string
  Name of the item.
• renditions(optional): object RenditionsBean
• slug(optional): string
• taxonomies(optional): object TaxonomiesBean
• translatable(optional): boolean
• type(optional): string
  Type of the item.
• typeCategory(optional): string
  Read Only: true
• 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."
        },
        "typeCategory":{
            "type":"string",
            "readOnly":true
        },
        "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"
        },
        "fileExtension":{
            "type":"string",
            "description":"Extension of the file."
        },
        "fields":{
            "type":"object",
            "description":"User-defined fields data. Map<String,Object>",
            "additionalProperties":{
                "type":"object"
            }
        },
        "itemVariations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ItemVariation"
            }
        },
        "taxonomies":{
            "$ref":"#/definitions/TaxonomiesBean"
        },
        "renditions":{
            "$ref":"#/definitions/RenditionsBean"
        },
        "mimeType":{
            "type":"string"
        },
        "fileGroup":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "description":"Links of the resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "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 : RenditionsBean

Type: object

Show Source

• items(optional): array items
  Item renditions.
• links(optional): array links

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"Item renditions.",
            "items":{
                "$ref":"#/definitions/RenditionBean"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : TaxonomiesBean

Type: object

Show Source

• items(optional): array items
  Item taxonomies.
• links(optional): array links
  Resource links.

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"Item taxonomies.",
            "items":{
                "$ref":"#/definitions/TaxonomyItem"
            }
        },
        "links":{
            "type":"array",
            "description":"Resource links.",
            "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
• isPublished(optional): boolean
• lastModified(optional): string(date-time)
• links(optional): array links
• name(optional): string
• setId(optional): string
• slug(optional): string
• sourceId(optional): string
• sourceVersion(optional): integer(int32)
• status(optional): string
• type(optional): string
• value(optional): string
• varType(optional): string

{
    "type":"object",
    "properties":{
        "sourceVersion":{
            "type":"integer",
            "format":"int32"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "sourceId":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "varType":{
            "type":"string"
        },
        "slug":{
            "type":"string"
        },
        "isPublished":{
            "type":"boolean"
        },
        "setId":{
            "type":"string"
        },
        "isMaster":{
            "type":"boolean"
        },
        "type":{
            "type":"string"
        },
        "lastModified":{
            "type":"string",
            "format":"date-time"
        },
        "id":{
            "type":"string"
        },
        "name":{
            "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."
}

Nested Schema : items

Type: array

Item renditions.

Show Source

• Array of: object RenditionBean

{
    "type":"array",
    "description":"Item renditions.",
    "items":{
        "$ref":"#/definitions/RenditionBean"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : RenditionBean

Type: object

Show Source

• apiName(optional): string
• formats(optional): array formats
• type(optional): string

{
    "type":"object",
    "properties":{
        "apiName":{
            "type":"string"
        },
        "formats":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/RenditionFormatBean"
            }
        },
        "type":{
            "type":"string"
        }
    }
}

Nested Schema : formats

Type: array

Show Source

• Array of: object RenditionFormatBean

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

Nested Schema : RenditionFormatBean

Type: object

Show Source

• format(optional): string
• links(optional): array links

{
    "type":"object",
    "properties":{
        "format":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : items

Type: array

Item taxonomies.

Show Source

• Array of: object TaxonomyItem
  TaxonomyItem

{
    "type":"array",
    "description":"Item taxonomies.",
    "items":{
        "$ref":"#/definitions/TaxonomyItem"
    }
}

Nested Schema : links

Type: array

Resource links.

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Resource links.",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : TaxonomyItem

Type: object

TaxonomyItem

Show Source

• categories(optional): object TaxonomyCategories
  CategoriesBean
• id(optional): string
  The id of the taxonomy.
• links(optional): array links
• name(optional): string
  The name of the taxonomy
• shortName(optional): string
  The short name of the taxonomy

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the taxonomy."
        },
        "name":{
            "type":"string",
            "description":"The name of the taxonomy"
        },
        "shortName":{
            "type":"string",
            "description":"The short name of the taxonomy"
        },
        "categories":{
            "description":"The categories of the taxonomy",
            "$ref":"#/definitions/TaxonomyCategories"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"TaxonomyItem"
}

Nested Schema : TaxonomyCategories

Type: object

CategoriesBean

Show Source

• items(optional): array items
  Taxonomy Categories

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"Taxonomy Categories",
            "items":{
                "$ref":"#/definitions/CategoryItem"
            }
        }
    },
    "description":"CategoriesBean"
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : items

Type: array

Taxonomy Categories

Show Source

• Array of: object CategoryItem
  CategoryItem

{
    "type":"array",
    "description":"Taxonomy Categories",
    "items":{
        "$ref":"#/definitions/CategoryItem"
    }
}

Nested Schema : CategoryItem

Type: object

CategoryItem

Show Source

• apiName(optional): string
  The apiName of the category
• id(optional): string
  The id of the category.
• links(optional): array links
• name(optional): string
  The name of the category
• nodes(optional): array nodes
  The nodes of the category assigned to the item.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the category."
        },
        "name":{
            "type":"string",
            "description":"The name of the category"
        },
        "apiName":{
            "type":"string",
            "description":"The apiName of the category"
        },
        "nodes":{
            "type":"array",
            "description":"The nodes of the category assigned to the item.",
            "items":{
                "$ref":"#/definitions/CategoryNodeItem"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"CategoryItem"
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : nodes

Type: array

The nodes of the category assigned to the item.

Show Source

• Array of: object CategoryNodeItem
  CategoryNodeBean

{
    "type":"array",
    "description":"The nodes of the category assigned to the item.",
    "items":{
        "$ref":"#/definitions/CategoryNodeItem"
    }
}

Nested Schema : CategoryNodeItem

Type: object

CategoryNodeBean

Show Source

• apiName(optional): string
  The apiName of the Category node.
• id(optional): string
  The id of the Category node.
• name(optional): string
  The name of the Category node.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the Category node."
        },
        "name":{
            "type":"string",
            "description":"The name of the Category node."
        },
        "apiName":{
            "type":"string",
            "description":"The apiName of the Category node."
        }
    },
    "description":"CategoryNodeBean"
}

304 Response

Not changed. The request honors requests with e-tag.

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

The requested resource was not found.

500 Response

Internal server error. An unexpected error condition encountered in the system.

Back to Top

Examples

Example 1:

The following example shows how to preview latest management item by submission of a GET request on the REST resource using cURL:

curl -X GET -H 'Accept: application/json' 'https://host:port/content/preview/api/v1.1/items/.by.slug/3000000000012-c1?channelToken=37727fdc857c4d479513325888b69df0'

This reads preview of item with slug: 3000000000012-c1, channelToken: 37727fdc857c4d479513325888b69df0.

Response Body

{
        "id": "CORE96C8FDF1883C44AB908FC56FF618D225",
        "type": "custitem",
        "typeCategory": "ContentType",
        "name": "c1",
        "description": "",
        "slug": "3000000000012-c1",
        "language": "en-US",
        "translatable": true,
        "createdDate": {
          "value": "2021-09-16T04:06:07.066Z",
          "timezone": "UTC"
        },
        "updatedDate": {
          "value": "2021-09-16T04:45:11.903Z",
          "timezone": "UTC"
        },
        "fileExtension": "contentItem",
        "fields": {
          "profession": "cricket",
          "title": "batter"
        },
        "mimeType": "contentItem",
        "fileGroup": "contentItem",
        "links": [
          {
            "href": "https://<hostname>/content/preview/api/v1.1/items/.by.slug/3000000000012-c1?channelToken=37727fdc857c4d479513325888b69df0",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/preview/api/v1.1/items/.by.slug/3000000000012-c1?channelToken=37727fdc857c4d479513325888b69df0",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/preview/api/v1.1/metadata-catalog/items/.by.slug/3000000000012-c1?channelToken=37727fdc857c4d479513325888b69df0",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          }
        ]
      }

Example 2:

curl -X GET -H 'Accept: application/json' 'https://host:port/content/preview/api/v1.1/items/.by.slug/cdt-digital-asset?channelToken=f573b68c764a44f9bae0627140d8b0bd'

This reads preview of item with slug: cdt-digital-asset, channelToken: f573b68c764a44f9bae0627140d8b0bd.

Response Body

{
        "id": "CONT3E3AFF31343940768BEBE5461F97A8BC",
        "type": "DigitalAsset",
        "name": "Test522387760830005.jpg",
        "description": "",
        "slug": "cdt-digital-asset",
        "language": "en-US",
        "typeCategory": "DigitalAssetType",
        "createdDate": {
          "value": "2020-07-03T07:22:31.732Z",
          "timezone": "UTC"
        },
        "updatedDate": {
          "value": "2020-07-03T07:22:31.732Z",
          "timezone": "UTC"
        },
        "fileExtension": "jpg",
        "fields": {
          "metadata": {
            "width": "5",
            "height": "5"
          },
          "size": 631,
          "native": {
            "links": [
              {
                "href": "https://<hostname>/content/preview/assets/cdt-digital-asset/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/preview/assets/cdt-digital-asset/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/preview/assets/cdt-digital-asset/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/preview/assets/cdt-digital-asset/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/preview/assets/cdt-digital-asset/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/preview/assets/cdt-digital-asset/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/preview/assets/cdt-digital-asset/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/preview/assets/cdt-digital-asset/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/preview/assets/cdt-digital-asset/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/preview/api/v1.1/items/.by.slug/cdt-digital-assetchannelToken=f573b68c764a44f9bae0627140d8b0bd",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/preview/api/v1.1/items/.by.slug/cdt-digital-asset?channelToken=f573b68c764a44f9bae0627140d8b0bd",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/preview/api/v1.1/metadata-catalog/items/.by.slug/cdt-digital-asset?channelToken=f573b68c764a44f9bae0627140d8b0bd",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          }
        ]
      }
    }

Back to Top