Expand all

Integrating with the API

Before integrating with the Dynamic Content service API, please read the integration guide. It describes the request and response formats, HTTP status codes and provides useful strategies for integrating with the API.

Overview

Root

"Root" is the root endpoint of the service

Getting root

Auth rules

Snippet auth-rules not found for operation::get-root

Example request

Snippet http-request not found for operation::get-root

Example response

Snippet http-response not found for operation::get-root

Getting root returns a basic list of links to start operating with the Dynamic Content API.

Information

A small set of endpoints exists solely to provide information about the Dynamic Content Service itself.

Supported Localization Settings

Provides the master list of all currently supported ISO 639-1 language codes and ISO 3166 country codes.

Auth rules

Snippet auth-rules not found for operation::list-localization-codes

Example request

Snippet http-request not found for operation::list-localization-codes

Example response

Snippet http-response not found for operation::list-localization-codes

Hubs

Hubs are containers for multiple repositories including media, content, content types.

Creating a new Hub

Auth rules

Snippet auth-rules not found for operation::document-hub-create

Example request

Snippet http-request not found for operation::document-hub-create

Example response

Snippet http-response not found for operation::document-hub-create

Listing Hubs

Auth rules

Snippet auth-rules not found for operation::listing-hubs

Example request

Snippet http-request not found for operation::listing-hubs

Example response

Snippet http-response not found for operation::listing-hubs

Get Hub

Auth rules

Snippet auth-rules not found for operation::get-hub

Example request

Snippet http-request not found for operation::get-hub

Example response

Snippet http-response not found for operation::get-hub

Updating a Hub

Auth rules

Snippet auth-rules not found for operation::update-hub-description

Example request

Snippet http-request not found for operation::update-hub-description

Example response

Snippet http-response not found for operation::update-hub-description

Updating settings

To update an Hub’s settings, you need to execute a PATCH to the Hub’s 'update-settings' HAL link.

Example: Update all of the devices settings:

Auth rules

Snippet auth-rules not found for operation::hub-update-settings-devices-using-patch

Example request

Snippet http-request not found for operation::hub-update-settings-devices-using-patch

Example response

Snippet http-response not found for operation::hub-update-settings-devices-using-patch

Example: Update the Virtual Staging Environment settings:

Auth rules

Snippet auth-rules not found for operation::hub-update-settings-vse-using-patch

Example request

Snippet http-request not found for operation::hub-update-settings-vse-using-patch

Example response

Snippet http-response not found for operation::hub-update-settings-vse-using-patch

Sharing a Hub

Auth rules

Snippet auth-rules not found for operation::share-hub

Example request

Snippet http-request not found for operation::share-hub

Example response

Snippet http-response not found for operation::share-hub

Localization

See Localization for info on how to setup your Hub for Content Item level localization.

Content Types

Register a Content Type with a Hub

Auth rules

Snippet auth-rules not found for operation::document-register-content-type-with-hub

Example request

Snippet http-request not found for operation::document-register-content-type-with-hub

Example response

Snippet http-response not found for operation::document-register-content-type-with-hub

Assign a Content Type to a Repository

Auth rules

Snippet auth-rules not found for operation::assign-content-type-to-repository

Example request

Snippet http-request not found for operation::assign-content-type-to-repository

Example response

Snippet http-response not found for operation::assign-content-type-to-repository

Unassign a Content Type from a Repository

Auth rules

Snippet auth-rules not found for operation::unassign-content-type-from-repository

Example request

Snippet http-request not found for operation::unassign-content-type-from-repository

Example response

Snippet http-response not found for operation::unassign-content-type-from-repository

Listing Content Types

Auth rules

Snippet auth-rules not found for operation::list-content-types

Example request

Snippet http-request not found for operation::list-content-types

Example response

Snippet http-response not found for operation::list-content-types

Get a Content Type

Auth rules

Snippet auth-rules not found for operation::get-content-type

Example request

Snippet http-request not found for operation::get-content-type

Example response

Snippet http-response not found for operation::get-content-type

Update a Content Type

Auth rules

Snippet auth-rules not found for operation::update-content-type

Example request

Snippet http-request not found for operation::update-content-type

Example response

Snippet http-response not found for operation::update-content-type

Get a Content Type Schema

Auth rules

Snippet auth-rules not found for operation::get-content-type-schema

Example request

Snippet http-request not found for operation::get-content-type-schema

Example response

Snippet http-response not found for operation::get-content-type-schema

Update a Content Type Schema

Auth rules

Snippet auth-rules not found for operation::update-content-type-schema

Example request

Snippet http-request not found for operation::update-content-type-schema

Example response

Snippet http-response not found for operation::update-content-type-schema

Content Repositories

A service that registers content types which are referenced in the content type repository for use with the Amplience Content Management System.

Creating a new Content Repository

Auth rules

Snippet auth-rules not found for operation::content-repository-create

Example request

Snippet http-request not found for operation::content-repository-create

Example response

Snippet http-response not found for operation::content-repository-create

Listing Content Repositories

Auth rules

Snippet auth-rules not found for operation::content-repository-list

Example request

Snippet http-request not found for operation::content-repository-list

Example response

Snippet http-response not found for operation::content-repository-list

Get Content Repository

Auth rules

Snippet auth-rules not found for operation::content-repository-get

Example request

Snippet http-request not found for operation::content-repository-get

Example response

Snippet http-response not found for operation::content-repository-get

Update Content Repository

Auth rules

Snippet auth-rules not found for operation::content-repository-update

Example request

Snippet http-request not found for operation::content-repository-update

Example response

Snippet http-response not found for operation::content-repository-update

Add feature flag to repository

Auth rules

Snippet auth-rules not found for operation::add-repository-feature

Example request

Snippet http-request not found for operation::add-repository-feature

Example response

Snippet http-response not found for operation::add-repository-feature

Remove feature flag from repository

Auth rules

Snippet auth-rules not found for operation::remove-repository-feature

Example request

Snippet http-request not found for operation::remove-repository-feature

Example response

Snippet http-response not found for operation::remove-repository-feature

Find repositories with feature flags

Auth rules

Snippet auth-rules not found for operation::search-repositories

Example request

Snippet http-request not found for operation::search-repositories

Example response

Snippet http-response not found for operation::search-repositories

Share Content Repository

Auth rules

Snippet auth-rules not found for operation::share-repository-with-another-user

Example request

Snippet http-request not found for operation::share-repository-with-another-user

Example response

Snippet http-response not found for operation::share-repository-with-another-user

Localization

See Localization for info on how to setup your Content Repository for Content Item level localization.

Content Items

