1. Overview

These client-independent services manage CMS-related items.

1.1. Version information

Version : 1.0

1.2. License information

License : Use of this file is subject to the terms of your agreement with SAP SE or its affiliates respecting the use of the SAP product for which this file relates.
Terms of service : null

1.3. URI scheme

Host : hostname
BasePath : /cmswebservices

1.4. Tags

  • catalog version media : Controller that provides media.

  • catalog version synchronization : Controller that handles synchronization of catalogs

  • catalog versions : Controller that provides an API to retrieve a catalog version information.

  • cmsitems : Generic controller to deal with CMS items (Components, Pages, Restrictions).

  • item synchronization : Controller to retrieve a synchronization status to perform synchronization

  • languages : Controller to deal with languages.

  • media : Controller that handles searching for media.

  • media containers : Media Container Controller

  • media folder : Media Folder Controller

  • medias : Medias Controller

  • navigation : Controller to deal with navigation objects

  • page restrictions : Controller that provides an API to retrieve all pages and their restrictions.

  • page slot components : Controller that provides an API to update components either between slots, or within a single slot.

  • page slot containers : Controller that provides an API to retrieve information about containers in content slots in a page.

  • page slot restrictions : Controller that provides type restrictions for CMS content slots.

  • page slots : Controller that provides an API to retrieve all pages where a given content slot is present.

  • page templates : Controller to deal with page template objects

  • page type restrictions : Controller that provides an API to retrieve all pages types and their restrictions types.

  • page types : Controller to get page types.

  • pages : Controller to deal with an abstract page model objects

  • product categories : Controller to retrieve and search products within a Product Catalog Version.

  • products : Product Controller

  • restriction types : Controller to get restriction types.

  • sites : Controller to support the sites end point.

  • types : Controller to deal with component types.

  • user groups : Controller to retrieve and search for user groups.

  • users : User Controller

  • versions : Controller to deal with versions

  • workflow actions : Controller to manage workflow actions.

  • workflow operations : Controller that provides an API to perform different operations on workflows.

  • workflow templates : Controller that provides an API to retrieve workflow templates for a given catalog version.

  • workflows : Controller to manage workflows for CMS Items.

1.5. Produces

  • application/json

2. Paths

2.1. Gets last synchronization by target catalog.

GET /v1/catalogs/{catalogId}/synchronizations/targetversions/{targetVersionId}

2.1.1. Description

Retrieves the status of the last synchronization job. Information is retrieved based on the catalog version target.

2.1.2. Parameters

Type Name Description Schema

Path

catalogId
required

The catalog id

string

Path

targetVersionId
required

Catalog version destination to be synchronized

string

2.1.3. Responses

HTTP Code Description Schema

200

The synchronization status

SyncJobData

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.1.4. Tags

  • catalog version synchronization

2.1.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.2. Creates a catalog synchronization.

POST /v1/catalogs/{catalogId}/versions/{sourceVersionId}/synchronizations/versions/{targetVersionId}

2.2.1. Description

Generates a brand new synchronization status. The status is generated based on a given catalog, source version and target version ids.

2.2.2. Parameters

Type Name Description Schema

Path

catalogId
required

The catalog id

string

Path

sourceVersionId
required

Catalog version used as a starting point in this synchronization

string

Path

targetVersionId
required

Catalog version destination to be synchronized

string

2.2.3. Responses

HTTP Code Description Schema

200

The synchronization status

SyncJobData

400

When one of the catalogs does not exist (CMSItemNotFoundException).

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.2.4. Consumes

  • application/json

2.2.5. Tags

  • catalog version synchronization

2.2.6. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.3. Gets synchronization status.

GET /v1/catalogs/{catalogId}/versions/{sourceVersionId}/synchronizations/versions/{targetVersionId}

2.3.1. Description

Retrieves the status of the last synchronization for a catalog. Information is retrieved based on a given catalog, source version and target version ids.

2.3.2. Parameters

Type Name Description Schema

Path

catalogId
required

The catalog id

string

Path

sourceVersionId
required

Catalog version used as a starting point in this synchronization

string

Path

targetVersionId
required

Catalog version destination to be synchronized

string

2.3.3. Responses

HTTP Code Description Schema

200

The synchronization status

SyncJobData

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.3.4. Tags

  • catalog version synchronization

2.3.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.4. Creates a catalog synchronization.

PUT /v1/catalogs/{catalogId}/versions/{sourceVersionId}/synchronizations/versions/{targetVersionId}
Caution

operation.deprecated

2.4.1. Description

Generates a brand new synchronization status. The status is generated based on a given catalog, source version and target version ids.

2.4.2. Parameters

Type Name Description Schema

Path

catalogId
required

The catalog id

string

Path

sourceVersionId
required

Catalog version used as a starting point in this synchronization

string

Path

targetVersionId
required

Catalog version destination to be synchronized

string

2.4.3. Responses

HTTP Code Description Schema

200

The synchronization status

SyncJobData

400

When one of the catalogs does not exist (CMSItemNotFoundException).

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.4.4. Consumes

  • application/json

2.4.5. Tags

  • catalog version synchronization

2.4.6. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.5. Uploads media.

POST /v1/catalogs/{catalogId}/versions/{versionId}/media

2.5.1. Description

Provides a new multipart media item for a given catalogId.

2.5.2. Parameters

Type Name Description Schema

Path

catalogId
required

The unique identifier of the catalog for which to link the new media.

string

Path

versionId
required

The specific catalog version to which the new media will be associated to.

string

Query

altText
required

The alternative text to use for the newly created media.

string

Query

code
required

The code to use for the newly created media.

string

Query

description
required

The description to use for the newly created media.

string

Query

folder
optional

The folder that media will be update to

string

Query

mime
optional

Internet Media Type for the media file.

string

FormData

file
required

The file representing the actual binary contents of the media to be created.

file

2.5.3. Responses

HTTP Code Description Schema

200

The newly created Media item

MediaData

201

Created

MediaData

400

When an error occurs parsing the MultipartFile (IOException) or when the media query parameters provided contain validation errors (WebserviceValidationException)

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.5.4. Consumes

  • multipart/form-data

2.5.5. Tags

  • catalog version media

2.5.6. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.6. Finds media container by partial to full code matching.

GET /v1/catalogs/{catalogId}/versions/{versionId}/mediacontainers

2.6.1. Description

Retrieves a list of available media containers using a free text search field.

2.6.2. Parameters

Type Name Description Schema

Path

catalogId
required

The catalog id

string

Path

versionId
required

The catalog version identifier

string

Query

currentPage
optional

The requested page number

string

Query

mask
optional

The string value on which media containers will be filtered

string

Query

pageSize
required

The maximum number of elements in the result list.

string

Query

sort
optional

The string field the results will be sorted with

string

2.6.3. Responses

HTTP Code Description Schema

200

Item which serves as a wrapper object that contains a list of MediaContainerData; never null

MediaContainerListWsDTO

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.6.4. Tags

  • media containers

2.6.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.7. Gets media container by code.

GET /v1/catalogs/{catalogId}/versions/{versionId}/mediacontainers/{code}

2.7.1. Description

Retrieves a specific media container that matches the given id.

2.7.2. Parameters

Type Name Description Schema

Path

catalogId
required

The catalog id

string

Path

code
required

The unique identifier of the media container

string

Path

versionId
required

The catalog version identifier

string

2.7.3. Responses

HTTP Code Description Schema

200

MediaContainerWsDTO

MediaContainerWsDTO

400

When the media container was not found (CMSItemNotFoundException) or when there was a problem during conversion (ConversionException).

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.7.4. Tags

  • media containers

2.7.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.8. Finds medias by partial to full code matching.

GET /v1/catalogs/{catalogId}/versions/{versionId}/medias

2.8.1. Description

Retrieves a list of available medias using a free text search field.

2.8.2. Parameters

Type Name Description Schema

Path

catalogId
required

The catalog id

string

Path

versionId
required

The catalog version identifier

string

Query

currentPage
optional

The requested page number

string

Query

mask
optional

The string value on which medias will be filtered

string

Query

mimeType
optional

The string value on which medias will be filtered

string

Query

pageSize
required

The maximum number of elements in the result list.

string

Query

sort
optional

The string field the results will be sorted with

string

2.8.3. Responses

HTTP Code Description Schema

200

Item which serves as a wrapper object that contains a list of MediaData; never null

MediaListData

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.8.4. Tags

  • medias

2.8.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.9. Gets type restrictions for content slot.

GET /v1/catalogs/{catalogId}/versions/{versionId}/pages/{pageId}/contentslots/{slotId}/typerestrictions

2.9.1. Description

Retrieves a list of available type restrictions for a given page id and content slot id.

2.9.2. Parameters

Type Name Description Schema

Path

catalogId
required

The catalog id

string

Path

pageId
required

The page identifier

string

Path

slotId
required

The slot identifier

string

Path

versionId
required

The catalog version identifier

string

2.9.3. Responses

HTTP Code Description Schema

200

DTO providing the mapping

