REST API for Content Delivery

All REST Endpoints

AutoSuggestions

The operations from the AutoSuggestions category.

Suggest item keywords for auto-completion of default search: Method: get
Path: /content/published/api/v1.1/items/suggest

Item

The operations from the Item category.

Get html renditions of a published item.: Method: get
Path: /content/published/api/v1.1/items/{id}/renditions
Get Metadata Catalog of Preview of an Item: Method: get
Path: /content/published/api/v1.1/metadata-catalog/items/{id}/preview
Get Metadata Catalog of Taxonomies of Item: Method: get
Path: /content/published/api/v1.1/metadata-catalog/items/{id}/taxonomies
Get Preview of an Item: Method: get
Path: /content/published/api/v1.1/items/{id}/preview
Get Published Item: Method: get
Path: /content/published/api/v1.1/items/{id}
Get Taxonomies of Item: Method: get
Path: /content/published/api/v1.1/items/{id}/taxonomies
Get the html rendition of item: Method: get
Path: /content/published/api/v1.1/assets/{id}/renditions/{rendition}

Item Variations

The operations from the Item Variations category.

Get Item for Item Variation: Method: get
Path: /content/published/api/v1.1/items/{id}/variations/{varType}/{varValue}
Get Item Variations: Method: get
Path: /content/published/api/v1.1/items/{id}/variations
Get Item Variations by Variation Type: Method: get
Path: /content/published/api/v1.1/items/{id}/variations/{varType}

Items

The resources used to search across the published items.

Get Metadata Catalog of Published Items: Method: get
Path: /content/published/api/v1.1/metadata-catalog/items
Search Published Items: Method: get
Path: /content/published/api/v1.1/items

Items by slug

The resources to manage items by slug.

Get Metadata Catalog of Preview of an Item: Method: get
Path: /content/published/api/v1.1/metadata-catalog/items/.by.slug/{slug}/preview
Get Metadata Catalog of Taxonomies of Item: Method: get
Path: /content/published/api/v1.1/metadata-catalog/items/.by.slug/{slug}/taxonomies
Get Metadata of an Item Using SLUG: Method: get
Path: /content/published/api/v1.1/metadata-catalog/items/.by.slug/{slug}
Get Metadata of variations of Item: Method: get
Path: /content/published/api/v1.1/metadata-catalog/items/.by.slug/{slug}/variations
Get Metadata of variations of Item for specified type: Method: get
Path: /content/published/api/v1.1/metadata-catalog/items/.by.slug/{slug}/variations/{varType}
Get Metadata of variations of Item for specified value: Method: get
Path: /content/published/api/v1.1/metadata-catalog/items/.by.slug/{slug}/variations/{varType}/{varValue}
Get Preview of an Item by slug: Method: get
Path: /content/published/api/v1.1/items/.by.slug/{slug}/preview
Get Published Item by slug: Method: get
Path: /content/published/api/v1.1/items/.by.slug/{slug}
Get published item by slug for specified Item Variation: Method: get
Path: /content/published/api/v1.1/items/.by.slug/{slug}/variations/{varType}/{varValue}
Get variations of a published Item by its slug: Method: get
Path: /content/published/api/v1.1/items/.by.slug/{slug}/variations
Get variations of a published Item by its slug filtered by Variation Type: Method: get
Path: /content/published/api/v1.1/items/.by.slug/{slug}/variations/{varType}
List all Taxonomies and Categories of a published Item by slug: Method: get
Path: /content/published/api/v1.1/items/.by.slug/{slug}/taxonomies
Lists all renditions of a published item by slug: Method: get
Path: /content/published/api/v1.1/items/.by.slug/{slug}/renditions

Provider Tokens

The resources to generate provider tokens for published assets

Generate a provider token: Method: post
Path: /content/published/api/v1.1/items/{id}/providerTokens

Published Item

The operations from the Published Item category.

Get Metadata of an Item Using ID: Method: get
Path: /content/published/api/v1.1/metadata-catalog/items/{id}