Content Items are instances of content created from a content type.

Creating a new Content Item

Auth rules

Snippet auth-rules not found for operation::content-item-create

Example request

Snippet http-request not found for operation::content-item-create

Example response

Snippet http-response not found for operation::content-item-create

Get Content Item by Id

Auth rules

Snippet auth-rules not found for operation::content-item-get

Example request

Snippet http-request not found for operation::content-item-get

Example response

Snippet http-response not found for operation::content-item-get

Update Content Item

Auth rules

Snippet auth-rules not found for operation::content-item-update

Example request

Snippet http-request not found for operation::content-item-update

Example response

Snippet http-response not found for operation::content-item-update

Copy Content Item

Auth rules

Snippet auth-rules not found for operation::content-item-copy

Example request

Snippet http-request not found for operation::content-item-copy

Example response

Snippet http-response not found for operation::content-item-copy

If you want to specify the folder to copy the content item into use the following request format:

Auth rules: Source

Snippet auth-rules-source not found for operation::content-item-copy-folder

Auth rules: Destination

Snippet auth-rules-destination not found for operation::content-item-copy-folder

Example request

Snippet http-request not found for operation::content-item-copy-folder

Example response

Snippet http-response not found for operation::content-item-copy-folder

Archive Content Item

Auth rules

Snippet auth-rules not found for operation::content-item-archive

Example request

Snippet http-request not found for operation::content-item-archive

Example response

Snippet http-response not found for operation::content-item-archive

Unarchive Content Item

Auth rules

Snippet auth-rules not found for operation::content-item-unarchive

Example request

Snippet http-request not found for operation::content-item-unarchive

Example response

Snippet http-response not found for operation::content-item-unarchive

Update multiple Content Items

The following endpoint enables users to update up to 100 content items in a single request.

Auth rules

Snippet auth-rules not found for operation::multi-content-item-update

Example request

Snippet http-request not found for operation::multi-content-item-update

Example response

Snippet http-response not found for operation::multi-content-item-update

Listing Content Items

Auth rules

Snippet auth-rules not found for operation::content-item-list

Example request

Snippet http-request not found for operation::content-item-list

Example response

Snippet http-response not found for operation::content-item-list

Listing Content Items excluding body

In order to exclude the body from the response, specify ?projection=basic in the request path.

Auth rules

Snippet auth-rules not found for operation::content-items-list-basic-projection

Example request

Snippet http-request not found for operation::content-items-list-basic-projection

Example response

Snippet http-response not found for operation::content-items-list-basic-projection

Listing Content Items with sorting

Auth rules

Snippet auth-rules not found for operation::content-item-list-with-sorting

Example request

Snippet http-request not found for operation::content-item-list-with-sorting

Example response

Snippet http-response not found for operation::content-item-list-with-sorting

Sort options are:

Table 1. Content Item sorting
Field Sort

label

sort=label,asc

sort=label,desc

content type

sort=body._meta.schema,asc

sort=body._meta.schema,desc

created date

sort=createdDate,asc

sort=createdDate,desc

last modified date

sort=lastModifiedDate,asc

sort=lastModifiedDate,desc

Listing Content Items filtered by folder ID

Auth rules

Snippet auth-rules not found for operation::content-item-list-by-folder-id

Example request

Snippet http-request not found for operation::content-item-list-by-folder-id

Example response

Snippet http-response not found for operation::content-item-list-by-folder-id

Multiple folder IDs can be specified either by providing a comma separated list or multiple folderId query parameters. The following requests are equivalent:

Auth rules

Snippet auth-rules not found for operation::content-item-list-by-multiple-folder-id

Example request

Snippet http-request not found for operation::content-item-list-by-multiple-folder-id

Example response

Snippet http-response not found for operation::content-item-list-by-multiple-folder-id

Auth rules

Snippet auth-rules not found for operation::content-item-list-by-multiple-folder-id-long-notation

Example request

Snippet http-request not found for operation::content-item-list-by-multiple-folder-id-long-notation

Example response

Snippet http-response not found for operation::content-item-list-by-multiple-folder-id-long-notation

Folder IDs can be made exclusive by prefixing with ! to request all content items not contained in the specified folder:

Auth rules

Snippet auth-rules not found for operation::content-item-list-by-negated-folder-id

Example request

Snippet http-request not found for operation::content-item-list-by-negated-folder-id

Example response

Snippet http-response not found for operation::content-item-list-by-negated-folder-id

It is possible to specify multiple exclusive folder IDs, however it is best not to combine exclusive folder IDs with inclusive folder IDs when filtering. This is because the exclusive folder IDs will take precedence over the inclusive folder IDs. Consider filtering by:

?folderId=folder1,folder2,!folder3,!folder4

This query requests that only content items from folder1 and folder2 are included, and then requests all content items except those contained in folder3 and folder4. The content items from folder1 and folder2 are implicitly included as a result of excluding the content items from folder3 and folder4. Therefore the exclusive folder IDs have taken precedence, and an equivalent but more concise filter request would be:

?!folder3,!folder4

Listing Content Item History

Auth rules

Snippet auth-rules not found for operation::content-item-history-list

Example request

Snippet http-request not found for operation::content-item-history-list

Example response

Snippet http-response not found for operation::content-item-history-list

Listing Content Item History for a Version

Auth rules

Snippet auth-rules not found for operation::content-item-version-history-list

Example request

Snippet http-request not found for operation::content-item-version-history-list

Example response

Snippet http-response not found for operation::content-item-version-history-list

Listing Content Item Versions

Auth rules

Snippet auth-rules not found for operation::content-item-versions-list

Example request

Snippet http-request not found for operation::content-item-versions-list

Example response

Snippet http-response not found for operation::content-item-versions-list

Getting Linked Content Items

Auth rules

Snippet auth-rules not found for operation::get-linked-content

Example request

Snippet http-request not found for operation::get-linked-content

Example response

Snippet http-response not found for operation::get-linked-content

Finding Content by epoch

Find content items that are candidates for being published at a point in time.

Auth rules

Snippet auth-rules not found for operation::content-item-timeline-epoch

Example request

Snippet http-request not found for operation::content-item-timeline-epoch

Example response

Snippet http-response not found for operation::content-item-timeline-epoch

Finding Content by ISO 8601 time

Auth rules

Snippet auth-rules not found for operation::content-item-timeline-time

Example request

Snippet http-request not found for operation::content-item-timeline-time

Example response

Snippet http-response not found for operation::content-item-timeline-time

Finding Content by Content Version Number

Auth rules

Snippet auth-rules not found for operation::get-content-item-by-version

Example request