ContentSlotTypeRestrictionsWsDTO

400

When the page/slot cannot be found (CMSItemNotFoundException)

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.9.4. Tags

  • page slot restrictions

2.9.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.10. Gets type restrictions for the provided content slots.

POST /v1/catalogs/{catalogId}/versions/{versionId}/pages/{pageId}/typerestrictions

2.10.1. Description

Retrieves a list of available type restrictions for the given slotId’s.

2.10.2. Parameters

Type Name Description Schema

Path

catalogId
required

The catalog id

string

Path

pageId
required

The page identifier

string

Path

versionId
required

The catalog version identifier

string

Body

data
required

Map representing the content slots for which to retrieve type restrictions

CMSContentSlotIdListWsDTO

2.10.3. Responses

HTTP Code Description Schema

200

DTO providing the mapping

ContentSlotTypeRestrictionsWsDTO

400

When slot(s) for slotId(s) cannot be found (CMSItemNotFoundException)

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.10.4. Consumes

  • application/json

2.10.5. Tags

  • page slot restrictions

2.10.6. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.11. Creates and start a new workflow.

POST /v1/catalogs/{catalogId}/versions/{versionId}/workflows

2.11.1. Description

Generates a workflow instance containing CmsItems. The workflow is automatically started upon generation.

2.11.2. Parameters

Type Name Description Schema

Path

catalogId
required

The id of the catalog

string

Path

versionId
required

The version of the catalog

string

Body

workflowInfo
required

The DTO object containing all the information about the workflow to create

CMSWorkflowWsDTO

2.11.3. Responses

HTTP Code Description Schema

201

The dto containing the workflow info.

CMSWorkflowWsDTO

400

If there is any validation error (WebserviceValidationException).

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.11.4. Consumes

  • application/json

2.11.5. Tags

  • workflows

2.11.6. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.12. Finds all workflows containing the given attachments.

GET /v1/catalogs/{catalogId}/versions/{versionId}/workflows

2.12.1. Description

Retrieves a list of available workflow instances that has the given CMSItem uuids as an attachment to the workflow.

2.12.2. Parameters

Type Name Description Schema

Path

catalogId
required

The id of the catalog

string

Path

versionId
required

The version of the catalog

string

Query

attachment
optional

The uuid of the CMSItem attached to the workflow

string

Query

currentPage
required

Catalog on which to search

string

Query

pageSize
required

Page size for paging

string

Query

sort
optional

The requested ordering for the search results.

string

Query

statuses
optional

The list of workflow statues. When none provided, the default statuses are set to RUNNING and PAUSED. This will return all active workflows.

< string > array(multi)

2.12.3. Responses

HTTP Code Description Schema

200

The list of dtos containing the workflow info. Never null.

CMSWorkflowWsDTO

400

If there is any validation error (WebserviceValidationException).

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.12.4. Tags

  • workflows

2.12.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.13. Gets a workflow item.

GET /v1/catalogs/{catalogId}/versions/{versionId}/workflows/{workflowCode}

2.13.1. Description

Retrieves a specific instance of the workflow for a given workflow code.

2.13.2. Parameters

Type Name Description Schema

Path

catalogId
required

The id of the catalog

string

Path

versionId
required

The version of the catalog

string

Path

workflowCode
required

The code of the workflow

string

2.13.3. Responses

HTTP Code Description Schema

200

The dto containing the workflow item.

CMSWorkflowWsDTO

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

404

When no workflow is found matching the given code (UnknownIdentifierException).

No Content

2.13.4. Tags

  • workflows

2.13.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.14. Updates an existing workflow.

PUT /v1/catalogs/{catalogId}/versions/{versionId}/workflows/{workflowCode}

2.14.1. Description

Provides a new workflow information for an existing workflow item.

2.14.2. Parameters

Type Name Description Schema

Path

catalogId
required

The id of the catalog

string

Path

versionId
required

The version of the catalog

string

Path

workflowCode
required

The code of the workflow

string

Body

dto
required

The DTO object containing all the information about the workflow to edit

CMSWorkflowWsDTO

2.14.3. Responses

HTTP Code Description Schema

200

The dto containing the workflow info.

CMSWorkflowWsDTO

400

If there is any validation error (WebserviceValidationException).

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

404

When no workflow is found matching the given code (UnknownIdentifierException).

No Content

2.14.4. Consumes

  • application/json

2.14.5. Tags

  • workflows

2.14.6. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.15. Gets a list of actions.

GET /v1/catalogs/{catalogId}/versions/{versionId}/workflows/{workflowCode}/actions

2.15.1. Description

Retrieves a list of available actions for a given workflow item, catalog and version ids.

2.15.2. Parameters

Type Name Description Schema

Path

catalogId
required

The id of the catalog

string

Path

versionId
required

The version of the catalog

string

Path

workflowCode
required

The code of the workflow

string

2.15.3. Responses

HTTP Code Description Schema

200

The dto containing the workflow items actions and decisions.

CMSWorkflowWsDTO

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

404

When no workflow is found matching the given code (UnknownIdentifierException).

No Content

2.15.4. Tags

  • workflow actions

2.15.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.16. Gets workflow action comments.

GET /v1/catalogs/{catalogId}/versions/{versionId}/workflows/{workflowCode}/actions/{actionCode}/comments

2.16.1. Description

Retrieves a list of available workflow action comments for a specific workflow item.

2.16.2. Parameters

Type Name Description Schema

Path

actionCode
required

The code of the workflow action

string

Path

catalogId
required

The id of the catalog

string

Path

versionId
required

The version of the catalog

string

Path

workflowCode
required

The code of the workflow

string

2.16.3. Responses

HTTP Code Description Schema

200

The dto containing the workflow action comments.

CMSCommentListWsDTO

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

404

When no workflow or workflow action is found matching the given code (UnknownIdentifierException).

No Content

2.16.4. Tags

  • workflow actions

2.16.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.17. Performs different operations on the workflow item.

POST /v1/catalogs/{catalogId}/versions/{versionId}/workflows/{workflowId}/operations

2.17.1. Description

Executes various actions, such as canceling a workflow, on the workflow item.

2.17.2. Parameters

Type Name Description Schema

Path

catalogId
required

The catalog identifier

string

Path

versionId
required

The catalog version identifier

string

Path

workflowId
required

The code of the workflow

string

Body

dto
required

The DTO object containing all the information about operation to be performed

CMSWorkflowOperationWsDTO

2.17.3. Responses

HTTP Code Description Schema

200

The workflow item.

CMSWorkflowWsDTO

400

When the payload does not have the 'operation' property. (IllegalArgumentException)

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

404

When the item has not been found (UnknownIdentifierException)

No Content

2.17.4. Consumes

  • application/json

2.17.5. Tags

  • workflow operations

2.17.6. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.18. Gets Workflow templates for catalog version.

GET /v1/catalogs/{catalogId}/versions/{versionId}/workflowtemplates

2.18.1. Description

Retrieves the list of available workflow templates for given catalogId and versionId.

2.18.2. Parameters

Type Name Description Schema

Path

catalogId
required

The catalog id

string

Path

versionId
required

The catalog version identifier

string

2.18.3. Responses

HTTP Code Description Schema

200

OK

WorkflowTemplateListWsDTO

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.18.4. Tags

  • workflow templates

2.18.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.19. Gets media by query.

GET /v1/media

2.19.1. Description

Gets a specific media item by named query.

2.19.2. Parameters

Type Name Description Schema

Query

currentPage
optional

The index of the requested page (index 0 means page 1).

string

Query

namedQuery
required

The name of the named query to use for the search.

string

Query

pageSize
required

The number of results per page.

string

Query

params
required

The list of the filtering parameters for the namedQuery. Ex:"catalogId:catalogIdValue,catalogVersion:catalogVersionValue,code:codeValue"

string

Query

sort
required

The requested ordering for the search results.

string

2.19.3. Responses

HTTP Code Description Schema

200

A single page of query results as a list of media or an empty list (WebserviceValidationException).

MediaListData

400

When the named query parameters provide contain validation errors

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.19.4. Tags

  • media

2.19.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.20. Gets a list of media by uuids.

POST /v1/media/uuids

2.20.1. Description

Retrieves a list of media items that match the given uuids by POSTing the uuids in the request body

2.20.2. Parameters

Type Name Description Schema

Body

uuids
required

List of uuids representing the media to retrieve

CMSItemUuidListWsDTO

2.20.3. Responses

HTTP Code Description Schema

200

A list of media data

MediaListData

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

404

When one of the media cannot be found (MediaNotFoundException).

No Content

2.20.4. Consumes

  • application/json

2.20.5. Tags

  • media

2.20.6. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.21. Gets media by uuid.

GET /v1/media/{uuid}

2.21.1. Description

Finds a specific media item that matches given uuid.

2.21.2. Parameters

Type Name Description Schema

Path

uuid
required

The universally unique identifier of the media item

string

2.21.3. Responses

HTTP Code Description Schema

200

Media data

MediaData

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

404

When no media is found matching the given uuid (MediaNotFoundException).