Recommendations

The resources used to access published recommendation results.

Obtain the results from the recommendation by apiName.: Method: get
Path: /content/published/api/v1.1/personalization/recommendationResults/{apiName}
Obtain the results from the recommendation by id.: Method: get
Path: /content/published/api/v1.1/personalization/recommendationResults/.by.id/{id}

Renditions

The resources used to access the published digital asset renditions and native files.

Get Digital Assets Native File with FileName Metadata Catalog: Method: get
Path: /content/published/api/v1.1/metadata-catalog/assets/{id}/native/{filename}
Get Metadata of Native Digital Asset: Method: get
Path: /content/published/api/v1.1/metadata-catalog/assets/{id}/native
Get Metadata Using Rendition Type: Method: get
Path: /content/published/api/v1.1/metadata-catalog/assets/{id}/{rendition}
Get Metadata Using Rendition Type and Filename: Method: get
Path: /content/published/api/v1.1/metadata-catalog/assets/{id}/{rendition}/{filename}
Get Published Digital Assets Native File: Method: get
Path: /content/published/api/v1.1/assets/{id}/native
Get Published Native Resource Using Filename: Method: get
Path: /content/published/api/v1.1/assets/{id}/native/{filename}
Get Published Rendition: Method: get
Path: /content/published/api/v1.1/assets/{id}/{rendition}
Get Published Rendition Using Filename: Method: get
Path: /content/published/api/v1.1/assets/{id}/{rendition}/{filename}

Renditions by slug

The resources used to access the published digital asset renditions and native files by slug.

Get Published Digital Assets Native File by Slug: Method: get
Path: /content/assets/{slug}/native
Get Published Digital Assets Native File by Slug: Method: get
Path: /content/published/api/v1.1/assets/.by.slug/{slug}/native
Get Published Native Resource by Slug Using Filename: Method: get
Path: /content/assets/{slug}/native/{filename}
Get Published Native Resource by Slug Using Filename: Method: get
Path: /content/published/api/v1.1/assets/.by.slug/{slug}/native/{filename}
Get Published Rendition by Slug: Method: get
Path: /content/assets/{slug}/{rendition}
Get Published Rendition by Slug: Method: get
Path: /content/published/api/v1.1/assets/.by.slug/{slug}/{rendition}
Get Published Rendition by Slug Using Filename: Method: get
Path: /content/assets/{slug}/{rendition}/{filename}
Get Published Rendition by Slug Using Filename: Method: get
Path: /content/published/api/v1.1/assets/.by.slug/{slug}/{rendition}/{filename}

Taxonomies

The resources used to access published taxonomies and their respective categories.

Get Metadata of a Category Using ID: Method: get
Path: /content/published/api/v1.1/metadata-catalog/taxonomies/{id}/categories/{categoryId}
Get Metadata of a Published Taxonomy Using ID: Method: get
Path: /content/published/api/v1.1/metadata-catalog/taxonomies/{id}
Get Metadata of Published Categories: Method: get
Path: /content/published/api/v1.1/metadata-catalog/taxonomies/{id}/categories
Get Metadata of Published Taxonomies: Method: get
Path: /content/published/api/v1.1/metadata-catalog/taxonomies
List Taxonomies: Method: get
Path: /content/published/api/v1.1/taxonomies
Read a Published Category: Method: get
Path: /content/published/api/v1.1/taxonomies/{id}/categories/{categoryId}
Read a Published Taxonomy: Method: get
Path: /content/published/api/v1.1/taxonomies/{id}
Search Published Categories: Method: get
Path: /content/published/api/v1.1/taxonomies/{id}/categories

Version Catalog

Version resources in the delivery API.

Get Available Versions of an API: Method: get
Path: /content/published/api
Get Metadata of an API: Method: get
Path: /content/published/api/metadata-catalog
Get Metadata of v1.1 API: Method: get
Path: /content/published/api/v1.1/metadata-catalog
Get v1.1 API Information: Method: get
Path: /content/published/api/v1.1