Snippet http-request not found for operation::get-content-item-by-version

Example response

Snippet http-response not found for operation::get-content-item-by-version

Restore Content by Content Version Number

Auth rules

Snippet auth-rules not found for operation::restore-content-item-version

Example request

Snippet http-request not found for operation::restore-content-item-version

Example response

Snippet http-response not found for operation::restore-content-item-version

Search Content Items by Text

Text is the default search field. See Text Search Query Syntax for a summary of the query syntax.

Auth rules

Snippet auth-rules not found for operation::search_text_is_default_field

Example request

Snippet http-request not found for operation::search_text_is_default_field

Example response

Snippet http-response not found for operation::search_text_is_default_field

Faceting Content Items with Search by Text

Facet content items and search by text. See Text Search Query Syntax for a summary of the query syntax.

Auth rules

Snippet auth-rules not found for operation::facet_content_item

Example request

Snippet http-request not found for operation::facet_content_item

Example response

Snippet http-response not found for operation::facet_content_item

Text Search Query Syntax

A simple query syntax is provided to allow full text search on content items. Several characters have special meaning and are reserved:

Table 2. Reserved Search Characters
Description Symbol

Negation Operator

-

Field Search Operator

:

Quote (for exact search)

"

Comma (list multiple search terms)

,

Please note that the text search is case insensitive, and will only display content items within the hub. See the following examples for an explanation of the query syntax:

Table 3. Text Search Examples
Query Meaning

apple

Find all content items containing the word "apple"

apple orange

Find all content items containing the words "apple" AND "orange"

apple,orange

Find all content items containing either "apple" OR "orange"

apple -orange

Find all content items that contain the word "apple" but NOT "orange"

-apple-orange

Find all content items that don’t contain "apple-orange" (hyphens in the middle of a word are not treated as negation)

label:apple

Find all content items that contain the word "apple" within the "label" field

"apple:orange"

Find all content items containing "apple:orange" (quotes must be used to search for a colon character)

apple label:orange

Find all content items containing the word "apple" anywhere within them, AND the word "orange" in the label field

Publish Content Item

In order to publish a content item follow the HAL link with the rel "publish" on a Content item, which will return with the location of the newly created Publishing-Job.

Auth rules

Snippet auth-rules not found for operation::content-item-publish

Example request

Snippet http-request not found for operation::content-item-publish

Example response

Snippet http-response not found for operation::content-item-publish

Get Edition Slot Associations

This allows a user to see all places a content item is used.

Auth rules

Snippet auth-rules not found for operation::edition-slot-associations-get

Example request

Snippet http-request not found for operation::edition-slot-associations-get

Example response

Snippet http-response not found for operation::edition-slot-associations-get

Localization

See Localization for info on how to work with Content Item level localization. Including APIs for assigning a locale to your content and preparing for translating content into other languages.

Assigning a workflow

You can assign a workflow to a Content Item as long as they share a hub.

Auth rules

Snippet auth-rules not found for operation::assign-workflow-to-content-item

Example request

Snippet http-request not found for operation::assign-workflow-to-content-item

Example response

Snippet http-response not found for operation::assign-workflow-to-content-item

for more information on workflows see Workflows

Assigning a delivery key

You can assign a delivery key to a content item as long as it fits the validation rules for a delivery key and it does not already exist on the hub currently.

Auth rules

Snippet auth-rules not found for operation::content-item-delivery-key

Example request

Snippet http-request not found for operation::content-item-delivery-key

Example response

Snippet http-response not found for operation::content-item-delivery-key

Events

An Event represents a major date in the calendar, such as Christmas or Black Friday. An Event may span multiple days and start and end at any given UTC time.

An Event contains a collection of Editions.

Creating a new Event

Auth rules

Snippet auth-rules not found for operation::events-create

Example request

Snippet http-request not found for operation::events-create

Example response

Snippet http-response not found for operation::events-create

Get an Event

Auth rules

Snippet auth-rules not found for operation::events-get

Example request

Snippet http-request not found for operation::events-get

Example response

Snippet http-response not found for operation::events-get

Get an Event with Editions

It is possible to retrieve both the Event and its child Editions in a single request. Simply add the projection=withEditions query string parameter to the request as shown below.

Auth rules

Snippet auth-rules not found for operation::events-get-with-editions

Example request

Snippet http-request not found for operation::events-get-with-editions

Example response

Snippet http-response not found for operation::events-get-with-editions

Listing Events

Auth rules

Snippet auth-rules not found for operation::events-list

Example request

Snippet http-request not found for operation::events-list

Example response

Snippet http-response not found for operation::events-list

It is also possible to include the Editions of each Event in the response by using the projection=withEditions query string parameter as shown above.

Updating an Event

Auth rules

Snippet auth-rules not found for operation::events-update

Example request

Snippet http-request not found for operation::events-update

Example response

Snippet http-response not found for operation::events-update

Delete an Event

Auth rules

Snippet auth-rules not found for operation::events-delete

Example request

Snippet http-request not found for operation::events-delete

Example response

Snippet http-response not found for operation::events-delete

Searching Events

findByDate

Auth rules

Snippet auth-rules not found for operation::events-search-findByDateRange

Example request

Snippet http-request not found for operation::events-search-findByDateRange

Example response

Snippet http-response not found for operation::events-search-findByDateRange

With Edition Projection

To expose the Editions that are associated with the Event you can use the projection=withEditions query string parameter as shown below.

Auth rules

Snippet auth-rules not found for operation::events-search-findByDateRange-withProjection

Example request

Snippet http-request not found for operation::events-search-findByDateRange-withProjection

Example response

Snippet http-response not found for operation::events-search-findByDateRange-withProjection

Optional End Date

The rangeEnd is optional

Auth rules

Snippet auth-rules not found for operation::events-search-findByDateRange-optionalEndDate

Example request

Snippet http-request not found for operation::events-search-findByDateRange-optionalEndDate

Example response

Snippet http-response not found for operation::events-search-findByDateRange-optionalEndDate

Find Expired Events

Set the "bounded" flag to "1" to look for events have started and ended for the given range. Set the page size to the lowest value "1"

Auth rules

Snippet auth-rules not found for operation::events-search-findByDateRange-expired

Example request

Snippet http-request not found for operation::events-search-findByDateRange-expired

Example response

Snippet http-response not found for operation::events-search-findByDateRange-expired

Find Live Events

Set the "bounded" flag to "0", to look for events that are active during the given range. Set the page size to the lowest value "1"

Auth rules

Snippet auth-rules not found for operation::events-search-findByDateRange-live

Example request