No Content

2.21.4. Tags

  • media

2.21.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.22. Finds media folders by partial to full qualifier matching.

GET /v1/mediafolders

2.22.1. Description

Retrieves a list of available media folders using a free text search field.

2.22.2. Parameters

Type Name Description Schema

Query

currentPage
optional

The requested page number

string

Query

mask
optional

The string value on which media folders will be filtered

string

Query

pageSize
required

The maximum number of elements in the result list.

string

Query

sort
optional

The string field the results will be sorted with

string

2.22.3. Responses

HTTP Code Description Schema

200

Item which serves as a wrapper object that contains a list of MediaFolderData; never null

MediaFolderListWsDTO

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.22.4. Tags

  • media folder

2.22.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.23. Finds page templates by page uuid.

GET /v1/pagetemplate

2.23.1. Description

Returns the PageTemplateData filtered on the given data passed as query string.

2.23.2. Parameters

Type Name Description Schema

Query

pageUuid
required

Uuid of a page

string

2.23.3. Responses

HTTP Code Description Schema

200

Get a page template

PageTemplateData

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.23.4. Tags

  • page templates

2.23.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.24. Finds all page types.

GET /v1/pagetypes

2.24.1. Description

Retrieves a list of available page types.

2.24.2. Responses

HTTP Code Description Schema

200

The list of page types

PageTypeListData

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.24.3. Tags

  • page types

2.24.4. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.25. Gets restriction types by page type.

GET /v1/pagetypesrestrictiontypes

2.25.1. Description

Retrieves a list of available restrictions types for a given page type.

2.25.2. Responses

HTTP Code Description Schema

200

DTO which serves as a wrapper object that contains a list of PageRestrictionListData, never null.

PageTypeRestrictionTypeListData

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.25.3. Tags

  • page type restrictions

2.25.4. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.26. Finds product categories by text.

GET /v1/productcatalogs/{catalogId}/versions/{versionId}/categories

2.26.1. Description

Retrieves a list of available product categories that match a free text search field.

2.26.2. Parameters

Type Name Description Schema

Path

catalogId
required

The catalog id

string

Path

versionId
required

The catalog version identifier

string

Query

currentPage
optional

The requested page number

string

Query

mask
optional

The string value on which products will be filtered

string

Query

pageSize
required

The maximum number of elements in the result list.

string

Query

sort
optional

The string field the results will be sorted with

string

Query

text
optional

The string value on which products will be filtered. Deprecated, use mask instead!

string

2.26.3. Responses

HTTP Code Description Schema

200

DTO which serves as a wrapper object that contains a list of CategoryData, never null.

CategoryDataListWsDTO

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.26.4. Tags

  • product categories

2.26.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.27. Gets category by code.

GET /v1/productcatalogs/{catalogId}/versions/{versionId}/categories/{code}

2.27.1. Description

Finds a specific category that matches given product category code.

2.27.2. Parameters

Type Name Description Schema

Path

catalogId
required

The catalog id

string

Path

code
required

Category code

string

Path

versionId
required

The catalog version identifier

string

2.27.3. Responses

HTTP Code Description Schema

200

CategoryData

CategoryWsDTO

400

When the item has not been found (CMSItemNotFoundException) or when there was problem during conversion (ConversionException).

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.27.4. Tags

  • product categories

2.27.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.28. Gets products by text.

GET /v1/productcatalogs/{catalogId}/versions/{versionId}/products

2.28.1. Description

Finds a list of available products that match a free text search field.

2.28.2. Parameters

Type Name Description Schema

Path

catalogId
required

The catalog name

string

Path

versionId
required

The catalog version identifier

string

Query

currentPage
optional

The requested page number

string

Query

mask
optional

The string value on which products will be filtered

string

Query

pageSize
required

The maximum number of elements in the result list.

string

Query

sort
optional

The string field the results will be sorted with

string

Query

text
optional

The string value on which products will be filtered. Deprecated, use mask instead!

string

2.28.3. Responses

HTTP Code Description Schema

200

DTO which serves as a wrapper object that contains a list of ProductData, never null.

ProductDataListWsDTO

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.28.4. Tags

  • products

2.28.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.29. Gets product by code.

GET /v1/productcatalogs/{catalogId}/versions/{versionId}/products/{code}

2.29.1. Description

Retrieves a specific product item that matches given product code.

2.29.2. Parameters

Type Name Description Schema

Path

catalogId
required

The catalog name

string

Path

code
required

Product code

string

Path

versionId
required

The catalog version identifier

string

2.29.3. Responses

HTTP Code Description Schema

200

ProductData

ProductWsDTO

400

When the item has not been found (CMSItemNotFoundException) or when there was problem during conversion (ConversionException).

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.29.4. Tags

  • products

2.29.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.30. Finds all restriction types.

GET /v1/restrictiontypes

2.30.1. Description

Retrieves a list of available restriction types.

2.30.2. Responses

HTTP Code Description Schema

200

List of restriction types

RestrictionTypeListData

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.30.3. Tags

  • restriction types

2.30.4. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.31. Gets all sites.

GET /v1/sites

2.31.1. Description

Retrieves a list of available sites.

2.31.2. Responses

HTTP Code Description Schema

200

A list of all sites configured, never null.

SiteListData

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.31.3. Tags

  • sites

2.31.4. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.32. Gets sites for catalogs by ids.

POST /v1/sites/catalogs

2.32.1. Description

Retrieves a list of available sites that match given list of catalog ids by posting the catalogIds in the request body.

2.32.2. Parameters

Type Name Description Schema

Body

catalogDataListInfo
required

List of catalog identifiers

CatalogDataListWsDTO

2.32.3. Responses

HTTP Code Description Schema

200

List of all sites for the given list of catalog ids, never null

SiteListData

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.32.4. Consumes

  • application/json

2.32.5. Tags

  • sites

2.32.6. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.33. Creates navigation node.

POST /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/navigations
Caution

operation.deprecated

2.33.1. Description

Adds a new navigation node for a given catalog id.

2.33.2. Parameters

Type Name Description Schema

Path

catalogId
required

The catalog name

string

Path

siteId
required

The site identifier

string

Path

versionId
required

The catalog version identifier

string

Body

navigationNode
required

The navigation node data to be added.

NavigationNodeData

2.33.3. Responses

HTTP Code Description Schema

200

The navigation node data created.

NavigationNodeData

201

Created

NavigationNodeData

400

If the parentUid does not exist (CMSItemNotFoundException) or if there is any validation error (WebserviceValidationException)

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.33.4. Consumes

  • application/json

2.33.5. Tags

  • navigation

2.33.6. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.34. Finds all navigation nodes.

GET /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/navigations

2.34.1. Description

Retrieves a list of available navigation nodes that match provided parentUid.

2.34.2. Parameters

Type Name Description Schema

Path

catalogId
required

The catalog name

string

Path

siteId
required

The site identifier

string

Path

versionId
required

The catalog version identifier

string

Query

parentUid
required

The parent navigation node Uid

string

2.34.3. Responses

HTTP Code Description Schema

200

List of navigation nodes

NavigationNodeListData

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.34.4. Tags

  • navigation

2.34.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.35. Finds navigation node.

GET /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/navigations/{uid}
Caution

operation.deprecated

2.35.1. Description

Retrieves a specific navigation node item. Information is retrieved based on a given site and catalog ids.

2.35.2. Parameters

Type Name Description Schema

Path

catalogId
required

The catalog name

string

Path

siteId
required

The site identifier

string

Path

uid
required

The navigation node’s unique identifier

string

Path

versionId
required

The catalog version identifier

string

2.35.3. Responses

HTTP Code Description Schema

200

The navigation node identified by uid.

NavigationNodeData

400

When the Navigation Node has not been found (CMSItemNotFoundException).

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.35.4. Tags

  • navigation

2.35.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.36. Updates navigation node.

PUT /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/navigations/{uid}
Caution

operation.deprecated

2.36.1. Description

Provides new information to the navigation node for a given.navigation node uid. Deprecated since 1811, please use CMSItemController controller instead.

2.36.2. Parameters

Type Name Description Schema

Path

catalogId
required

The catalog name

string

Path

siteId
required

The site identifier

string

Path

uid
required

The navigation node uid to be updated.

string

Path

versionId
required

The catalog version identifier

string

Body

navigationNode
required

The navigation node data

NavigationNodeData

2.36.3. Responses

HTTP Code Description Schema

200

OK

NavigationNodeData

400

When the Navigation Node has not been found (CMSItemNotFoundException) or if there is any validation error (WebserviceValidationException).

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.36.4. Consumes

  • application/json

2.36.5. Tags

  • navigation

2.36.6. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.37. Deletes navigation node.

DELETE /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/navigations/{uid}
Caution

operation.deprecated

2.37.1. Description

Removes a specific instance of the navigation node that matches a given site id. Deprecated since 1811, please use DELETE /v1/sites/{siteId}/cmsitems/{uuid} instead.

2.37.2. Parameters

Type Name Description Schema

Path

catalogId
required

The catalog name

string