Snippet http-request not found for operation::events-search-findByDateRange-live

Example response

Snippet http-response not found for operation::events-search-findByDateRange-live

Find Upcoming Events

Set the "bounded" flag to "1" to look for events have started and end for the given range. Set the page size to the lowest value "1"

Auth rules

Snippet auth-rules not found for operation::events-search-findByDateRange-upcoming

Example request

Snippet http-request not found for operation::events-search-findByDateRange-upcoming

Example response

Snippet http-response not found for operation::events-search-findByDateRange-upcoming

Find Events By Date Range and Slots

Auth rules

Snippet auth-rules not found for operation::events-search-findByDateRangeAndSlots

Example request

Snippet http-request not found for operation::events-search-findByDateRangeAndSlots

Example response

Snippet http-response not found for operation::events-search-findByDateRangeAndSlots

With Edition Projection

To expose the Editions that are associated with the Event you can use the projection=withEditions query string parameter as shown below.

Auth rules

Snippet auth-rules not found for operation::events-search-findByDateRangeAndSlots-withProjection

Example request

Snippet http-request not found for operation::events-search-findByDateRangeAndSlots-withProjection

Example response

Snippet http-response not found for operation::events-search-findByDateRangeAndSlots-withProjection

Editions

An Edition is the main way of scheduling content to be published on a specific date. It holds the association between slots and content items. Once all slots are valid and there are no conflicts, it is ready to be scheduled.

Creating a new Edition

Auth rules

Snippet auth-rules not found for operation::editions-create

Example request

Snippet http-request not found for operation::editions-create

Example response

Snippet http-response not found for operation::editions-create

Duplicate an Edition

Auth rules

Snippet auth-rules not found for operation::editions-duplicate

Example request

Snippet http-request not found for operation::editions-duplicate

Example response

Snippet http-response not found for operation::editions-duplicate

Listing Editions

Auth rules

Snippet auth-rules not found for operation::editions-list

Example request

Snippet http-request not found for operation::editions-list

Example response

Snippet http-response not found for operation::editions-list

Get an Edition

Auth rules

Snippet auth-rules not found for operation::editions-get

Example request

Snippet http-request not found for operation::editions-get

Example response

Snippet http-response not found for operation::editions-get

Updating an Edition

Auth rules

Snippet auth-rules not found for operation::editions-update

Example request

Snippet http-request not found for operation::editions-update

Example response

Snippet http-response not found for operation::editions-update

Delete an Edition

Auth rules

Snippet auth-rules not found for operation::editions-delete

Example request

Snippet http-request not found for operation::editions-delete

Example response

Snippet http-response not found for operation::editions-delete

Schedule an Edition

In order to schedule an Edition, the Edition must be in the DRAFT state, all Edition Slots must be in the 'VALID' state, and there must be no conflicts in the Edition. This will then trigger the publishing job to take place on the start date of the Edition.

Auth rules

Snippet auth-rules not found for operation::editions-schedule

Example request

Snippet http-request not found for operation::editions-schedule

Example response

Snippet http-response not found for operation::editions-schedule

Unschedule an Edition

If the Edition has been scheduled it is possible to cancel the publishing job by unscheduling the edition.

Auth rules

Snippet auth-rules not found for operation::editions-unschedule

Example request

Snippet http-request not found for operation::editions-unschedule

Example response

Snippet http-response not found for operation::editions-unschedule

Create an Edition Preview

In order to create an Edition preview, the Edition must be in the DRAFT state, at least one Edition Slots must be in the 'VALID' state, and there must be no conflicts in the Edition. This creates a publishing snapshot that can be previewed through the app or in Time Machine.

Auth rules

Snippet auth-rules not found for operation::editions-preview

Example request

Snippet http-request not found for operation::editions-preview

Example response

Snippet http-response not found for operation::editions-preview

Get an Edition Preview

If an Edition has been Previewed or is Scheduled then you can retrieve the Snapshot to be used with the Preview application or in Time Machine.

Auth rules

Snippet auth-rules not found for operation::editions-preview-get

Example request

Snippet http-request not found for operation::editions-preview-get

Example response

Snippet http-response not found for operation::editions-preview-get

Delete an Edition Preview

If an Edition has been Previewed it can be deleted, if the Edition is Scheduled then it cannot be deleted.

Auth rules

Snippet auth-rules not found for operation::editions-preview-delete

Example request

Snippet http-request not found for operation::editions-preview-delete

Example response

Snippet http-response not found for operation::editions-preview-delete

Search Editions

Auth rules

Snippet auth-rules not found for operation::editions-search

Example request

Snippet http-request not found for operation::editions-search

Example response

Snippet http-response not found for operation::editions-search

Find By Event

Auth rules

Snippet auth-rules not found for operation::editions-search-findByEvent

Example request

Snippet http-request not found for operation::editions-search-findByEvent

Example response

Snippet http-response not found for operation::editions-search-findByEvent

Get Edition Conflicts

Auth rules

Snippet auth-rules not found for operation::editions-conflicts

Example request

Snippet http-request not found for operation::editions-conflicts

Example response

Snippet http-response not found for operation::editions-conflicts

Get Edition Conflict By ID and Version

Auth rules

Snippet auth-rules not found for operation::editions-conflict-id-version

Example request

Snippet http-request not found for operation::editions-conflict-id-version

Example response

Snippet http-response not found for operation::editions-conflict-id-version

Resolve Edition Conflicts

Auth rules

Snippet auth-rules not found for operation::resolve-editions-conflicts

Example request

Snippet http-request not found for operation::resolve-editions-conflicts

Example response

Snippet http-response not found for operation::resolve-editions-conflicts

Get Edition Slot Collisions

Auth rules

Snippet auth-rules not found for operation::edition-slot-collisions-get

Example request

Snippet http-request not found for operation::edition-slot-collisions-get

Example response

Snippet http-response not found for operation::edition-slot-collisions-get

Copy Edition Slot To Edition

Auth rules

Snippet auth-rules not found for operation::edition-slot-copy

Example request

Snippet http-request not found for operation::edition-slot-copy

Example response

Snippet http-response not found for operation::edition-slot-copy

Slots

"Slots" are content-items which are stored in separate repositories from other content-item items. Their role is to be placeholders for snapshots.

Example Slot Content Type

{
  "$schema" : "http://bigcontent.io/cms/schema/v1/schema#",
  "id" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
  "title" : "slot",
  "description" : "Slot Container",
  "type":"object",
  "properties": {
    "slot": {
      "title": "simple slot container",
      "allOf":[
        {"$ref": "http://bigcontent.io/cms/schema/v1/core#/definitions/content-link" },
        {
          "properties": {
            "contentType": { "enum": [ "http://deliver.bigcontent.io/schema/nested/nested-type.json" ] }
          }
        }
      ]
    }
  }
}

You will need to register a content type capable of holding nested content in order to create a slot.

Creating a Slot Repository

A Slot Repository is just a Content Repository with the "slots" feature. (See adding features to repositories)

Creating a Slot

A Slot is just a Content Item in a Slot Repository. Here’s a sample Content Item for the above Slot Type

Auth rules

Snippet auth-rules not found for operation::example-slot

Example request

Snippet http-request not found for operation::example-slot

Example response

Snippet http-response not found for operation::example-slot

Associating Slots to Editions

Once you have a Slot Repository with some Slots you can then associate them with an Edition in order make them available for publishing.

  • Multiple Slots can be associated to an Edition, up to 200.

  • A Slot can be associated with multiple Editions.

  • A Slot can only be associated to an Edition once

When you associate Slots to an Edition, the slotsRemaining property on the Edition will decrease. If you attempt to associate more Slots than there are remaining on the Edition, the operation will fail.

Auth rules

Snippet auth-rules not found for operation::editions-slots-create

Example request

Snippet http-request not found for operation::editions-slots-create

Example response

Snippet http-response not found for operation::editions-slots-create

Retrieving Slots associated to an Edition

Auth rules

Snippet auth-rules not found for operation::editions-slots-list

Example request

Snippet http-request not found for operation::editions-slots-list

Example response

Snippet http-response not found for operation::editions-slots-list

Retrieving Slots associated to an Edition filter by content item

Auth rules

Snippet auth-rules not found for operation::editions-slots-list-filter-slots

Example request

Snippet http-request not found for operation::editions-slots-list-filter-slots

Example response

Snippet http-response not found for operation::editions-slots-list-filter-slots

Retrieving an single Slot associated to an Edition

Auth rules

Snippet auth-rules not found for operation::editions-slots-get

Example request

Snippet http-request not found for operation::editions-slots-get

Example response

Snippet http-response not found for operation::editions-slots-get

Removing the association between a Slot and an Edition

Auth rules

Snippet auth-rules not found for operation::editions-slots-delete

Example request

Snippet http-request not found for operation::editions-slots-delete

Example response

Snippet http-response not found for operation::editions-slots-delete

Associating Snapshots to Slots

A slot is a placeholder for one or more snapshots. In order to associate those snapshots to this slot you will need to post the resulting content item to the slot url.

Notice that in the below request, body.slot.id is the path to a snapshot. Not a content item.

Auth rules

Snippet auth-rules not found for operation::associate-snapshot-to-slot

Example request

Snippet http-request not found for operation::associate-snapshot-to-slot

Example response

Snippet http-response not found for operation::associate-snapshot-to-slot

If you then retrieve the slot for that edition it will contain the content item posted previously.

Auth rules

Snippet auth-rules not found for operation::slot-with-content

Example request

Snippet http-request not found for operation::slot-with-content

Example response

Snippet http-response not found for operation::slot-with-content

The body.slot.id can also be set to null when the user hasn’t currently assigned all of the fields. The service will accept this data, however the valid field will be set to false.

Auth rules

Snippet auth-rules not found for operation::associate-snapshot-to-slot-unverified

Example request

Snippet http-request not found for operation::associate-snapshot-to-slot-unverified

Example response

Snippet http-response not found for operation::associate-snapshot-to-slot-unverified

Snapshot

A Snapshot is an immutable representation of a content item with all of its descendants (including their versions) at a given point in time.

Creating a new Snapshot

Auth rules

Snippet auth-rules not found for operation::snapshot-create

Example request

Snippet http-request not found for operation::snapshot-create

Example response

Snippet http-response not found for operation::snapshot-create

Creating a batch of new Snapshots

Auth rules

Snippet auth-rules not found for operation::snapshot-create-batch

Example request

Snippet http-request not found for operation::snapshot-create-batch

Example response

Snippet http-response not found for operation::snapshot-create-batch

Listing Snapshots

Auth rules

Snippet auth-rules not found for operation::snapshots-get

Example request

Snippet http-request not found for operation::snapshots-get

Example response

Snippet http-response not found for operation::snapshots-get

Retrieve a Snapshot by id

Auth rules

Snippet auth-rules not found for operation::snapshot-get-by-id

Example request

Snippet http-request not found for operation::snapshot-get-by-id

Example response

Snippet http-response not found for operation::snapshot-get-by-id

A "Snapshot Edition link" is a reference between an snapshot and an edition. A snapshot can be linked to multiple editions.

Auth rules

Snippet auth-rules not found for operation::snapshot-edition-links-create

Example request

Snippet http-request not found for operation::snapshot-edition-links-create

Example response

Snippet http-response not found for operation::snapshot-edition-links-create

Auth rules

Snippet auth-rules not found for operation::snapshot-edition-links-delete

Example request

Snippet http-request not found for operation::snapshot-edition-links-delete

Example response

Snippet http-response not found for operation::snapshot-edition-links-delete

In order to get the list of Snapshot Edition Links for a given Snapshot, simply follow the HAL link with rel "snapshot-edition-links" on a Snapshot

Auth rules

Snippet auth-rules not found for operation::snapshot-edition-links-list

Example request

Snippet http-request not found for operation::snapshot-edition-links-list

Example response

Snippet http-response not found for operation::snapshot-edition-links-list

Publishing a Snapshot

In order to publish a snapshot follow the HAL link with the rel "create-publishing-job" on a Snapshot

Creating a Publishing-Job for a Snapshot

Auth rules

Snippet auth-rules not found for operation::publishing-jobs-create

Example request

Snippet http-request not found for operation::publishing-jobs-create

Example response

Snippet http-response not found for operation::publishing-jobs-create

Retrieving a Publishing-Job for a Snapshot

Auth rules

Snippet auth-rules not found for operation::publishing-jobs-get

Example request

Snippet http-request not found for operation::publishing-jobs-get

Example response

Snippet http-response not found for operation::publishing-jobs-get

Cancelling a Publishing-Job for a Snapshot

Auth rules

Snippet auth-rules not found for operation::publishing-jobs-cancel

Example request

Snippet http-request not found for operation::publishing-jobs-cancel

Example response

Snippet http-response not found for operation::publishing-jobs-cancel

Listing all Publishing-Jobs for a Snapshot

Auth rules

Snippet auth-rules not found for operation::publishing-jobs-list

Example request

Snippet http-request not found for operation::publishing-jobs-list

Example response