Path

siteId
required

The site identifier

string

Path

uid
required

The navigation node’s uid.

string

Path

versionId
required

The catalog version identifier

string

2.37.3. Responses

HTTP Code Description Schema

204

No Content

No Content

400

When the Navigation Node has not been found (CMSItemNotFoundException).

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.37.4. Tags

  • navigation

2.37.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.38. Finds pages by ids.

GET /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pages
Caution

operation.deprecated

2.38.1. Description

Finds specific pages for a given site, catalog and version ids. Deprecated since 6.6, please use GET /v1/sites/{siteId}/cmsitems{?uuids} instead.

2.38.2. Parameters

Type Name Description Schema

Path

catalogId
required

The catalog id

string

Path

siteId
required

The site identifier

string

Path

versionId
required

The catalog version identifier

string

Query

uids
required

List of identifier of the pages that we are looking for

< string > array(multi)

2.38.3. Responses

HTTP Code Description Schema

200

List of AbstractPageData

PageListData

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.38.4. Tags

  • pages

2.38.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.39. Gets page by uid.

GET /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pages/{pageId}
Caution

operation.deprecated

2.39.1. Description

Retrieves a specific page instance that matches given page uid. Deprecated since 6.6, please use GET /v1/sites/{siteId}/cmsitems/{uuid} instead.

2.39.2. Parameters

Type Name Description Schema

Path

catalogId
required

The catalog id

string

Path

pageId
required

Page identifier

string

Path

siteId
required

The site identifier

string

Path

versionId
required

The catalog version identifier

string

2.39.3. Responses

HTTP Code Description Schema

200

Page data object

AbstractPageData

400

When the page cannot be found (CMSItemNotFoundException).

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.39.4. Tags

  • pages

2.39.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.40. Finds fallback pages.

GET /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pages/{pageId}/fallbacks

2.40.1. Description

Retrieves a list of available fallback pages for a given page.

2.40.2. Parameters

Type Name Description Schema

Path

catalogId
required

The catalog name

string

Path

pageId
required

The page identifier

string

Path

siteId
required

The site identifier

string

Path

versionId
required

The catalog version identifier

string

2.40.3. Responses

HTTP Code Description Schema

200

All fallback pages uid for a given page; empty if the given page is already a fallback page; never null

UidListData

400

When the pageId is invalid (CMSItemNotFoundException).

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.40.4. Tags

  • pages

2.40.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.41. Finds variation pages.

GET /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pages/{pageId}/variations

2.41.1. Description

Retrieves a list of available variation pages uid for a given page.

2.41.2. Parameters

Type Name Description Schema

Path

catalogId
required

The catalog name

string

Path

pageId
required

The page identifier

string

Path

siteId
required

The site identifier

string

Path

versionId
required

The catalog version identifier

string

2.41.3. Responses

HTTP Code Description Schema

200

All variation pages uid for a given page; empty if the given page is already a variation page; never null.

UidListData

400

When the pageId is invalid (CMSItemNotFoundException).

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.41.4. Tags

  • pages

2.41.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.42. Gets content slots by page.

GET /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pagescontentslots

2.42.1. Description

Retrieves a list of available content slots defined on the page specified by the page id.

2.42.2. Parameters

Type Name Description Schema

Path

catalogId
required

The catalog id

string

Path

siteId
required

The site identifier

string

Path

versionId
required

The catalog version identifier

string

Query

pageId
required

Identifier of the page

string

2.42.3. Responses

HTTP Code Description Schema

200

DTO which serves as a wrapper object that contains a list of PageContentSlotListData, never null.

PageContentSlotListData

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.42.4. Tags

  • page slots

2.42.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.43. Adds component to slot.

POST /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pagescontentslotscomponents

2.43.1. Description

Inserts a new content component item to a slot for a given catalog and site ids.

2.43.2. Parameters

Type Name Description Schema

Path

catalogId
required

The catalog id

string

Path

siteId
required

The site identifier

string

Path

versionId
required

The catalog version identifier

string

Body

pageContentSlotComponentData
required

PageContentSlotComponentData

PageContentSlotComponentData

2.43.3. Responses

HTTP Code Description Schema

200

PageContentSlotComponentData

PageContentSlotComponentData

201

Created

PageContentSlotComponentData

400

When component item does not exist (CMSItemNotFoundException) or when validation errors are found (WebserviceValidationException).

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.43.4. Consumes

  • application/json

2.43.5. Tags

  • page slot components

2.43.6. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.44. Gets components by page.

GET /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pagescontentslotscomponents

2.44.1. Description

Retrieves a list of available components for a given page.

2.44.2. Parameters

Type Name Description Schema

Path

catalogId
required

The catalog id

string

Path

siteId
required

The site identifier

string

Path

versionId
required

The catalog version identifier

string

Query

pageId
required

Identifier of the page

string

2.44.3. Responses

HTTP Code Description Schema

200

List of components defined for a given page

PageContentSlotComponentListData

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.44.4. Tags

  • page slot components

2.44.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.45. Removes component.

DELETE /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pagescontentslotscomponents/contentslots/{slotId}/components/{componentId}

2.45.1. Description

Deletes a specific component item from a content slot for a given catalog and site ids.

2.45.2. Parameters

Type Name Description Schema

Path

catalogId
required

The catalog id

string

Path

componentId
required

Component identifier of the component to be removed

string

Path

siteId
required

The site identifier

string

Path

slotId
required

Content slot identifier containing the component to be removed

string

Path

versionId
required

The catalog version identifier

string

2.45.3. Responses

HTTP Code Description Schema

204

No Content

No Content

400

When the component or slot cannot be found (CMSItemNotFoundException) or when the component slot does not contain the component (ComponentNotFoundInSlotException)

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.45.4. Tags

  • page slot components

2.45.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.46. Moves component.

PUT /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pagescontentslotscomponents/pages/{pageId}/contentslots/{slotId}/components/{componentId}

2.46.1. Description

Relocates a specific component instance to a different content slot by changing its position within the content slot on a given page.

2.46.2. Parameters

Type Name Description Schema

Path

catalogId
required

The catalog id

string

Path

componentId
required

Component identifier

string

Path

pageId
required

Page identifier

string

Path

siteId
required

The site identifier

string

Path

slotId
required

Content slot identifier

string

Path

versionId
required

The catalog version identifier

string

Body

pageContentSlotComponent
required

PageContentSlotComponentData

PageContentSlotComponentData

2.46.3. Responses

HTTP Code Description Schema

200

The updated PageContentSlotComponentData

PageContentSlotComponentData

400

If it cannot find the content item (CMSItemNotFoundException) or if there is any validation error (WebserviceValidationException) or if component is not allowed in slot (ComponentNotAllowedInSlotException).

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.46.4. Consumes

  • application/json

2.46.5. Tags

  • page slot components

2.46.6. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.47. Gets containers by page.

GET /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pagescontentslotscontainers

2.47.1. Description

Fetches a list of available containers on a given page.

2.47.2. Parameters

Type Name Description Schema

Path

catalogId
required

The catalog id

string

Path

siteId
required

The site identifier

string

Path

versionId
required

The catalog version identifier

string

Query

pageId
required

The page identifier

string

2.47.3. Responses

HTTP Code Description Schema

200

The list of page content slot containers

PageContentSlotContainerListWsDTO

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.47.4. Tags

  • page slot containers

2.47.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.48. Gets restrictions by page.

GET /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pagesrestrictions
Caution

operation.deprecated

2.48.1. Description

Retrieves all restrictions that belong to the page for the given page id.

2.48.2. Parameters

Type Name Description Schema

Path

catalogId
required

The catalog name

string

Path

siteId
required

The site identifier

string

Path

versionId
required

The catalog version identifier

string

Query

pageId
required

Identifier of the page

string

2.48.3. Responses

HTTP Code Description Schema

200

DTO which serves as a wrapper object that contains a list of PageRestrictionListData, never null

PageRestrictionListData

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.48.4. Tags

  • page restrictions

2.48.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.49. Updates page restrictions.

PUT /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pagesrestrictions/pages/{pageId}
Caution

operation.deprecated

2.49.1. Description

Replaces an existing list of page-restriction relations with a new relations for the given page id.

2.49.2. Parameters

Type Name Description Schema

Path

catalogId
required

The catalog name

string

Path

pageId
required

Page identifier

string

Path

siteId
required

The site identifier

string

Path

versionId
required

The catalog version identifier

string

Body

pageRestrictionListData
required

List of PageRestrictionData

PageRestrictionListData

2.49.3. Responses

HTTP Code Description Schema

200

DTO which serves as a wrapper object that contains the updated list of PageRestrictionListData, never null.

PageRestrictionListData

400

If it cannot find the component (CMSItemNotFoundException) or if there is any validation error (WebserviceValidationException).

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.49.4. Consumes

  • application/json

2.49.5. Tags

  • page restrictions

2.49.6. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.50. Finds page templates by page type.

GET /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pagetemplates

2.50.1. Description

Returns a holder of a collection of PageTemplateData filtered on the given data passed as query string.