Snippet http-response not found for operation::publishing-jobs-list

Folders

Folders are used to organise items in a hierarchical structure. Currently only enabled for organising content items within a content repository.

Creating a new Folder

To create a new folder follow the "create-folder" link from a content repository.

Auth rules

Snippet auth-rules not found for operation::create-folder

Example request

Snippet http-request not found for operation::create-folder

Example response

Snippet http-response not found for operation::create-folder

Creating a new sub folder

You can create a sub folder by following the "create-folder" link from a folder.

Auth rules

Snippet auth-rules not found for operation::create-sub-folder

Example request

Snippet http-request not found for operation::create-sub-folder

Example response

Snippet http-response not found for operation::create-sub-folder

Get a folder

Auth rules

Snippet auth-rules not found for operation::get-folder

Example request

Snippet http-request not found for operation::get-folder

Example response

Snippet http-response not found for operation::get-folder

Delete a folder

To be able to delete a folder it must be empty of subfolders and content items

Auth rules

Snippet auth-rules not found for operation::delete-folder

Example request

Snippet http-request not found for operation::delete-folder

Example response

Snippet http-response not found for operation::delete-folder

Get top-level folders in a repository

Auth rules

Snippet auth-rules not found for operation::get-folders-in-repository

Example request

Snippet http-request not found for operation::get-folders-in-repository

Example response

Snippet http-response not found for operation::get-folders-in-repository

Get sub-folders of a folder

Auth rules

Snippet auth-rules not found for operation::get-subfolders-of-parent-folder

Example request

Snippet http-request not found for operation::get-subfolders-of-parent-folder

Example response

Snippet http-response not found for operation::get-subfolders-of-parent-folder

Update a folder

Auth rules

Snippet auth-rules not found for operation::update-folder

Example request

Snippet http-request not found for operation::update-folder

Example response

Snippet http-response not found for operation::update-folder

Localization

There are 2 methods of localizing your content into multiple languages, field-level localization and item-level localization. With field-level localization, your content type schema defines which values in your content can be translated into different languages. All translations exist as data in a single item. With item-level localization, you create separate copies of your content for each language.

Hub Localization Settings

In order to enable localization features for your Hub, you will need to add localization settings.

The first locale in the list will become the Hub’s master locale, which cannot be changed once set:

Auth rules

Snippet auth-rules not found for operation::hub-update-settings-localization-using-patch

Example request

Snippet http-request not found for operation::hub-update-settings-localization-using-patch

Example response

Snippet http-response not found for operation::hub-update-settings-localization-using-patch

Item-level localization

Assigning a locale to a Content Item

Once your Hub has been assigned some locales, you can assign one of those locales to your content. Note: Once, you have assigned a locale to a Content Item it can not be changed

You can either assign a locale to a Content Item when you create it, or to an existing item. See below for examples of both.

Auth rules

Snippet auth-rules not found for operation::content-item-set-locale-on-create

Example request

Snippet http-request not found for operation::content-item-set-locale-on-create

Example response

Snippet http-response not found for operation::content-item-set-locale-on-create

Auth rules

Snippet auth-rules not found for operation::content-item-set-locale

Example request

Snippet http-request not found for operation::content-item-set-locale

Example response

Snippet http-response not found for operation::content-item-set-locale

Localizing a content graph

Once your content items have been assigned a locale, you can prepare your content for translation by localizing a content item and all of it’s descendents into the desired target locale(s).

Auth rules

Snippet auth-rules not found for operation::create-content-item-localizations

Example request

Snippet http-request not found for operation::create-content-item-localizations

Example response

Snippet http-response not found for operation::create-content-item-localizations

This operation will create variants of the given content item (the root content item) and its descendants with the given locales. At present, the content items will not be translated automatically as part of this operation, but all created variants of a content item will be related to support quickly switching variants based on the desired locale.

If the request is successful, a localization job will be started which will create the necessary content items asynchronously. In order to start a localization job in this manner, the following conditions must be met:

  1. The source content item must have a locale

  2. The target locales must be supported by the hub

  3. A variant of the source content item must not already exist in any of the specified locales

  4. You must specify the current version of the source content item (similar to updating a content item)

A successful request will result in the creation of at least one new content item (a variant of the root content item). The localization job will attempt to preserve the structure of the content graph composed of the root content item and descendant content items. Content item variants created by this process will be placed adjacent to their source content item.

Content Item Graph Localization Examples

Where possible, graph structure will be preserved. Consider a request to localize a content item A from en-GB to an fr-FR variant A'. Item A and all descendant content items have the en-GB locale.

    A                       A                A'
   / \                     / \              / \
  B   C        ==>        B   C            B'  C'
 /   / \                 /   / \          /   / \
D   E   F               D   E   F        D'  E'  F'

Only content items which have a locale will have variants created. In the event that a content item in the graph does not have a locale, the newly created content graph will link back to the original un-localized item. Consider the request from the previous example, but this time item C does not have a locale.

    A                       A   A'
   / \                     / \ / \
  B   C        ==>        B   C   B'
 /   / \                 /   / \   \
D   E   F               D   E   F   D'

Note that the new fr-FR variant A' links to the un-localized content item C. If E and F have the en-GB locale, no fr-FR variant will be created for either of them since this would break the original graph structure, therefore it is advised to avoid having un-localized content items with localized children where possible.

If a content item variant already exists then it will be incorporated into the new content graph where possible. Consider the case where an fr-FR variant of C already exists - the newly created content graph will link to C' and preserve the original graph structure.

    A                                     A                A'
   / \                                   / \              / \
  B   C            C'        ==>        B   C            B'  C'
 /   / \          / \                  /   / \          /   / \
D   E   F        E'  F'               D   E   F        D'  E'  F'

Listing the localizations of a Content Item

Once a Content Item has been localized into one or more desired locales, you will be able to see the list of all localizations by following the "localizations" HAL link.

Auth rules

Snippet auth-rules not found for operation::content-items-localizations

Example request

Snippet http-request not found for operation::content-items-localizations

Example response

Snippet http-response not found for operation::content-items-localizations

Localization Jobs

Content item localization is performed asynchronously - the request to localize a content item graph creates a Localization Job which will be completed at some point in the future. It is possible to track the status of these jobs as follows:

Auth rules

Snippet auth-rules not found for operation::list-localization-jobs

Example request

Snippet http-request not found for operation::list-localization-jobs

Example response

Snippet http-response not found for operation::list-localization-jobs

Localization jobs can have the following status codes:

Table 4. Localization Job Status
Status Description

IN_PROGRESS

The localization job is still in progress. Some content item variants may have already been created.

SUCCEEDED

The localization job has been completed successfully.

PARTIALLY_SUCCEEDED

The localization job created at least one content item variant successfully, but the full graph will not have been localized.

FAILURE

The localization job was unsuccessful

When tracking localization jobs for a particular content graph, the root content item ID must be provided as the query parameter, providing child IDs will give no results. Localization jobs will be tracked against the root content item and all locale variants, so if more than one locale variant of the root content item exists, using any of the IDs will give the same localization job results.

Assigning a set of locales to a Content Repository

In order to organise your localized content into separate repositories you can assign a set locales to a Content Repository. You may want to do this in order to give different teams different permissions to create or edit content based on locale.

Assigning locales to a Content Repository has 2 effects. Firstly, you will only be able to assign locales to Content Items which match those assigned to the repository. Secondly, when localizing a content graph, the newly created Content Items will be created in the appropriate Content Repository which match the desired locale.

Auth rules

Snippet auth-rules not found for operation::content-repository-assign-locales

Example request

Snippet http-request not found for operation::content-repository-assign-locales

Example response

Snippet http-response not found for operation::content-repository-assign-locales

Joining a Content Repository to a localization group

The following API allows you to make 2 or more Content Repositories part of the same "group". The new repository will leave it’s current group and join the group of the target repository. To do this, follow the "join-localization-group" HAL link from the target repository and specify the new repository in the body.

Auth rules

Snippet auth-rules not found for operation::content-repository-join-localization-group

Example request

Snippet http-request not found for operation::content-repository-join-localization-group

Example response

Snippet http-response not found for operation::content-repository-join-localization-group

For example, lets say you have 3 Content Repositories, Repo1 has no locales assigned, Repo2 and Repo3 are both members of the same group and are assigned locales ["en-GB", "en-US"] and ["fr-FR"] respectively. The following example shows localizing en-GB content into fr-FR. A1 signifies that item A exists in Repo1.

    A1                   A1              A'1
   /  \                 /  \             / \
  B2   C1      ==>     B2   C1         B'3  C'1
 /    /  \            /    /  \        /    / \
D2   E2   F2         D2   E2   F2    D'3  E'3  F'3

Note that the new fr-FR variant A' still exists in Repo1, whereas B' is created in Repo3.

Listing all item locales in a Content Repository localization group

A list of all supported item locales in a Content Repository localization group can be requested as follows:

Auth rules

Snippet auth-rules not found for operation::list-repository-localization-group-locales

Example request

Snippet http-request not found for operation::list-repository-localization-group-locales

Example response

Snippet http-response not found for operation::list-repository-localization-group-locales

This request can be made using the ID of any repository in the localization group.

Administration

Listing Administrative Operations

To list the available administrative operations available to you, navigate the "admin" link from the root of the API. It will return a list of links to other resources which will allow you to perform the desired operation.

The following operations are available based on your permissions

Table 5. Operations
Operation rel

Manage Access

"access"

Manage Modules

"modules"

Auth rules

Snippet auth-rules not found for operation::list-admin-operations

Example request

Snippet http-request not found for operation::list-admin-operations

Example response

Snippet http-response not found for operation::list-admin-operations

Managing Access

With the ability to manage access you can control which users have which permissions to the resources you administer. In order to see which resource types you can manage, follow the "access" link.

Auth rules

Snippet auth-rules not found for operation::manage-access-list-resources

Example request

Snippet http-request not found for operation::manage-access-list-resources

Example response

Snippet http-response not found for operation::manage-access-list-resources

Listing access operations for a resource

Given the id of a resource for which you are an administrator, you can see the various operations that you can perform. Simply follow the appropriate link for the resource passing in the id.

For example, to see the operations you can perform on a particular Hub:

Auth rules

Snippet auth-rules not found for operation::manage-access-list-hub-operations

Example request

Snippet http-request not found for operation::manage-access-list-hub-operations

Example response

Snippet http-response not found for operation::manage-access-list-hub-operations

And to see the operations you can perform on a particular Content Repository:

Auth rules

Snippet auth-rules not found for operation::manage-access-list-content-repository-operations

Example request

Snippet http-request not found for operation::manage-access-list-content-repository-operations

Example response

Snippet http-response not found for operation::manage-access-list-content-repository-operations

Listing members on a resource

In order to see who has access to a particular resource follow the "members" link. This will also show you the member id (sid) and list the permissions they have on the given resource

For example, to list the members of a Hub:

Auth rules

Snippet auth-rules not found for operation::manage-access-list-members-on-hub

Example request

Snippet http-request not found for operation::manage-access-list-members-on-hub

Example response

Snippet http-response not found for operation::manage-access-list-members-on-hub

And to list the members of a Content Repository:

Auth rules

Snippet auth-rules not found for operation::manage-access-list-members-on-content-repository

Example request

Snippet http-request not found for operation::manage-access-list-members-on-content-repository

Example response

Snippet http-response not found for operation::manage-access-list-members-on-content-repository

Get a member by id

Given a resource and a member id you can navigate directly to a specific member by following the "member" link from the resource.

Auth rules

Snippet auth-rules not found for operation::manage-access-get-member-on-hub

Example request

Snippet http-request not found for operation::manage-access-get-member-on-hub

Example response

Snippet http-response not found for operation::manage-access-get-member-on-hub

Revoking permission

You can revoke access to a specific resource by deleting a members permission. From a member, you can follow the "revoke-permission" link passing in the permission to delete. You can specify one or multiple permissions. Multiple permissions are comma separated.

For example, to delete a single permission:

Auth rules

Snippet auth-rules not found for operation::manage-access-revoke-permission-on-hub

Example request

Snippet http-request not found for operation::manage-access-revoke-permission-on-hub

Example response

Snippet http-response not found for operation::manage-access-revoke-permission-on-hub

To delete multiple permissions:

Auth rules

Snippet auth-rules not found for operation::manage-access-revoke-multiple-permissions-on-hub

Example request

Snippet http-request not found for operation::manage-access-revoke-multiple-permissions-on-hub

Example response

Snippet http-response not found for operation::manage-access-revoke-multiple-permissions-on-hub

Managing Modules

Modules offer additional functionality which is not enabled by default. With the ability to manage modules you can control which modules are enabled on the resources you administer. In order to see which resource types you can manage, follow the "modules" link.

Auth rules

Snippet auth-rules not found for operation::list-module-resources

Example request

Snippet http-request not found for operation::list-module-resources

Example response

Snippet http-response not found for operation::list-module-resources

Listing module operations for a resource

Given the id of a resource for which you are an administrator, you can see the various operations that you can perform. Simply follow the appropriate link for the resource passing in the id.