2.50.2. Parameters

Type Name Description Schema

Path

catalogId
required

The catalog id

string

Path

siteId
required

The site identifier

string

Path

versionId
required

The catalog version identifier

string

Query

active
optional

When set to TRUE, filter the results for active templates

string

Query

pageTypeCode
required

Item type of a page

string

2.50.3. Responses

HTTP Code Description Schema

200

List of page templates

PageTemplateListData

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.50.4. Tags

  • page templates

2.50.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.51. Performs synchronization.

POST /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/synchronizations/versions/{targetCatalogVersion}

2.51.1. Description

Executes status synchronization on a list of ItemModel identifier by their ItemSynchronization properties.

2.51.2. Parameters

Type Name Description Schema

Path

catalogId
required

The source catalog version from a synchronization perspective

string

Path

siteId
required

The site identifier

string

Path

targetCatalogVersion
required

The SynchronizationWsDTO containing the list of requested synchronizations

string

Path

versionId
required

The target catalog version from a synchronization perspective

string

Body

synchronizationWsDTO
required

The catalog id

SynchronizationWsDTO

2.51.3. Responses

HTTP Code Description Schema

204

No Content

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.51.4. Consumes

  • application/json

2.51.5. Tags

  • item synchronization

2.51.6. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.52. Gets component synchronization status.

GET /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/synchronizations/versions/{targetCatalogVersion}/items/{componentId}

2.52.1. Description

Builds the synchronization status of a AbstractCMSComponentModel component.

2.52.2. Parameters

Type Name Description Schema

Path

catalogId
required

The catalog id

string

Path

componentId
required

The uid of the component from which to retrieve the synchronization status

string

Path

siteId
required

The site identifier

string

Path

targetCatalogVersion
required

The target catalog version from a synchronization perspective

string

Path

versionId
required

The source catalog version from a synchronization perspective

string

2.52.3. Responses

HTTP Code Description Schema

200

DTO containing the complex synchronization status of the AbstractCMSComponentModel page

SyncItemStatusWsDTO

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.52.4. Tags

  • item synchronization

2.52.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.53. Gets page synchronization status.

GET /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/synchronizations/versions/{targetCatalogVersion}/pages/{pageId}

2.53.1. Description

Builds the synchronization status of a AbstractPageModel page.

2.53.2. Parameters

Type Name Description Schema

Path

catalogId
required

The catalog id

string

Path

pageId
required

The uid of the page from which to retrieve the synchronization status

string

Path

siteId
required

The site identifier

string

Path

targetCatalogVersion
required

The target catalog version from a synchronization perspective

string

Path

versionId
required

The source catalog version from a synchronization perspective

string

2.53.3. Responses

HTTP Code Description Schema

200

DTO containing the complex synchronization status of the AbstractPageModel page

SyncItemStatusWsDTO

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.53.4. Tags

  • item synchronization

2.53.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.54. Gets slot synchronization status.

GET /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/synchronizations/versions/{targetCatalogVersion}/slots/{slotId}

2.54.1. Description

Builds the synchronization status of a ContentSlotModel slot.

2.54.2. Parameters

Type Name Description Schema

Path

catalogId
required

The catalog id

string

Path

siteId
required

The site identifier

string

Path

slotId
required

The uid of the slot from which to retrieve the synchronization status

string

Path

targetCatalogVersion
required

The target catalog version from a synchronization perspective

string

Path

versionId
required

The source catalog version from a synchronization perspective

string

2.54.3. Responses

HTTP Code Description Schema

200

DTO containing the complex synchronization status of the ContentSlotModel page

SyncItemStatusWsDTO

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.54.4. Tags

  • item synchronization

2.54.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.55. Gets writable content catalog versions.

GET /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/targets

2.55.1. Description

Retrieves a target content catalog versions by mode. For mode = "cloneableTo" returns the list of content catalog versions (which are used as targets for page clone operations) for a given catalog or all child catalogs.

2.55.2. Parameters

Type Name Description Schema

Path

catalogId
required

The catalog id

string

Path

siteId
required

The site identifier

string

Path

versionId
required

The version of the catalog

string

Query

mode
required

The mode to filter the result

string

2.55.3. Responses

HTTP Code Description Schema

200

The list of content catalog versions.

CatalogVersionListData

400

When the catalog and/or version specified is not valid (CMSItemNotFoundException).

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.55.4. Tags

  • catalog versions

2.55.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.56. Validates CMS Item for creation.

POST /v1/sites/{siteId}/cmsitems

2.56.1. Description

Performs validation on the specific instance of the CMS Item in a Dry Run mode.

2.56.2. Parameters

Type Name Description Schema Default

Path

siteId
required

The site identifier

string

Query

dryRun
required

When set to TRUE, the request is executed in Dry Run mode

enum (true)

"true"

Body

inputMap
required

Map representing the CMS item to create in Dry Run mode

object

2.56.3. Responses

HTTP Code Description Schema

200

The multi-level Map representing the validated CMS Item.

object

400

If it cannot find the content item (CMSItemNotFoundException) or if there is any validation error (WebserviceValidationException).

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.56.4. Consumes

  • application/json

2.56.5. Tags

  • cmsitems

2.56.6. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.57. Finds CMS items.

GET /v1/sites/{siteId}/cmsitems

2.57.1. Description

Retrieves a list of available CMS items that match pages search.

2.57.2. Parameters

Type Name Description Schema

Path

siteId
required

The site identifier

string

Query

catalogId
required

The catalog id

string

Query

catalogVersion
required

CatalogVersion on which to search

string

Query

currentPage
required

The current result page requested

string

Query

fields
optional