For example, to see the operations you can perform on a particular Hub:

Auth rules

Snippet auth-rules not found for operation::list-hub-module-operations

Example request

Snippet http-request not found for operation::list-hub-module-operations

Example response

Snippet http-response not found for operation::list-hub-module-operations

Enable a module for a resource

To enable a module for a resource for which you are an administrator, simply follow the appropriate link.

For example, to enable the "content-delivery-2" module on a hub, follow the "enable-content-delivery-2" link.

Auth rules

Snippet auth-rules not found for operation::enable-content-delivery-2

Example request

Snippet http-request not found for operation::enable-content-delivery-2

Example response

Snippet http-response not found for operation::enable-content-delivery-2

Webhooks

A WebHook is an HTTP callback: an HTTP POST that occurs when something happens; a simple event-notification via HTTP POST.

Creating a new Webhook for a Hub

Supported event names that will be accepted by the events array when creating a new webhook:

Event name Event label

dynamic-content.snapshot.published

Snapshot - published

dynamic-content.edition.scheduled

Edition - scheduled

dynamic-content.edition.unscheduled

Edition - unscheduled

dynamic-content.edition.published

Edition - published

dynamic-content.content-item.created

Content item - created

dynamic-content.content-item.updated

Content item - updated

dynamic-content.content-item.assigned

Content item - assigned

dynamic-content.content-item.workflow.updated

Content item workflow - updated

For more information on using webhooks see https://docs.amplience.net/integration/webhooks.html

Auth rules

Snippet auth-rules not found for operation::hub-webhooks-create

Example request

Snippet http-request not found for operation::hub-webhooks-create

Example response

Snippet http-response not found for operation::hub-webhooks-create

Listing all Webhooks for a Hub

Auth rules

Snippet auth-rules not found for operation::hub-webhooks-list

Example request

Snippet http-request not found for operation::hub-webhooks-list

Example response

Snippet http-response not found for operation::hub-webhooks-list

Listing all Requests for a Webhook

Auth rules

Snippet auth-rules not found for operation::hub-webhooks-requests

Example request

Snippet http-request not found for operation::hub-webhooks-requests

Example response

Snippet http-response not found for operation::hub-webhooks-requests

Get a Webhook

Auth rules

Snippet auth-rules not found for operation::hub-webhooks-get-single

Example request

Snippet http-request not found for operation::hub-webhooks-get-single

Example response

Snippet http-response not found for operation::hub-webhooks-get-single

Updating a Webhook

Auth rules

Snippet auth-rules not found for operation::hub-webhooks-update

Example request

Snippet http-request not found for operation::hub-webhooks-update

Example response

Snippet http-response not found for operation::hub-webhooks-update

Deleting a Webhook

Auth rules

Snippet auth-rules not found for operation::hub-webhooks-delete

Example request

Snippet http-request not found for operation::hub-webhooks-delete

Example response

Snippet http-response not found for operation::hub-webhooks-delete

Workflows

It is possible to define a list of workflow states on a hub which will allow users to implement one or more rudimentary workflows. Each content item within the hub can have it’s status set to one of the workflow states defined within the hub.

In the interest of flexibility, the transitions between states are not validated. In other words, it is possible to transition a content item from any state into any other state.

for more information on adding a workflow to a contentItem see Assigning a workflow

Creating a Workflow State

You may create up to 100 workflow states per hub.

The color property is an RGB value representing the color which should be used to display the workflow state within Dynamic Content. A value for color must be provided.

Auth rules

Snippet auth-rules not found for operation::create-workflow-state

Example request

Snippet http-request not found for operation::create-workflow-state

Example response

Snippet http-response not found for operation::create-workflow-state

Listing Workflow States On a Hub

Auth rules

Snippet auth-rules not found for operation::list-workflow-states

Example request

Snippet http-request not found for operation::list-workflow-states

Example response

Snippet http-response not found for operation::list-workflow-states

Get a Workflow State

Auth rules

Snippet auth-rules not found for operation::get-workflow-state

Example request

Snippet http-request not found for operation::get-workflow-state

Example response

Snippet http-response not found for operation::get-workflow-state

Update a Workflow State

You may update the label or color for any workflow state attached to your hub or hubs.

Auth rules

Snippet auth-rules not found for operation::update-workflow-state

Example request

Snippet http-request not found for operation::update-workflow-state

Example response

Snippet http-response not found for operation::update-workflow-state

Integrations

Salesforce Commerce Cloud (SFCC) Integration

For more information please refer to our Salesforce Commerce Cloud integration documentation.

Listing the Salesforce Commerce Cloud (SFCC) Integrations

To list all of the SFCC integrations for a Hub, follow the "list-integrations" HAL link of the "sfcc" integration.

Auth rules

Snippet auth-rules not found for operation::integrations-list-sfcc-list

Example request

Snippet http-request not found for operation::integrations-list-sfcc-list

Example response

Snippet http-response not found for operation::integrations-list-sfcc-list

Creating a new Salesforce Commerce Cloud (SFCC) Integration

To create a new SFCC Integration, invoke the "create-integration" HAL link of the "sfcc" integration.

Auth rules

Snippet auth-rules not found for operation::integrations-list-sfcc-create

Example request

Snippet http-request not found for operation::integrations-list-sfcc-create

Example response

Snippet http-response not found for operation::integrations-list-sfcc-create

Extensions

Create an Extension

Auth rules

Snippet auth-rules not found for operation::extension-create

Example request

Snippet http-request not found for operation::extension-create

Example response

Snippet http-response not found for operation::extension-create

Listing Extensions

Auth rules

Snippet auth-rules not found for operation::extension-list

Example request

Snippet http-request not found for operation::extension-list

Example response

Snippet http-response not found for operation::extension-list

Get an Extension

Auth rules

Snippet auth-rules not found for operation::extension-get

Example request

Snippet http-request not found for operation::extension-get

Example response

Snippet http-response not found for operation::extension-get

Get an Extension by name

Auth rules

Snippet auth-rules not found for operation::get-extension-by-name

Example request

Snippet http-request not found for operation::get-extension-by-name

Example response

Snippet http-response not found for operation::get-extension-by-name

Update an Extension

Auth rules

Snippet auth-rules not found for operation::extension-update

Example request

Snippet http-request not found for operation::extension-update

Example response

Snippet http-response not found for operation::extension-update

Delete an Extension

Auth rules

Snippet auth-rules not found for operation::extension-delete

Example request

Snippet http-request not found for operation::extension-delete

Example response

Snippet http-response not found for operation::extension-delete