Response configuration (list of fields, which should be returned in response

string

Query

itemSearchParams
optional

Search on additional fields using a comma separated list of field name and value pairs which are separated by a colon. Exact matches only. You can use {@code null} as value.

string

Query

mask
optional

Search mask applied to the UID and NAME fields, Uses partial matching

string

Query

pageSize
required

Page size for paging

string

Query

sort
optional

The requested ordering for the search results.

string

Query

typeCode
optional

TypeCode filter. Exact matches only. Either typeCode or typeCodes can be set.

string

Query

typeCodes
optional

Search using a comma separated list of type code. Either typeCode or typeCodes can be set.

string

2.57.3. Responses

HTTP Code Description Schema

200

A map of paging info and results. Results are in the form of Map<String, Object>, each representing a CMSItem. Never null.

object

400

If the required fields are missing (WebserviceValidationException).

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.57.4. Tags

  • cmsitems

2.57.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.58. Finds cms items by uuids in body.

POST /v1/sites/{siteId}/cmsitems/uuids

2.58.1. Description

Retrieves a list of available CMSItems matching the given uuids by POSTing the uuids in the request body.

2.58.2. Parameters

Type Name Description Schema

Path

siteId
required

The site identifier

string

Body

dto
required

CMSItemUuidListWsDTO

CMSItemUuidListWsDTO

2.58.3. Responses

HTTP Code Description Schema

200

A map list of elements in the form of Map<String, Object>, each representing a CMSItem.

object

400

If it cannot find one of the items (CMSItemNotFoundException).

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.58.4. Consumes

  • application/json

2.58.5. Tags

  • cmsitems

2.58.6. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.59. Creates a CMSVersion for an item.

POST /v1/sites/{siteId}/cmsitems/{itemUUID}/versions

2.59.1. Description

Generates a new instance of the CMSVersion for the item identified by its itemUUID.

2.59.2. Parameters

Type Name Description Schema

Path

itemUUID
required

The uuid of the item

string

Path

siteId
required

The site identifier

string

Body

dto
required

The DTO object containing the label and description

CMSVersionWsDTO

2.59.3. Responses

HTTP Code Description Schema

201

The dto containing version info.

CMSVersionWsDTO

400

If there is any validation error (WebserviceValidationException).

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.59.4. Consumes

  • application/json

2.59.5. Tags

  • versions

2.59.6. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.60. Gets all versions for an item filtered by a mask.

GET /v1/sites/{siteId}/cmsitems/{itemUUID}/versions

2.60.1. Description

Retrieves a list of available CMSVersions by a search mask for the item identified by its itemUUID.

2.60.2. Parameters

Type Name Description Schema

Path

itemUUID
required

The uuid of the item

string

Path

siteId
required

The site identifier

string

Query

currentPage
optional

The current result page requested

string

Query

mask
optional

Search mask applied to the LABEL field only. Uses partial matching.

string

Query

pageSize
optional

Page size for paging

string

2.60.3. Responses

HTTP Code Description Schema

200

DTO which serves as a wrapper object that contains a list of CMSVersionWsDTO; never null

CMSVersionListWsDTO

400

When the item has not been found (CMSItemNotFoundException)

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.60.4. Tags

  • versions

2.60.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.61. Gets a specific version for an item.

GET /v1/sites/{siteId}/cmsitems/{itemUUID}/versions/{versionId}

2.61.1. Description

Retrieves a CMSVersion identified by its uid and for the item identified by its itemUUID.

2.61.2. Parameters

Type Name Description Schema

Path

itemUUID
required

The uuid of the item

string

Path

siteId
required

The site identifier

string

Path

versionId
required

The uid of the cms version.

string

2.61.3. Responses

HTTP Code Description Schema

200

The dto containing version info.

CMSVersionWsDTO

400

When the version has not been found (CMSVersionNotFoundException)

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.61.4. Tags

  • versions

2.61.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.62. Updates a CMSVersion for an item.

PUT /v1/sites/{siteId}/cmsitems/{itemUUID}/versions/{versionId}

2.62.1. Description

Replaces an existing CMSVersion identified by its uid for the item identified by its itemUUID.

2.62.2. Parameters

Type Name Description Schema

Path

itemUUID
required

The uuid of the item

string

Path

siteId
required

The site identifier

string

Path

versionId
required

The uid of the cms version.

string

Body

dto
required

The DTO object containing the label and description

CMSVersionWsDTO

2.62.3. Responses

HTTP Code Description Schema

200

The dto containing version info.

CMSVersionWsDTO

400

If there is any validation error (WebserviceValidationException).

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.62.4. Consumes

  • application/json

2.62.5. Tags

  • versions

2.62.6. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.63. Deletes a CMSVersion for an item.

DELETE /v1/sites/{siteId}/cmsitems/{itemUUID}/versions/{versionId}

2.63.1. Description

Removes a specific instance of the CMSVersion identified by its uid and for the item identified by its itemUUID.

2.63.2. Parameters

Type Name Description Schema

Path

itemUUID
required

The uuid of the item

string

Path

siteId
required

The site identifier

string

Path

versionId
required

The uid of the cms version.

string

2.63.3. Responses

HTTP Code Description Schema

204

No Content

No Content

400

If there is any validation error (WebserviceValidationException).

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.63.4. Tags

  • versions

2.63.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.64. Rolls back an item to a specific CMSVersion.

POST /v1/sites/{siteId}/cmsitems/{itemUUID}/versions/{versionId}/rollbacks

2.64.1. Description

Sets a CMSversion of the item identified by its itemUUID to a previously saved CMSVersion.

2.64.2. Parameters

Type Name Description Schema

Path

itemUUID
required

The uuid of the item

string

Path

siteId
required

The site identifier

string

Path

versionId
required

The uid of the cms version.

string

2.64.3. Responses

HTTP Code Description Schema

204

No Content

No Content

400

If there is any validation error (WebserviceValidationException).

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.64.4. Consumes

  • application/json

2.64.5. Tags

  • versions

2.64.6. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.65. Gets CMS Item by uuid.

GET /v1/sites/{siteId}/cmsitems/{uuid}

2.65.1. Description

Retrieves an item that matches the given item uuid (Universally Unique Identifier).

2.65.2. Parameters

Type Name Description Schema

Path

siteId
required

The site identifier

string

Path

uuid
required

The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.

string

Query

versionId
optional

The uid of the cms version.

string

2.65.3. Responses

HTTP Code Description Schema

200

Map<String, Object> representation of the CMS Item object.

object

400

If there is any validation error (WebserviceValidationException).

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.65.4. Tags

  • cmsitems

2.65.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.66. Updates CMS Item.

PUT /v1/sites/{siteId}/cmsitems/{uuid}

2.66.1. Description

Updates a CMS Item for a given site id.

2.66.2. Parameters

Type Name Description Schema

Path

siteId
required

The site identifier

string

Path

uuid
required

Unique Identifier of a CMS Item

string

Body

inputMap
required

Map representing the CMS item to update

object

2.66.3. Responses

HTTP Code Description Schema

200

The multi-level Map representing the updated CMS Item.

object

400

If it cannot find the content item (CMSItemNotFoundException) or if there is any validation error (WebserviceValidationException).

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.66.4. Consumes

  • application/json

2.66.5. Tags

  • cmsitems

2.66.6. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.67. Removes CMS Item.

DELETE /v1/sites/{siteId}/cmsitems/{uuid}

2.67.1. Description

Deletes a specific instance of the content item (CMSItem) from the system by uuid.

2.67.2. Parameters

Type Name Description Schema

Path

siteId
required

The site identifier

string

Path

uuid
required

The universally unique identifier of the item

string

2.67.3. Responses

HTTP Code Description Schema

204

No Content

No Content

400

If it cannot find the content item (CMSItemNotFoundException).

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.67.4. Tags

  • cmsitems

2.67.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.68. Gets languages.

GET /v1/sites/{siteId}/languages

2.68.1. Description

Retrieves a list of available languages supported by a storefront.

2.68.2. Parameters

Type Name Description Schema

Path

siteId
required

The site identifier

string

2.68.3. Responses

HTTP Code Description Schema

200

List of languages.

LanguageListData

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.68.4. Tags

  • languages

2.68.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.69. Gets component type by code and mode.

GET /v1/types

2.69.1. Description

Retrieves a specific instance of the CMS component type by code and mode.

2.69.2. Parameters

Type Name Description Schema Default

Query

code
required

Component type code

string

Query

mode
required

The mode of the structure type

string

Query

readOnly
optional

Read only mode for attributes

boolean

"false"

2.69.3. Responses

HTTP Code Description Schema

200

DTO which serves as a wrapper object that contains a ComponentTypeData DTO; or and empty list if the type and mode are not found.

ComponentTypeListData

400

When the code provided does not match any existing type (ComponentTypeNotFoundException).

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.69.4. Tags

  • types

2.69.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.70. Gets component type by code.

GET /v1/types/{code}

2.70.1. Description

Retrieves a specific instance of the CMS component type for a given code.

2.70.2. Parameters

Type Name Description Schema Default

Path

code
required

Component type code

string

Query

readOnly
optional

Read only mode for attributes

boolean

"false"

2.70.3. Responses

HTTP Code Description Schema

200

DTO which serves as a wrapper object that contains a ComponentTypeData DTO

ComponentTypeData

400

When the code provided does not match any existing type(ComponentTypeNotFoundException).

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.70.4. Tags

  • types

2.70.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.71. Finds user group by text.

GET /v1/usergroups

2.71.1. Description

Retrieves a list of available user groups using a free text search field.

2.71.2. Parameters

Type Name Description Schema

Query

currentPage
optional

The requested page number

string

Query

mask
optional

The string value on which products will be filtered

string

Query

pageSize
required

The maximum number of elements in the result list.

string

Query

sort
optional

The string field the results will be sorted with

string

2.71.3. Responses

HTTP Code Description Schema

200

DTO which serves as a wrapper object that contains a list of UserGroupData; never null

UserGroupListWsDTO

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.71.4. Tags

  • user groups

2.71.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.72. Gets user group by id.

GET /v1/usergroups/{userGroupId}

2.72.1. Description

Retrieves a specific user group instance that matches the given id.

2.72.2. Parameters

Type Name Description Schema

Path

userGroupId
required

The unique identifier of the user group

string

2.72.3. Responses

HTTP Code Description Schema

200

UserGroupWsDTO

UserGroupWsDTO

400

When the user group was not found (CMSItemNotFoundException) or when there was problem during conversion (ConversionException).

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.72.4. Tags

  • user groups

2.72.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

2.73. Gets user by id.

GET /v1/users/{userId}

2.73.1. Description

Retrieves a specific user instance that matches given id.

2.73.2. Parameters

Type Name Description Schema

Path

userId
required

The unique identifier of the user

string

2.73.3. Responses

HTTP Code Description Schema

200

UserDataInfo

UserDataWsDTO

400

When the user was not found (CMSItemNotFoundException) or when there was a problem during conversion (ConversionException).

No Content

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

2.73.4. Tags

  • users

2.73.5. Security

Type Name

oauth2

oauth2_password

oauth2

oauth2_client_credentials

3. Definitions

3.1. AbstractCMSComponentData

Name Schema

catalogVersion
optional

string

modifiedtime
optional

string (date-time)

name
optional

string

otherProperties
optional

object

typeCode
optional

string

uid
optional

string

uuid
optional

string

3.2. AbstractPageData

Specifies properties of the page.

Name Description Schema

creationtime
optional

Example : "yyyy-MM-dd HH:mm:ss+0000"

string (date-time)

defaultPage
optional

Example : true

boolean

modifiedtime
optional

Example : "yyyy-MM-dd HH:mm:ss+0000"

string (date-time)

name
optional

Example : "homepage"

string

onlyOneRestrictionMustApply
optional

Example : false

boolean

pk
optional

Example : "8796093056052"

string

template
optional

Example : "LandingPageTemplate"

string

title
optional

Example : { "EN" : "Homepage", "DE" : "Startseite" }

< string, string > map

typeCode
optional

Example : "ContentPage"

string

uid
optional

string

uuid
optional

string

3.3. CMSCommentListWsDTO

Specifies a list of available CMS comments.

Name Schema

comments
optional

< CMSCommentWsDTO > array

pagination
optional

pagination

3.4. CMSCommentWsDTO

Specifies properties of the CMS comment.

Name Description Schema

authorName
optional

string

code
optional

string

createdAgoInMillis
optional

Example : 128334524

integer (int64)

creationtime
optional

Example : "yyyy-MM-dd HH:mm:ss+0000"

string (date-time)

decisionCode
optional

string

decisionName
optional

string

originalActionCode
optional

string

text
optional

string

3.5. CMSContentSlotIdListWsDTO

Specifies a list of slot ids.

Name Description Schema

slotIds
optional

Example : [ "Section1Slot-Homepage", "Section2Footer-Homepage" ]

< string > array

3.6. CMSItemUuidListWsDTO

Specifies a list of available uuid for CMS item.

Name Schema

fields
optional

string

uuids
optional

< string > array

3.7. CMSVersionListWsDTO

Specifies a list of available CMS versions.

Name Description Schema

pagination
optional

pagination

results
optional

Example : [ { "creationtime" : "2019-12-23T19:35:35+0000", "itemUUID" : "eyJpd", "label" : "newVersion", "uid" : "00000000" } ]

< CMSVersionWsDTO > array

3.8. CMSVersionWsDTO

Specifies properties of the CMS version.

Name Description Schema

creationtime
optional

Example : "yyyy-MM-dd HH:mm:ss+0000"

string (date-time)

description
optional

string

itemUUID
optional

string

label
optional

Example : "2.0"

string

uid
optional

Example : "00000000"

string

3.9. CMSWorkflowAction

Specifies properties of the CMS workflow action.

Name Description Schema

actionType
optional

Example : "START"

string

code
optional

Example : "0000000C"

string

decisions
optional

Example : [ { "code" : "PageTranslationSendDEForReview", "description" : { "en" : "Decision for sending DE language for review", "fr" : "Décision d’envoyer la langue DE pour examen" }, "name" : { "en" : "Send for Review", "fr" : "Envoyer pour examen" } } ]

< CMSWorkflowDecision > array

description
optional

Example : { "en" : "Decision for approving content", "fr" : "D�cision d’approbation du contenu" }

< string, string > map

isCurrentUserParticipant
optional

Example : true

boolean

name
optional

Example : { "en" : "Approve", "fr" : "Approuver" }

< string, string > map

startedAgoInMillis
optional

Example : 5283

integer (int64)

status
optional

Example : "IN_PROGRESS"

string

3.10. CMSWorkflowDecision

Specifies properties of the CMS workflow decision.

Name Description Schema

code
optional

Example : "PageTranslationSendDEForReview"

string

description
optional

Example : { "en" : "Decision for sending DE language for review", "fr" : "Décision d’envoyer la langue DE pour examen" }

< string, string > map

name
optional

Example : { "en" : "Send for Review", "fr" : "Envoyer pour examen" }

< string, string > map

3.11. CMSWorkflowListWsDTO

Specifies a list of available CMS workflows.

Name Schema

pagination
optional

pagination

workflows
optional

< CMSWorkflowWsDTO > array

3.12. CMSWorkflowOperationWsDTO

Specifies properties of the CMS workflow operation.

Name Description Schema

actionCode
optional

Example : "000001JR"

string

comment
optional

string

createVersion
optional

boolean

decisionCode
optional

Example : "000000RS"

string

operation
optional

string

versionLabel
optional

string

3.13. CMSWorkflowWsDTO

Specifies properties of the CMS workflow.

Name Description Schema

actions
optional

< CMSWorkflowAction > array

attachments
optional

< string > array

canModifyItemInWorkflow
optional

Example : true

boolean

createVersion
optional

boolean

description
optional

string

isAvailableForCurrentPrincipal
optional

Example : true

boolean

status
optional

Example : "RUNNING"

string

templateCode
optional

Example : "PageTranslation"

string

versionLabel
optional

string

workflowCode
optional

Example : "000000RV"

string

3.14. CatalogDataListWsDTO

Specifies a list of available catalog data.

Name Description Schema

catalogIds
optional

Example : [ "electronicsContentCatalog", "electronicsProductCatalog" ]

< string > array

3.15. CatalogVersionData

Name Schema

active
optional

boolean

homepage
optional

HomePageData

name
optional

< string, string > map

pageDisplayConditions
optional

< DisplayConditionData > array

thumbnailUrl
optional

string

uuid
optional

string

version
optional

string

3.16. CatalogVersionListData

Specifies a list of available catalog versions.

Name Schema

versions
optional

< CatalogVersionData > array

3.17. CategoryDataListWsDTO

Specifies a list of available product categories.

Name Schema

pagination
optional

pagination

productCategories
optional

< CategoryWsDTO > array

3.18. CategoryWsDTO

Specifies properties for the category.

Name Description Schema

catalogId
optional

Example : "electronicsContentCatalog"

string

catalogVersion
optional

Example : "Staged"

string

code
optional

Example : "ProductPage"

string

description
optional

< string, string > map

name
optional

< string, string > map

thumbnailMediaCode
optional

string

3.19. ComponentTypeAttributeData

Specifies properties of the component type attribute.

Name Description Schema

cmsStructureEnumType
optional

string

cmsStructureType
optional

Example : "ShortString"

string

collection
optional

Example : false

boolean

containedTypes
optional

Example : [ "MediaFormat", "MediaContainer" ]

< string > array

dependsOn
optional

string

editable
optional

Example : false

boolean

i18nKey
optional

Example : "type.searchboxcomponent.name"

string

idAttribute
optional

Example : "value"

string

labelAttributes
optional

Example : [ "label" ]

< string > array

localized
optional

Example : false

boolean

options
optional

< OptionData > array

paged
optional

Example : false

boolean

params
optional

Example : { "typeCode" : "AbstractRestriction" }

< string, string > map

placeholder
optional

Example : "Select or create an entry"

string

qualifier
optional

Example : "cmsComponents"

string

required
optional

Example : false

boolean

subTypes
optional

Example : { "CMSUserGroupRestriction" : "type.cmsusergrouprestriction.name", "CMSCampaignRestriction" : "type.cmscampaignrestriction.name" }

< string, string > map

uri
optional

string

3.20. ComponentTypeData

Specifies properties of the component type.

Name Description Schema

attributes
optional

< ComponentTypeAttributeData > array

category
optional

Example : "Page"

string

code
optional

Example : "ContentPage"

string

i18nKey
optional

Example : "type.searchboxcomponent.name"

string

name
optional

Example : "Link"

string

type
optional

Example : "SearchBoxComponent"

string

3.21. ComponentTypeListData

Specifies a list of available component types.

Name Schema

componentTypes
optional

< ComponentTypeData > array

3.22. ContentSlotTypeRestrictionsWsDTO

Specifies a list of valid component types for a given content slot.

Name Description Schema

contentSlotUid
optional

Example : "Section1Slot-Homepage"

string

validComponentTypes
optional

Example : [ "ProductFeatureComponent", "CategoryFeatureComponent" ]

< string > array

3.23. DisplayConditionData

Name Schema

options
optional

< OptionData > array

typecode
optional

string

3.24. HomePageData

Name Schema

current
optional

AbstractPageData

fallback
optional

AbstractPageData

old
optional

AbstractPageData

3.25. ItemSynchronizationWsDTO

Specifies properties of the item synchronization.

Name Description Schema

itemId
optional

string

itemType
optional

Example : "ContentSlot"

string

3.26. ItemTypeWsDTO

Specifies properties of the item type.

Name Description Schema

i18nKey
optional

Example : "type.searchboxcomponent.name"

string

itemType
optional

Example : "ContentSlot"

string

3.27. LanguageData

Name Schema

active
optional

boolean

isocode
optional

string

name
optional

string

nativeName
optional

string

required
optional

boolean

3.28. LanguageListData

Specifies a list of available languages.

Name Schema

languages
optional

< LanguageData > array

3.29. MediaContainerListWsDTO

Specifies a list of available media containers.

Name Schema

mediaContainers
optional

< MediaContainerWsDTO > array

pagination
optional

pagination

3.30. MediaContainerWsDTO

Specifies properties of the media container.

Name Description Schema

catalogVersion
optional

Example : "Online"

string

mediaContainerUuid
optional

Example : "encoded-media-container-identifier"

string

medias
optional

< string, string > map

qualifier
optional

Example : "summer-sales-media-container"

string

thumbnailUrl
optional

Example : "/images/summer-sales.jpeg"

string

3.31. MediaData

Specifies properties of a specific media.

Name Description Schema

altText
optional

Example : "Text to display if media can’t be loaded."

string

catalogId
optional

Example : "electronicsContentCatalog"

string

catalogVersion
optional

Example : "Online"

string

code
optional

Example : "PreviewData"

string

description
optional

Example : "Text that describes a media."

string

downloadUrl
optional

string

mime
optional

Example : "image/png"

string

url
optional

string

uuid
optional

string

3.32. MediaFolder

Specifies properties of the media folder.

Name Description Schema

qualifier
optional

Example : "image"

string

3.33. MediaFolderListWsDTO

Specifies a list of available media folders.

Name Schema

mediaFolders
optional

< MediaFolder > array

pagination
optional

pagination

3.34. MediaListData

Specifies a list of available media.

Name Schema

media
optional

< MediaData > array

pagination
optional

pagination

3.35. NavigationEntryData

Specifies properties of the navigation entry.

Name Description Schema

itemId
optional

Example : "DigitalCompactsCategoryLink"

string

itemSuperType
optional

Example : "AbstractCMSComponent"

string

itemType
optional

Example : "CMSNavigationNode"

string

name
optional

Example : "My Account"

string

3.36. NavigationNodeData

Specifies properties of the navigation node.

Name Description Schema

entries
optional

< NavigationEntryData > array

hasChildren
optional

Example : false

boolean

itemType
optional

Example : "CMSNavigationNode"

string

name
optional

Example : "My Account"

string

parentUid
optional

Example : "SiteRootNode"

string

position
optional

Example : 3

integer (int32)

title
optional

Example : { "EN" : "Homepage", "DE" : "Startseite" }

< string, string > map

uid
optional

Example : "ElectronicsNavNode"

string

uuid
optional

string

3.37. NavigationNodeListData

Specifies a list of available navigation nodes.

Name Schema

navigationNodes
optional

< NavigationNodeData > array

3.38. OptionData

Name Schema

id
optional

string

label
optional

string

3.39. PageContentSlotComponentData

Specifies properties of the page content slot component.

Name Description Schema

componentId
optional

Example : "AbstractCMSComponent"

string

componentUuid
optional

string

pageId
optional

Example : "homepage"

string

position
optional

Example : 1

integer (int32)

slotId
optional

Example : "Section1Slot-Homepage"

string

3.40. PageContentSlotComponentListData

Specifies a list of available page content slot components.

Name Schema

pageContentSlotComponentList
optional

< PageContentSlotComponentData > array

3.41. PageContentSlotContainerListWsDTO

Specifies a list of available content slot containers.

Name Schema

pageContentSlotContainerList
optional

< PageContentSlotContainerWsDTO > array

3.42. PageContentSlotContainerWsDTO

Specifies properties of the page content slot container.

Name Description Schema

components
optional

< string > array

containerId
optional

string

containerType
optional

string

pageId
optional

Example : "homepage"

string

slotId
optional

Example : "Section1Slot-Homepage"

string

3.43. PageContentSlotData

Specifies properties of the page content slot.

Name Description Schema

pageId
optional

Example : "homepage"

string

position
optional

Example : "1"

string

slotId
optional

Example : "Section1Slot-Homepage"

string

slotShared
optional

Example : true

boolean

slotStatus
optional

string

3.44. PageContentSlotListData

Specifies a list of available page content slots.

Name Schema

pageContentSlotList
optional

< PageContentSlotData > array

3.45. PageListData

Specifies a list of available pages.

Name Schema

pages
optional

< AbstractPageData > array

pagination
optional

pagination

3.46. PageRestrictionData

Specifies properties of the page restriction.

Name Description Schema

pageId
optional

Example : "homepage"

string

restrictionId
optional

string

3.47. PageRestrictionListData

Specifies a list of available page restrictions.

Name Schema

pageRestrictionList
optional

< PageRestrictionData > array

3.48. PageTemplateData

Specifies properties of the page template.

Name Description Schema

catalogVersion
optional

string

frontEndName
optional

Example : "product/productLayout2Page"

string

name
optional

Example : "homepage"

string

previewIcon
optional

string

uid
optional

Example : "ProductDetailsPageTemplate"

string

uuid
optional

string

3.49. PageTemplateListData

Specifies a list of available page templates.

Name Schema

templates
optional

< PageTemplateData > array

3.50. PageTypeData

Specifies property of the page type.

Name Description Schema

code
optional

Example : "000000RW"

string

description
optional

< string, string > map

name
optional

< string, string > map

type
optional

Example : "ContentPage"

string

3.51. PageTypeListData

Specifies a list of available page types.

Name Schema

pageTypes
optional

< PageTypeData > array

3.52. PageTypeRestrictionTypeData

Specifies a restriction type that can be applied to a given page type.

Name Description Schema

pageType
optional

Example : "ContentPage"

string

restrictionType
optional

Example : "CMSUserGroupRestriction"

string

3.53. PageTypeRestrictionTypeListData

Specifies a list of available restriction types for a given page type.

Name Schema

pageTypeRestrictionTypeList
optional

< PageTypeRestrictionTypeData > array

3.54. ProductDataListWsDTO

Specifies a list of available products.

Name Schema

pagination
optional

pagination

products
optional

< ProductWsDTO > array

3.55. ProductWsDTO

Specifies properties of the product.

Name Description Schema

catalogId
optional

Example : "electronicsContentCatalog"

string

catalogVersion
optional

Example : "Online"

string

code
optional

Example : "489702"

string

description
optional

< string, string > map

name
optional

< string, string > map

thumbnailMediaCode
optional

string

3.56. RestrictionTypeData

Specifies properties of the restriction type.

Name Description Schema

code
optional

Example : "000000RW"

string

description
optional

< string, string > map

name
optional

< string, string > map

3.57. RestrictionTypeListData

Specifies a list of available restriction types.

Name Schema

restrictionTypes
optional

< RestrictionTypeData > array

3.58. SiteData

Specifies properties of the site.

Name Description Schema

contentCatalogs
optional

Example : [ "apparel-deContentCatalog" ]

< string > array

name
optional

Example : { "en" : "Apparel Site DE", "de" : "Bekleidungs-Website DE" }

< string, string > map

previewUrl
optional

Example : "/storefront/?site=apparel-de"

string

uid
optional

Example : "apparel-de"

string

3.59. SiteListData

Specified a list of available sites.

Name Schema

sites
optional

< SiteData > array

3.60. SyncItemStatusWsDTO

Specifies properties of the synchronization item status.

Name Description Schema

dependentItemTypesOutOfSync
optional

< ItemTypeWsDTO > array

itemId
optional

string

itemType
optional

Example : "ContentSlot"

string

lastModifiedDate
optional

Example : 1575388910281

integer (int64)

lastSyncStatus
optional

Example : 1575389256116

integer (int64)

name
optional

Example : "SearchBoxSlot"

string

selectedDependencies
optional

< SyncItemStatusWsDTO > array

sharedDependencies
optional

< SyncItemStatusWsDTO > array

status
optional

Example : "NOT_SYNC"

string

3.61. SyncJobData

Specifies properties of the synchronization job.

Name Description Schema

code
optional

Example : "ProductPage"

string

creationDate
optional

Example : "yyyy-MM-dd HH:mm:ss+0000"

string (date-time)

endDate
optional

Example : "yyyy-MM-dd HH:mm:ss+0000"

string (date-time)

lastModifiedDate
optional

Example : "yyyy-MM-dd HH:mm:ss+0000"

string (date-time)

sourceCatalogVersion
optional

Example : "electronicsContentCatalog/Staged"

string

startDate
optional

Example : "yyyy-MM-dd HH:mm:ss+0000"

string (date-time)

syncResult
optional

Example : "SUCCESS"

string

syncStatus
optional

Example : "IN_SYNC"

string

targetCatalogVersion
optional

Example : "electronicsContentCatalog/Online"

string

3.62. SynchronizationWsDTO

Specifies a list of available synchronization items.

Name Schema

items
optional

< ItemSynchronizationWsDTO > array

3.63. UidListData

Specifies a list of available uids.

Name Schema

uids
optional

< string > array

3.64. UserDataWsDTO

Specifies properties of the user data.

Name Description Schema

readableLanguages
optional

Example : [ "de", "hi" ]

< string > array

uid
optional

string

writeableLanguages
optional

Example : [ "de", "hi" ]

< string > array

3.65. UserGroupListWsDTO

Specifies a list of available user groups.

Name Schema

pagination
optional

pagination

userGroups
optional

< UserGroupWsDTO > array

3.66. UserGroupWsDTO

Specifies properties of the user group.

Name Description Schema

name
optional

< string, string > map

uid
optional

Example : "admin"

string

3.67. WorkflowTemplate

Specifies properties of the workflow template.

Name Description Schema

code
optional

Example : "000000RS"

string

name
optional

Example : { "en" : "Page Translation", "fr" : "Traduction de pages" }

< string, string > map

3.68. WorkflowTemplateListWsDTO

Specifies a list of available workflow templates.

Name Schema

templates
optional

< WorkflowTemplate > array

3.69. pagination

Pagination info

Name Description Schema

count
optional

Number of elements on this page

integer (int32)

hasNext
optional

Indicates if there is next page

boolean

hasPrevious
optional

Indicates if there is previous page

boolean

page
optional

Current page number

integer (int32)

totalCount
optional

Total number of elements

integer (int64)

totalPages
optional

Total number of pages

integer (int32)

4. Security

4.1. oauth2_password

Type : oauth2
Flow : password
Token URL : /authorizationserver/oauth/token

Name

basic

4.2. oauth2_client_credentials

Type : oauth2
Flow : application
Token URL : /authorizationserver/oauth/token

Name

extended