CMS Webservices
These client-independent services manage CMS-related items.
Version: 1.0
BasePath:/cmswebservices
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.
http://apache.org/licenses/LICENSE-2.0.html
Access
- OAuth AuthorizationUrl:TokenUrl:https://{oauth2_url}/authorizationserver/oauth/token
- OAuth AuthorizationUrl:TokenUrl:https://{oauth2_url}/authorizationserver/oauth/token
[ Jump to Models ]
Table of Contents
Up
post /v1/catalogs/{catalogId}/versions/{versionId}/media
Uploads media. (doUploadMultipartMedia)
Provides a new multipart media item for a given catalogId.
Path parameters
catalogId (required)
Path Parameter — The unique identifier of the catalog for which to link the new media.
versionId (required)
Path Parameter — The specific catalog version to which the new media will be associated to.
Consumes
This API call consumes the following media types via the request header:
Query parameters
altText (required)
Query Parameter — The alternative text to use for the newly created media.
code (required)
Query Parameter — The code to use for the newly created media.
description (required)
Query Parameter — The description to use for the newly created media.
mime (optional)
Query Parameter — Internet Media Type for the media file.
Form parameters
file (required)
Form Parameter — The file representing the actual binary contents of the media to be created.
Return type
Example data
Content-Type: application/json
{
"catalogVersion" : "Online",
"catalogId" : "electronicsContentCatalog",
"code" : "PreviewData",
"altText" : "Text to display if media can't be loaded.",
"mime" : "image/png",
"downloadUrl" : "downloadUrl",
"description" : "Text that describes a media.",
"uuid" : "uuid",
"url" : "url"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
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)
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
post /v1/catalogs/{catalogId}/versions/{sourceVersionId}/synchronizations/versions/{targetVersionId}
Creates a catalog synchronization. (createNewSynchronizationByCatalog)
Generates a brand new synchronization status. The status is generated based on a given catalog, source version and target version ids.
Path parameters
catalogId (required)
Path Parameter — The catalog id
sourceVersionId (required)
Path Parameter — Catalog version used as a starting point in this synchronization
targetVersionId (required)
Path Parameter — Catalog version destination to be synchronized
Consumes
This API call consumes the following media types via the request header:
Return type
Example data
Content-Type: application/json
{
"targetCatalogVersion" : "electronicsContentCatalog/Online",
"code" : "ProductPage",
"endDate" : "yyyy-MM-dd HH:mm:ss+0000",
"lastModifiedDate" : "yyyy-MM-dd HH:mm:ss+0000",
"syncResult" : "SUCCESS",
"creationDate" : "yyyy-MM-dd HH:mm:ss+0000",
"startDate" : "yyyy-MM-dd HH:mm:ss+0000",
"syncStatus" : "IN_SYNC",
"sourceCatalogVersion" : "electronicsContentCatalog/Staged"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The synchronization status
SyncJobData
400
When one of the catalogs does not exist (CMSItemNotFoundException).
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
get /v1/catalogs/{catalogId}/synchronizations/targetversions/{targetVersionId}
Gets last synchronization by target catalog. (getLastSynchronizationByCatalog)
Retrieves the status of the last synchronization job. Information is retrieved based on the catalog version target.
Path parameters
catalogId (required)
Path Parameter — The catalog id
targetVersionId (required)
Path Parameter — Catalog version destination to be synchronized
Return type
Example data
Content-Type: application/json
{
"targetCatalogVersion" : "electronicsContentCatalog/Online",
"code" : "ProductPage",
"endDate" : "yyyy-MM-dd HH:mm:ss+0000",
"lastModifiedDate" : "yyyy-MM-dd HH:mm:ss+0000",
"syncResult" : "SUCCESS",
"creationDate" : "yyyy-MM-dd HH:mm:ss+0000",
"startDate" : "yyyy-MM-dd HH:mm:ss+0000",
"syncStatus" : "IN_SYNC",
"sourceCatalogVersion" : "electronicsContentCatalog/Staged"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The synchronization status
SyncJobData
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
get /v1/catalogs/{catalogId}/versions/{sourceVersionId}/synchronizations/versions/{targetVersionId}
Gets synchronization status. (getSynchronizationByCatalog)
Retrieves the status of the last synchronization for a catalog. Information is
retrieved based on a given catalog, source version and target version ids.
Path parameters
catalogId (required)
Path Parameter — The catalog id
sourceVersionId (required)
Path Parameter — Catalog version used as a starting point in this synchronization
targetVersionId (required)
Path Parameter — Catalog version destination to be synchronized
Return type
Example data
Content-Type: application/json
{
"targetCatalogVersion" : "electronicsContentCatalog/Online",
"code" : "ProductPage",
"endDate" : "yyyy-MM-dd HH:mm:ss+0000",
"lastModifiedDate" : "yyyy-MM-dd HH:mm:ss+0000",
"syncResult" : "SUCCESS",
"creationDate" : "yyyy-MM-dd HH:mm:ss+0000",
"startDate" : "yyyy-MM-dd HH:mm:ss+0000",
"syncStatus" : "IN_SYNC",
"sourceCatalogVersion" : "electronicsContentCatalog/Staged"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The synchronization status
SyncJobData
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
put /v1/catalogs/{catalogId}/versions/{sourceVersionId}/synchronizations/versions/{targetVersionId}
Creates a catalog synchronization. (replaceSynchronizationByCatalog)
Generates a brand new synchronization status. The status is generated based on a given catalog, source version and target version ids.
Path parameters
catalogId (required)
Path Parameter — The catalog id
sourceVersionId (required)
Path Parameter — Catalog version used as a starting point in this synchronization
targetVersionId (required)
Path Parameter — Catalog version destination to be synchronized
Consumes
This API call consumes the following media types via the request header:
Return type
Example data
Content-Type: application/json
{
"targetCatalogVersion" : "electronicsContentCatalog/Online",
"code" : "ProductPage",
"endDate" : "yyyy-MM-dd HH:mm:ss+0000",
"lastModifiedDate" : "yyyy-MM-dd HH:mm:ss+0000",
"syncResult" : "SUCCESS",
"creationDate" : "yyyy-MM-dd HH:mm:ss+0000",
"startDate" : "yyyy-MM-dd HH:mm:ss+0000",
"syncStatus" : "IN_SYNC",
"sourceCatalogVersion" : "electronicsContentCatalog/Staged"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The synchronization status
SyncJobData
400
When one of the catalogs does not exist (CMSItemNotFoundException).
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
get /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/targets
Gets writable content catalog versions. (getWritableContentCatalogVersion)
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.
Path parameters
catalogId (required)
Path Parameter — The catalog id
siteId (required)
Path Parameter — The site identifier
versionId (required)
Path Parameter — The version of the catalog
Query parameters
mode (required)
Query Parameter — The mode to filter the result
Return type
Example data
Content-Type: application/json
{
"versions" : [ {
"pageDisplayConditions" : [ {
"typecode" : "typecode",
"options" : [ {
"id" : "id",
"label" : "label"
}, {
"id" : "id",
"label" : "label"
} ]
}, {
"typecode" : "typecode",
"options" : [ {
"id" : "id",
"label" : "label"
}, {
"id" : "id",
"label" : "label"
} ]
} ],
"name" : {
"key" : "name"
},
"active" : true,
"uuid" : "uuid",
"version" : "version",
"homepage" : {
"current" : {
"template" : "LandingPageTemplate",
"uid" : "uid",
"defaultPage" : true,
"modifiedtime" : "yyyy-MM-dd HH:mm:ss+0000",
"onlyOneRestrictionMustApply" : false,
"name" : "homepage",
"creationtime" : "yyyy-MM-dd HH:mm:ss+0000",
"pk" : "8796093056052",
"title" : {
"EN" : "Homepage",
"DE" : "Startseite"
},
"uuid" : "uuid",
"typeCode" : "ContentPage"
},
"old" : {
"template" : "LandingPageTemplate",
"uid" : "uid",
"defaultPage" : true,
"modifiedtime" : "yyyy-MM-dd HH:mm:ss+0000",
"onlyOneRestrictionMustApply" : false,
"name" : "homepage",
"creationtime" : "yyyy-MM-dd HH:mm:ss+0000",
"pk" : "8796093056052",
"title" : {
"EN" : "Homepage",
"DE" : "Startseite"
},
"uuid" : "uuid",
"typeCode" : "ContentPage"
},
"fallback" : {
"template" : "LandingPageTemplate",
"uid" : "uid",
"defaultPage" : true,
"modifiedtime" : "yyyy-MM-dd HH:mm:ss+0000",
"onlyOneRestrictionMustApply" : false,
"name" : "homepage",
"creationtime" : "yyyy-MM-dd HH:mm:ss+0000",
"pk" : "8796093056052",
"title" : {
"EN" : "Homepage",
"DE" : "Startseite"
},
"uuid" : "uuid",
"typeCode" : "ContentPage"
}
},
"thumbnailUrl" : "thumbnailUrl"
}, {
"pageDisplayConditions" : [ {
"typecode" : "typecode",
"options" : [ {
"id" : "id",
"label" : "label"
}, {
"id" : "id",
"label" : "label"
} ]
}, {
"typecode" : "typecode",
"options" : [ {
"id" : "id",
"label" : "label"
}, {
"id" : "id",
"label" : "label"
} ]
} ],
"name" : {
"key" : "name"
},
"active" : true,
"uuid" : "uuid",
"version" : "version",
"homepage" : {
"current" : {
"template" : "LandingPageTemplate",
"uid" : "uid",
"defaultPage" : true,
"modifiedtime" : "yyyy-MM-dd HH:mm:ss+0000",
"onlyOneRestrictionMustApply" : false,
"name" : "homepage",
"creationtime" : "yyyy-MM-dd HH:mm:ss+0000",
"pk" : "8796093056052",
"title" : {
"EN" : "Homepage",
"DE" : "Startseite"
},
"uuid" : "uuid",
"typeCode" : "ContentPage"
},
"old" : {
"template" : "LandingPageTemplate",
"uid" : "uid",
"defaultPage" : true,
"modifiedtime" : "yyyy-MM-dd HH:mm:ss+0000",
"onlyOneRestrictionMustApply" : false,
"name" : "homepage",
"creationtime" : "yyyy-MM-dd HH:mm:ss+0000",
"pk" : "8796093056052",
"title" : {
"EN" : "Homepage",
"DE" : "Startseite"
},
"uuid" : "uuid",
"typeCode" : "ContentPage"
},
"fallback" : {
"template" : "LandingPageTemplate",
"uid" : "uid",
"defaultPage" : true,
"modifiedtime" : "yyyy-MM-dd HH:mm:ss+0000",
"onlyOneRestrictionMustApply" : false,
"name" : "homepage",
"creationtime" : "yyyy-MM-dd HH:mm:ss+0000",
"pk" : "8796093056052",
"title" : {
"EN" : "Homepage",
"DE" : "Startseite"
},
"uuid" : "uuid",
"typeCode" : "ContentPage"
}
},
"thumbnailUrl" : "thumbnailUrl"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The list of content catalog versions.
CatalogVersionListData
400
When the catalog and/or version specified is not valid (CMSItemNotFoundException).
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
get /v1/sites/{siteId}/cmsitems
Finds CMS items. (getCMSItemByPagedSearch)
Retrieves a list of available CMS items that match pages search.
Path parameters
siteId (required)
Path Parameter — The site identifier
Query parameters
catalogId (required)
Query Parameter — The catalog id
catalogVersion (required)
Query Parameter — CatalogVersion on which to search
currentPage (required)
Query Parameter — The current result page requested
itemSearchParams (optional)
Query Parameter — 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.
mask (optional)
Query Parameter — Search mask applied to the UID and NAME fields, Uses partial matching
pageSize (required)
Query Parameter — Page size for paging
sort (optional)
Query Parameter — The requested ordering for the search results.
typeCode (optional)
Query Parameter — TypeCode filter. Exact matches only. Either typeCode or typeCodes can be set.
typeCodes (optional)
Query Parameter — Search using a comma separated list of type code. Either typeCode or typeCodes can be set.
Return type
Object
Example data
Content-Type: application/json
"{}"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
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).
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
get /v1/sites/{siteId}/cmsitems/{uuid}
Gets CMS Item by uuid. (getCMSItemByUUIdAndVersion)
Retrieves an item that matches the given item uuid (Universally Unique Identifier).
Path parameters
siteId (required)
Path Parameter — The site identifier
uuid (required)
Path Parameter — The universally unique identifier of the item. The uuid is a composed key formed by the cms item uid + the catalog + the catalog version.
Query parameters
versionId (optional)
Query Parameter — The uid of the cms version.
Return type
Object
Example data
Content-Type: application/json
"{}"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Map<String, Object> representation of the CMS Item object.
Object
400
If there is any validation error (WebserviceValidationException).
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
delete /v1/sites/{siteId}/cmsitems/{uuid}
Removes CMS Item. (removeCMSItemByUUId)
Deletes a specific instance of the content item (CMSItem) from the system by uuid.
Path parameters
siteId (required)
Path Parameter — The site identifier
uuid (required)
Path Parameter — The universally unique identifier of the item
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
No Content
400
If it cannot find the content item (CMSItemNotFoundException).
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
put /v1/sites/{siteId}/cmsitems/{uuid}
Updates CMS Item. (replaceCMSItem)
Updates a CMS Item for a given site id.
Path parameters
siteId (required)
Path Parameter — The site identifier
uuid (required)
Path Parameter — Unique Identifier of a CMS Item
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Map representing the CMS item to update
Return type
Object
Example data
Content-Type: application/json
"{}"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
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).
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
post /v1/sites/{siteId}/cmsitems/uuids
Finds cms items by uuids in body. (searchCMSItemByUUId)
Retrieves a list of available CMSItems matching the given uuids by POSTing the uuids in the request body.
Path parameters
siteId (required)
Path Parameter — The site identifier
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — CMSItemUuidListData
Return type
Object
Example data
Content-Type: application/json
"{}"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
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).
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
post /v1/sites/{siteId}/cmsitems
Validates CMS Item for creation. (validateCMSItemForCreation)
Performs validation on the specific instance of the CMS Item in a Dry Run mode.
Path parameters
siteId (required)
Path Parameter — The site identifier
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Map representing the CMS item to create in Dry Run mode
Query parameters
dryRun (required)
Query Parameter — When set to TRUE, the request is executed in Dry Run mode default: true
Return type
Object
Example data
Content-Type: application/json
"{}"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
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).
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
post /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/synchronizations/versions/{targetCatalogVersion}
Performs synchronization. (doPerformSync)
Executes status synchronization on a list of ItemModel identifier by their ItemSynchronization properties.
Path parameters
catalogId (required)
Path Parameter — The source catalog version from a synchronization perspective
siteId (required)
Path Parameter — The site identifier
targetCatalogVersion (required)
Path Parameter — The SynchronizationData containing the list of requested synchronizations
versionId (required)
Path Parameter — The target catalog version from a synchronization perspective
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The catalog id
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
No Content
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
get /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/synchronizations/versions/{targetCatalogVersion}/items/{componentId}
Gets component synchronization status. (getComponentSynchronizationStatus)
Builds the synchronization status of a AbstractCMSComponentModel component.
Path parameters
catalogId (required)
Path Parameter — The catalog id
componentId (required)
Path Parameter — The uid of the component from which to retrieve the synchronization status
siteId (required)
Path Parameter — The site identifier
targetCatalogVersion (required)
Path Parameter — The target catalog version from a synchronization perspective
versionId (required)
Path Parameter — The source catalog version from a synchronization perspective
Return type
Example data
Content-Type: application/json
{
"dependentItemTypesOutOfSync" : [ {
"itemType" : "ContentSlot",
"i18nKey" : "type.searchboxcomponent.name"
}, {
"itemType" : "ContentSlot",
"i18nKey" : "type.searchboxcomponent.name"
} ],
"itemId" : "itemId",
"itemType" : "ContentSlot",
"lastModifiedDate" : 1575388910281,
"selectedDependencies" : [ null, null ],
"name" : "SearchBoxSlot",
"sharedDependencies" : [ null, null ],
"lastSyncStatus" : 1575389256116,
"status" : "NOT_SYNC"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
item containing the complex synchronization status of the AbstractCMSComponentModel page
SyncItemStatusData
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
get /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/synchronizations/versions/{targetCatalogVersion}/pages/{pageId}
Gets page synchronization status. (getPageSynchronizationStatus)
Builds the synchronization status of a AbstractPageModel page.
Path parameters
catalogId (required)
Path Parameter — The catalog id
pageId (required)
Path Parameter — The uid of the page from which to retrieve the synchronization status
siteId (required)
Path Parameter — The site identifier
targetCatalogVersion (required)
Path Parameter — The target catalog version from a synchronization perspective
versionId (required)
Path Parameter — The source catalog version from a synchronization perspective
Return type
Example data
Content-Type: application/json
{
"dependentItemTypesOutOfSync" : [ {
"itemType" : "ContentSlot",
"i18nKey" : "type.searchboxcomponent.name"
}, {
"itemType" : "ContentSlot",
"i18nKey" : "type.searchboxcomponent.name"
} ],
"itemId" : "itemId",
"itemType" : "ContentSlot",
"lastModifiedDate" : 1575388910281,
"selectedDependencies" : [ null, null ],
"name" : "SearchBoxSlot",
"sharedDependencies" : [ null, null ],
"lastSyncStatus" : 1575389256116,
"status" : "NOT_SYNC"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
item containing the complex synchronization status of the AbstractPageModel page
SyncItemStatusData
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
get /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/synchronizations/versions/{targetCatalogVersion}/slots/{slotId}
Gets slot synchronization status. (getSlotSynchronizationStatus)
Builds the synchronization status of a ContentSlotModel slot.
Path parameters
catalogId (required)
Path Parameter — The catalog id
siteId (required)
Path Parameter — The site identifier
slotId (required)
Path Parameter — The uid of the slot from which to retrieve the synchronization status
targetCatalogVersion (required)
Path Parameter — The target catalog version from a synchronization perspective
versionId (required)
Path Parameter — The source catalog version from a synchronization perspective
Return type
Example data
Content-Type: application/json
{
"dependentItemTypesOutOfSync" : [ {
"itemType" : "ContentSlot",
"i18nKey" : "type.searchboxcomponent.name"
}, {
"itemType" : "ContentSlot",
"i18nKey" : "type.searchboxcomponent.name"
} ],
"itemId" : "itemId",
"itemType" : "ContentSlot",
"lastModifiedDate" : 1575388910281,
"selectedDependencies" : [ null, null ],
"name" : "SearchBoxSlot",
"sharedDependencies" : [ null, null ],
"lastSyncStatus" : 1575389256116,
"status" : "NOT_SYNC"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
item containing the complex synchronization status of the ContentSlotModel page
SyncItemStatusData
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
get /v1/sites/{siteId}/languages
Gets languages. (getLanguages)
Retrieves a list of available languages supported by a storefront.
Path parameters
siteId (required)
Path Parameter — The site identifier
Return type
Example data
Content-Type: application/json
{
"languages" : [ {
"nativeName" : "nativeName",
"isocode" : "isocode",
"name" : "name",
"active" : true,
"required" : true
}, {
"nativeName" : "nativeName",
"isocode" : "isocode",
"name" : "name",
"active" : true,
"required" : true
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
List of languages.
LanguageListData
401
Must be authenticated as an Admin or CMS Manager to access this resource
Gets media by query. (getMediaByQuery)
Gets a specific media item by named query.
Query parameters
currentPage (optional)
Query Parameter — The index of the requested page (index 0 means page 1).
namedQuery (required)
Query Parameter — The name of the named query to use for the search.
pageSize (required)
Query Parameter — The number of results per page.
params (required)
Query Parameter — The list of the filtering parameters for the namedQuery.
Ex:"catalogId:catalogIdValue,catalogVersion:catalogVersionValue,code:codeValue"
sort (required)
Query Parameter — The requested ordering for the search results.
Return type
Example data
Content-Type: application/json
{
"media" : [ {
"catalogVersion" : "Online",
"catalogId" : "electronicsContentCatalog",
"code" : "PreviewData",
"altText" : "Text to display if media can't be loaded.",
"mime" : "image/png",
"downloadUrl" : "downloadUrl",
"description" : "Text that describes a media.",
"uuid" : "uuid",
"url" : "url"
}, {
"catalogVersion" : "Online",
"catalogId" : "electronicsContentCatalog",
"code" : "PreviewData",
"altText" : "Text to display if media can't be loaded.",
"mime" : "image/png",
"downloadUrl" : "downloadUrl",
"description" : "Text that describes a media.",
"uuid" : "uuid",
"url" : "url"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
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
401
Must be authenticated as an Admin or CMS Manager to access this resource
Gets media by uuid. (getMediaByUuid)
Finds a specific media item that matches given uuid.
Path parameters
uuid (required)
Path Parameter — The universally unique identifier of the media item
Return type
Example data
Content-Type: application/json
{
"catalogVersion" : "Online",
"catalogId" : "electronicsContentCatalog",
"code" : "PreviewData",
"altText" : "Text to display if media can't be loaded.",
"mime" : "image/png",
"downloadUrl" : "downloadUrl",
"description" : "Text that describes a media.",
"uuid" : "uuid",
"url" : "url"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Media data
MediaData
401
Must be authenticated as an Admin or CMS Manager to access this resource
404
When no media is found matching the given uuid (MediaNotFoundException).
Gets a list of media by uuids. (getMediaByUuids)
Retrieves a list of media items that match the given uuids by POSTing the uuids in the request body
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — List of uuids representing the media to retrieve
Return type
Example data
Content-Type: application/json
{
"media" : [ {
"catalogVersion" : "Online",
"catalogId" : "electronicsContentCatalog",
"code" : "PreviewData",
"altText" : "Text to display if media can't be loaded.",
"mime" : "image/png",
"downloadUrl" : "downloadUrl",
"description" : "Text that describes a media.",
"uuid" : "uuid",
"url" : "url"
}, {
"catalogVersion" : "Online",
"catalogId" : "electronicsContentCatalog",
"code" : "PreviewData",
"altText" : "Text to display if media can't be loaded.",
"mime" : "image/png",
"downloadUrl" : "downloadUrl",
"description" : "Text that describes a media.",
"uuid" : "uuid",
"url" : "url"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A list of media data
MediaListData
401
Must be authenticated as an Admin or CMS Manager to access this resource
404
When one of the media cannot be found (MediaNotFoundException).
Up
get /v1/catalogs/{catalogId}/versions/{versionId}/mediacontainers/{code}
Gets media container by code. (getMediaContainerByCode)
Retrieves a specific media container that matches the given id.
Path parameters
catalogId (required)
Path Parameter — The catalog id
versionId (required)
Path Parameter — The catalog version identifier
code (required)
Path Parameter — The unique identifier of the media container
Return type
Example data
Content-Type: application/json
{
"catalogVersion" : "Online",
"medias" : {
"key" : "medias"
},
"qualifier" : "summer-sales-media-container",
"mediaContainerUuid" : "encoded-media-container-identifier",
"thumbnailUrl" : "/images/summer-sales.jpeg"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
MediaContainerData
MediaContainerData
400
When the media container was not found (CMSItemNotFoundException) or when there was a problem during conversion (ConversionException).
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
get /v1/catalogs/{catalogId}/versions/{versionId}/mediacontainers
Finds media container by partial to full code matching. (getMediaContainersByText)
Retrieves a list of available media containers using a free text search field.
Path parameters
catalogId (required)
Path Parameter — The catalog id
versionId (required)
Path Parameter — The catalog version identifier
Query parameters
currentPage (optional)
Query Parameter — The requested page number
mask (optional)
Query Parameter — The string value on which media containers will be filtered
pageSize (required)
Query Parameter — The maximum number of elements in the result list.
sort (optional)
Query Parameter — The string field the results will be sorted with
Return type
Example data
Content-Type: application/json
{
"pagination" : {
"count" : 0,
"totalPages" : 5,
"hasPrevious" : true,
"hasNext" : true,
"page" : 6,
"totalCount" : 1
},
"mediaContainers" : [ {
"catalogVersion" : "Online",
"medias" : {
"key" : "medias"
},
"qualifier" : "summer-sales-media-container",
"mediaContainerUuid" : "encoded-media-container-identifier",
"thumbnailUrl" : "/images/summer-sales.jpeg"
}, {
"catalogVersion" : "Online",
"medias" : {
"key" : "medias"
},
"qualifier" : "summer-sales-media-container",
"mediaContainerUuid" : "encoded-media-container-identifier",
"thumbnailUrl" : "/images/summer-sales.jpeg"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Item which serves as a wrapper object that contains a list of MediaContainerData; never null
MediaContainerListData
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
post /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/navigations
Creates navigation node. (createNavigationNodeById)
Adds a new navigation node for a given catalog id.
Path parameters
catalogId (required)
Path Parameter — The catalog name
siteId (required)
Path Parameter — The site identifier
versionId (required)
Path Parameter — The catalog version identifier
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The navigation node data to be added.
Return type
Example data
Content-Type: application/json
{
"parentUid" : "SiteRootNode",
"uid" : "ElectronicsNavNode",
"entries" : [ {
"itemId" : "DigitalCompactsCategoryLink",
"itemType" : "CMSNavigationNode",
"itemSuperType" : "AbstractCMSComponent",
"name" : "My Account"
}, {
"itemId" : "DigitalCompactsCategoryLink",
"itemType" : "CMSNavigationNode",
"itemSuperType" : "AbstractCMSComponent",
"name" : "My Account"
} ],
"itemType" : "CMSNavigationNode",
"hasChildren" : false,
"name" : "My Account",
"position" : 3,
"title" : {
"EN" : "Homepage",
"DE" : "Startseite"
},
"uuid" : "uuid"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
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)
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
get /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/navigations
Finds all navigation ancestors and self. (getNavigationAncestorsAndSelf)
Finds all navigation ancestors for a given node uid and the node itself.
Path parameters
catalogId (required)
Path Parameter — The catalog name
siteId (required)
Path Parameter — The site identifier
versionId (required)
Path Parameter — The catalog version identifier
Query parameters
ancestorTrailFrom (required)
Query Parameter — The navigation node's Uid whose ancestors are to be extracted.
Return type
Example data
Content-Type: application/json
{
"navigationNodes" : [ {
"parentUid" : "SiteRootNode",
"uid" : "ElectronicsNavNode",
"entries" : [ {
"itemId" : "DigitalCompactsCategoryLink",
"itemType" : "CMSNavigationNode",
"itemSuperType" : "AbstractCMSComponent",
"name" : "My Account"
}, {
"itemId" : "DigitalCompactsCategoryLink",
"itemType" : "CMSNavigationNode",
"itemSuperType" : "AbstractCMSComponent",
"name" : "My Account"
} ],
"itemType" : "CMSNavigationNode",
"hasChildren" : false,
"name" : "My Account",
"position" : 3,
"title" : {
"EN" : "Homepage",
"DE" : "Startseite"
},
"uuid" : "uuid"
}, {
"parentUid" : "SiteRootNode",
"uid" : "ElectronicsNavNode",
"entries" : [ {
"itemId" : "DigitalCompactsCategoryLink",
"itemType" : "CMSNavigationNode",
"itemSuperType" : "AbstractCMSComponent",
"name" : "My Account"
}, {
"itemId" : "DigitalCompactsCategoryLink",
"itemType" : "CMSNavigationNode",
"itemSuperType" : "AbstractCMSComponent",
"name" : "My Account"
} ],
"itemType" : "CMSNavigationNode",
"hasChildren" : false,
"name" : "My Account",
"position" : 3,
"title" : {
"EN" : "Homepage",
"DE" : "Startseite"
},
"uuid" : "uuid"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The navigation node's ancestors and the node itself.
NavigationNodeListData
400
When the navigation node uid does not exist (CMSItemNotFoundException).
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
get /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/navigations/{uid}
Finds navigation node. (getNavigationNodeById)
Retrieves a specific navigation node item. Information is retrieved based on a given site and catalog ids.
Path parameters
catalogId (required)
Path Parameter — The catalog name
siteId (required)
Path Parameter — The site identifier
uid (required)
Path Parameter — The navigation node's unique identifier
versionId (required)
Path Parameter — The catalog version identifier
Return type
Example data
Content-Type: application/json
{
"parentUid" : "SiteRootNode",
"uid" : "ElectronicsNavNode",
"entries" : [ {
"itemId" : "DigitalCompactsCategoryLink",
"itemType" : "CMSNavigationNode",
"itemSuperType" : "AbstractCMSComponent",
"name" : "My Account"
}, {
"itemId" : "DigitalCompactsCategoryLink",
"itemType" : "CMSNavigationNode",
"itemSuperType" : "AbstractCMSComponent",
"name" : "My Account"
} ],
"itemType" : "CMSNavigationNode",
"hasChildren" : false,
"name" : "My Account",
"position" : 3,
"title" : {
"EN" : "Homepage",
"DE" : "Startseite"
},
"uuid" : "uuid"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The navigation node identified by uid.
NavigationNodeData
400
When the Navigation Node has not been found (CMSItemNotFoundException).
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
delete /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/navigations/{uid}
Deletes navigation node. (removeNavigationNodeById)
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.
Path parameters
catalogId (required)
Path Parameter — The catalog name
siteId (required)
Path Parameter — The site identifier
uid (required)
Path Parameter — The navigation node's uid.
versionId (required)
Path Parameter — The catalog version identifier
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
No Content
400
When the Navigation Node has not been found (CMSItemNotFoundException).
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
put /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/navigations/{uid}
Updates navigation node. (replaceNavigationNodeById)
Provides new information to the navigation node for a given.navigation node uid. Deprecated since 1811, please use CMSItemController controller instead.
Path parameters
catalogId (required)
Path Parameter — The catalog name
siteId (required)
Path Parameter — The site identifier
uid (required)
Path Parameter — The navigation node uid to be updated.
versionId (required)
Path Parameter — The catalog version identifier
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The navigation node data
Return type
Example data
Content-Type: application/json
{
"parentUid" : "SiteRootNode",
"uid" : "ElectronicsNavNode",
"entries" : [ {
"itemId" : "DigitalCompactsCategoryLink",
"itemType" : "CMSNavigationNode",
"itemSuperType" : "AbstractCMSComponent",
"name" : "My Account"
}, {
"itemId" : "DigitalCompactsCategoryLink",
"itemType" : "CMSNavigationNode",
"itemSuperType" : "AbstractCMSComponent",
"name" : "My Account"
} ],
"itemType" : "CMSNavigationNode",
"hasChildren" : false,
"name" : "My Account",
"position" : 3,
"title" : {
"EN" : "Homepage",
"DE" : "Startseite"
},
"uuid" : "uuid"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
NavigationNodeData
400
When the Navigation Node has not been found (CMSItemNotFoundException) or if there is any validation error (WebserviceValidationException).
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
get /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pagesrestrictions
Gets restrictions for all pages. (getAllPagesRestrictionsByPageIds)
Finds restrictions for all pages.
Path parameters
catalogId (required)
Path Parameter — The catalog name
siteId (required)
Path Parameter — The site identifier
versionId (required)
Path Parameter — The catalog version identifier
Return type
Example data
Content-Type: application/json
{
"pageRestrictionList" : [ {
"restrictionId" : "restrictionId",
"pageId" : "homepage"
}, {
"restrictionId" : "restrictionId",
"pageId" : "homepage"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
item 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
Up
put /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pagesrestrictions/pages/{pageId}
Updates page restrictions. (replacePageRestrictionListData)
Replaces an existing list of page-restriction relations with a new relations for the given page id.
Path parameters
catalogId (required)
Path Parameter — The catalog name
pageId (required)
Path Parameter — Page identifier
siteId (required)
Path Parameter — The site identifier
versionId (required)
Path Parameter — The catalog version identifier
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — List of PageRestrictionData
Return type
Example data
Content-Type: application/json
{
"pageRestrictionList" : [ {
"restrictionId" : "restrictionId",
"pageId" : "homepage"
}, {
"restrictionId" : "restrictionId",
"pageId" : "homepage"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
item 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).
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
post /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pagescontentslotscomponents
Adds component to slot. (doAddComponentToSlot)
Inserts a new content component item to a slot for a given catalog and site ids.
Path parameters
catalogId (required)
Path Parameter — The catalog id
siteId (required)
Path Parameter — The site identifier
versionId (required)
Path Parameter — The catalog version identifier
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — PageContentSlotComponentData
Return type
Example data
Content-Type: application/json
{
"componentId" : "AbstractCMSComponent",
"slotId" : "Section1Slot-Homepage",
"position" : 1,
"pageId" : "homepage",
"componentUuid" : "componentUuid"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
PageContentSlotComponentData
PageContentSlotComponentData
201
Created
PageContentSlotComponentData
400
When component item does not exist (CMSItemNotFoundException) or when validation errors are found (WebserviceValidationException).
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
get /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pagescontentslotscomponents
Gets components by page. (getComponentByPage)
Retrieves a list of available components for a given page.
Path parameters
catalogId (required)
Path Parameter — The catalog id
siteId (required)
Path Parameter — The site identifier
versionId (required)
Path Parameter — The catalog version identifier
Query parameters
pageId (required)
Query Parameter — Identifier of the page
Return type
Example data
Content-Type: application/json
{
"pageContentSlotComponentList" : [ {
"componentId" : "AbstractCMSComponent",
"slotId" : "Section1Slot-Homepage",
"position" : 1,
"pageId" : "homepage",
"componentUuid" : "componentUuid"
}, {
"componentId" : "AbstractCMSComponent",
"slotId" : "Section1Slot-Homepage",
"position" : 1,
"pageId" : "homepage",
"componentUuid" : "componentUuid"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
List of components defined for a given page
PageContentSlotComponentListData
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
delete /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pagescontentslotscomponents/contentslots/{slotId}/components/{componentId}
Removes component. (removeComponent)
Deletes a specific component item from a content slot for a given catalog and site ids.
Path parameters
catalogId (required)
Path Parameter — The catalog id
componentId (required)
Path Parameter — Component identifier of the component to be removed
siteId (required)
Path Parameter — The site identifier
slotId (required)
Path Parameter — Content slot identifier containing the component to be removed
versionId (required)
Path Parameter — The catalog version identifier
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
No Content
400
When the component or slot cannot be found (CMSItemNotFoundException) or when the component slot does not contain the component (ComponentNotFoundInSlotException)
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
put /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pagescontentslotscomponents/pages/{pageId}/contentslots/{slotId}/components/{componentId}
Moves component. (replaceComponent)
Relocates a specific component instance to a different content slot by changing its
position within the content slot on a given page.
Path parameters
catalogId (required)
Path Parameter — The catalog id
componentId (required)
Path Parameter — Component identifier
pageId (required)
Path Parameter — Page identifier
siteId (required)
Path Parameter — The site identifier
slotId (required)
Path Parameter — Content slot identifier
versionId (required)
Path Parameter — The catalog version identifier
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — PageContentSlotComponentData
Return type
Example data
Content-Type: application/json
{
"componentId" : "AbstractCMSComponent",
"slotId" : "Section1Slot-Homepage",
"position" : 1,
"pageId" : "homepage",
"componentUuid" : "componentUuid"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
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).
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
get /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pagescontentslotscontainers
Gets containers by page. (getContainersByPage)
Fetches a list of available containers on a given page.
Path parameters
catalogId (required)
Path Parameter — The catalog id
siteId (required)
Path Parameter — The site identifier
versionId (required)
Path Parameter — The catalog version identifier
Query parameters
pageId (required)
Query Parameter — The page identifier
Return type
Example data
Content-Type: application/json
{
"pageContentSlotContainerList" : [ {
"components" : [ "components", "components" ],
"containerType" : "containerType",
"slotId" : "Section1Slot-Homepage",
"containerId" : "containerId",
"pageId" : "homepage"
}, {
"components" : [ "components", "components" ],
"containerType" : "containerType",
"slotId" : "Section1Slot-Homepage",
"containerId" : "containerId",
"pageId" : "homepage"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The list of page content slot containers
PageContentSlotContainerListData
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
get /v1/catalogs/{catalogId}/versions/{versionId}/pages/{pageId}/contentslots/{slotId}/typerestrictions
Gets type restrictions for content slot. (getTypeRestrictionForContentSlot)
Retrieves a list of available type restrictions for a given page id and content slot id.
Path parameters
catalogId (required)
Path Parameter — The catalog id
pageId (required)
Path Parameter — The page identifier
slotId (required)
Path Parameter — The slot identifier
versionId (required)
Path Parameter — The catalog version identifier
Return type
Example data
Content-Type: application/json
{
"validComponentTypes" : [ "ProductFeatureComponent", "CategoryFeatureComponent" ],
"contentSlotUid" : "Section1Slot-Homepage"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
item providing the mapping
ContentSlotTypeRestrictionsData
400
When the page/slot cannot be found (CMSItemNotFoundException)
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
post /v1/catalogs/{catalogId}/versions/{versionId}/pages/{pageId}/typerestrictions
Gets type restrictions for the provided content slots. (searchTypeRestrictionBySlotIds)
Retrieves a list of available type restrictions for the given slotId's.
Path parameters
catalogId (required)
Path Parameter — The catalog id
pageId (required)
Path Parameter — The page identifier
versionId (required)
Path Parameter — The catalog version identifier
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Map representing the content slots for which to retrieve type restrictions
Return type
Example data
Content-Type: application/json
{
"validComponentTypes" : [ "ProductFeatureComponent", "CategoryFeatureComponent" ],
"contentSlotUid" : "Section1Slot-Homepage"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
item providing the mapping
ContentSlotTypeRestrictionsData
400
When slot(s) for slotId(s) cannot be found (CMSItemNotFoundException)
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
get /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pagescontentslots
Gets content slots by page. (getContentSlotByPage)
Retrieves a list of available content slots defined on the page specified by the page id.
Path parameters
catalogId (required)
Path Parameter — The catalog id
siteId (required)
Path Parameter — The site identifier
versionId (required)
Path Parameter — The catalog version identifier
Query parameters
pageId (required)
Query Parameter — Identifier of the page
Return type
Example data
Content-Type: application/json
{
"pageContentSlotList" : [ {
"slotStatus" : "slotStatus",
"slotShared" : true,
"slotId" : "Section1Slot-Homepage",
"position" : "1",
"pageId" : "homepage"
}, {
"slotStatus" : "slotStatus",
"slotShared" : true,
"slotId" : "Section1Slot-Homepage",
"position" : "1",
"pageId" : "homepage"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
item 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
Up
get /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pagetemplates
Finds page templates by page type. (getPageTemplatesByPageType)
Returns a holder of a collection of PageTemplateData filtered on the given data passed as query string.
Path parameters
catalogId (required)
Path Parameter — The catalog id
siteId (required)
Path Parameter — The site identifier
versionId (required)
Path Parameter — The catalog version identifier
Query parameters
active (optional)
Query Parameter — When set to TRUE, filter the results for active templates
pageTypeCode (required)
Query Parameter — Item type of a page
Return type
Example data
Content-Type: application/json
{
"templates" : [ {
"uid" : "ProductDetailsPageTemplate",
"previewIcon" : "previewIcon",
"name" : "homepage",
"frontEndName" : "product/productLayout2Page",
"uuid" : "uuid"
}, {
"uid" : "ProductDetailsPageTemplate",
"previewIcon" : "previewIcon",
"name" : "homepage",
"frontEndName" : "product/productLayout2Page",
"uuid" : "uuid"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
List of page templates
PageTemplateListData
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
get /v1/pagetypesrestrictiontypes
Gets restriction types by page type. (getRestictionTypesByPageType)
Retrieves a list of available restrictions types for a given page type.
Return type
Example data
Content-Type: application/json
{
"pageTypeRestrictionTypeList" : [ {
"pageType" : "ContentPage",
"restrictionType" : "CMSUserGroupRestriction"
}, {
"pageType" : "ContentPage",
"restrictionType" : "CMSUserGroupRestriction"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
item 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
Finds all page types. (getAllPageTypes)
Retrieves a list of available page types.
Return type
Example data
Content-Type: application/json
{
"pageTypes" : [ {
"code" : "000000RW",
"name" : {
"key" : "name"
},
"description" : {
"key" : "description"
},
"type" : "ContentPage"
}, {
"code" : "000000RW",
"name" : {
"key" : "name"
},
"description" : {
"key" : "description"
},
"type" : "ContentPage"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The list of page types
PageTypeListData
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
get /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pages/{pageId}/fallbacks
Finds fallback pages. (getFallbackPages)
Retrieves a list of available fallback pages for a given page.
Path parameters
catalogId (required)
Path Parameter — The catalog name
pageId (required)
Path Parameter — The page identifier
siteId (required)
Path Parameter — The site identifier
versionId (required)
Path Parameter — The catalog version identifier
Return type
Example data
Content-Type: application/json
{
"uids" : [ "uids", "uids" ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
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).
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
get /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pages/{pageId}
Gets page by uid. (getPageByUid)
Retrieves a specific page instance that matches given page uid. Deprecated since 6.6, please use GET /v1/sites/{siteId}/cmsitems/{uuid} instead.
Path parameters
catalogId (required)
Path Parameter — The catalog id
pageId (required)
Path Parameter — Page identifier
siteId (required)
Path Parameter — The site identifier
versionId (required)
Path Parameter — The catalog version identifier
Return type
Example data
Content-Type: application/json
{
"template" : "LandingPageTemplate",
"uid" : "uid",
"defaultPage" : true,
"modifiedtime" : "yyyy-MM-dd HH:mm:ss+0000",
"onlyOneRestrictionMustApply" : false,
"name" : "homepage",
"creationtime" : "yyyy-MM-dd HH:mm:ss+0000",
"pk" : "8796093056052",
"title" : {
"EN" : "Homepage",
"DE" : "Startseite"
},
"uuid" : "uuid",
"typeCode" : "ContentPage"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Page data object
AbstractPageData
400
When the page cannot be found (CMSItemNotFoundException).
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
get /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pages
Finds pages by type. (getPagesByType)
Gets all default or variation pages that matches the given page type. Deprecated since 6.6, please use GET /v1/sites/{siteId}/cmsitems{?mask,typeCode,catalogId,catalogVersion,itemSearchParams,sort,pageSize,currentPage} instead.
Path parameters
catalogId (required)
Path Parameter — The catalog name
siteId (required)
Path Parameter — The site identifier
versionId (required)
Path Parameter — The catalog version identifier
Query parameters
defaultPage (required)
Query Parameter — Setting this to true will find all default pages; otherwise find all variation pages
typeCode (required)
Query Parameter — The type code of a page
Return type
Example data
Content-Type: application/json
{
"pages" : [ {
"template" : "LandingPageTemplate",
"uid" : "uid",
"defaultPage" : true,
"modifiedtime" : "yyyy-MM-dd HH:mm:ss+0000",
"onlyOneRestrictionMustApply" : false,
"name" : "homepage",
"creationtime" : "yyyy-MM-dd HH:mm:ss+0000",
"pk" : "8796093056052",
"title" : {
"EN" : "Homepage",
"DE" : "Startseite"
},
"uuid" : "uuid",
"typeCode" : "ContentPage"
}, {
"template" : "LandingPageTemplate",
"uid" : "uid",
"defaultPage" : true,
"modifiedtime" : "yyyy-MM-dd HH:mm:ss+0000",
"onlyOneRestrictionMustApply" : false,
"name" : "homepage",
"creationtime" : "yyyy-MM-dd HH:mm:ss+0000",
"pk" : "8796093056052",
"title" : {
"EN" : "Homepage",
"DE" : "Startseite"
},
"uuid" : "uuid",
"typeCode" : "ContentPage"
} ],
"pagination" : {
"count" : 0,
"totalPages" : 5,
"hasPrevious" : true,
"hasNext" : true,
"page" : 6,
"totalCount" : 1
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
All default or variation pages for a given page type
PageListData
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
get /v1/sites/{siteId}/catalogs/{catalogId}/versions/{versionId}/pages/{pageId}/variations
Finds variation pages. (getVariationPages)
Retrieves a list of available variation pages uid for a given page.
Path parameters
catalogId (required)
Path Parameter — The catalog name
pageId (required)
Path Parameter — The page identifier
siteId (required)
Path Parameter — The site identifier
versionId (required)
Path Parameter — The catalog version identifier
Return type
Example data
Content-Type: application/json
{
"uids" : [ "uids", "uids" ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
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).
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
get /v1/productcatalogs/{catalogId}/versions/{versionId}/categories/{code}
Gets category by code. (getCategoryByCode)
Finds a specific category that matches given product category code.
Path parameters
catalogId (required)
Path Parameter — The catalog id
code (required)
Path Parameter — Category code
versionId (required)
Path Parameter — The catalog version identifier
Return type
Example data
Content-Type: application/json
{
"catalogVersion" : "Staged",
"catalogId" : "electronicsContentCatalog",
"code" : "ProductPage",
"name" : {
"key" : "name"
},
"description" : {
"key" : "description"
},
"thumbnailMediaCode" : "thumbnailMediaCode"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
CategoryData
CategoryData
400
When the item has not been found (CMSItemNotFoundException) or when there was problem during conversion (ConversionException).
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
get /v1/productcatalogs/{catalogId}/versions/{versionId}/categories
Finds product categories by text. (getProductCategoriesByText)
Retrieves a list of available product categories that match a free text search field.
Path parameters
catalogId (required)
Path Parameter — The catalog id
versionId (required)
Path Parameter — The catalog version identifier
Query parameters
currentPage (optional)
Query Parameter — The requested page number
mask (optional)
Query Parameter — The string value on which products will be filtered
pageSize (required)
Query Parameter — The maximum number of elements in the result list.
sort (optional)
Query Parameter — The string field the results will be sorted with
text (optional)
Query Parameter — The string value on which products will be filtered. Deprecated, use mask instead!
Return type
Example data
Content-Type: application/json
{
"productCategories" : [ {
"catalogVersion" : "Staged",
"catalogId" : "electronicsContentCatalog",
"code" : "ProductPage",
"name" : {
"key" : "name"
},
"description" : {
"key" : "description"
},
"thumbnailMediaCode" : "thumbnailMediaCode"
}, {
"catalogVersion" : "Staged",
"catalogId" : "electronicsContentCatalog",
"code" : "ProductPage",
"name" : {
"key" : "name"
},
"description" : {
"key" : "description"
},
"thumbnailMediaCode" : "thumbnailMediaCode"
} ],
"pagination" : {
"count" : 0,
"totalPages" : 5,
"hasPrevious" : true,
"hasNext" : true,
"page" : 6,
"totalCount" : 1
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
item which serves as a wrapper object that contains a list of CategoryData, never null.
CategoryDataListData
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
get /v1/productcatalogs/{catalogId}/versions/{versionId}/products/{code}
Gets product by code. (getProductByCode)
Retrieves a specific product item that matches given product code.
Path parameters
catalogId (required)
Path Parameter — The catalog name
code (required)
Path Parameter — Product code
versionId (required)
Path Parameter — The catalog version identifier
Return type
Example data
Content-Type: application/json
{
"catalogVersion" : "Online",
"catalogId" : "electronicsContentCatalog",
"code" : "489702",
"name" : {
"key" : "name"
},
"description" : {
"key" : "description"
},
"thumbnailMediaCode" : "thumbnailMediaCode"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
ProductData
ProductData
400
When the item has not been found (CMSItemNotFoundException) or when there was problem during conversion (ConversionException).
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
get /v1/productcatalogs/{catalogId}/versions/{versionId}/products
Gets products by text. (getProductsByText)
Finds a list of available products that match a free text search field.
Path parameters
catalogId (required)
Path Parameter — The catalog name
versionId (required)
Path Parameter — The catalog version identifier
Query parameters
currentPage (optional)
Query Parameter — The requested page number
mask (optional)
Query Parameter — The string value on which products will be filtered
pageSize (required)
Query Parameter — The maximum number of elements in the result list.
sort (optional)
Query Parameter — The string field the results will be sorted with
text (optional)
Query Parameter — The string value on which products will be filtered. Deprecated, use mask instead!
Return type
Example data
Content-Type: application/json
{
"pagination" : {
"count" : 0,
"totalPages" : 5,
"hasPrevious" : true,
"hasNext" : true,
"page" : 6,
"totalCount" : 1
},
"products" : [ {
"catalogVersion" : "Online",
"catalogId" : "electronicsContentCatalog",
"code" : "489702",
"name" : {
"key" : "name"
},
"description" : {
"key" : "description"
},
"thumbnailMediaCode" : "thumbnailMediaCode"
}, {
"catalogVersion" : "Online",
"catalogId" : "electronicsContentCatalog",
"code" : "489702",
"name" : {
"key" : "name"
},
"description" : {
"key" : "description"
},
"thumbnailMediaCode" : "thumbnailMediaCode"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
item which serves as a wrapper object that contains a list of ProductData, never null.
ProductDataListData
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
get /v1/restrictiontypes
Finds all restriction types. (getAllRestrictionTypes)
Retrieves a list of available restriction types.
Return type
Example data
Content-Type: application/json
{
"restrictionTypes" : [ {
"code" : "000000RW",
"name" : {
"key" : "name"
},
"description" : {
"key" : "description"
}
}, {
"code" : "000000RW",
"name" : {
"key" : "name"
},
"description" : {
"key" : "description"
}
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
List of restriction types
RestrictionTypeListData
401
Must be authenticated as an Admin or CMS Manager to access this resource
Gets all sites. (getAllSites)
Retrieves a list of available sites.
Return type
Example data
Content-Type: application/json
{
"sites" : [ {
"contentCatalogs" : [ "apparel-deContentCatalog" ],
"uid" : "apparel-de",
"previewUrl" : "/storefront/?site=apparel-de",
"name" : {
"en" : "Apparel Site DE",
"de" : "Bekleidungs-Website DE"
}
}, {
"contentCatalogs" : [ "apparel-deContentCatalog" ],
"uid" : "apparel-de",
"previewUrl" : "/storefront/?site=apparel-de",
"name" : {
"en" : "Apparel Site DE",
"de" : "Bekleidungs-Website DE"
}
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A list of all sites configured, never null.
SiteListData
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
post /v1/sites/catalogs
Gets sites for catalogs by ids. (searchSitesByCatalogs)
Retrieves a list of available sites that match given list of catalog ids by posting the
catalogIds in the request body.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — List of catalog identifiers
Return type
Example data
Content-Type: application/json
{
"sites" : [ {
"contentCatalogs" : [ "apparel-deContentCatalog" ],
"uid" : "apparel-de",
"previewUrl" : "/storefront/?site=apparel-de",
"name" : {
"en" : "Apparel Site DE",
"de" : "Bekleidungs-Website DE"
}
}, {
"contentCatalogs" : [ "apparel-deContentCatalog" ],
"uid" : "apparel-de",
"previewUrl" : "/storefront/?site=apparel-de",
"name" : {
"en" : "Apparel Site DE",
"de" : "Bekleidungs-Website DE"
}
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
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
Gets all component types. (getAllComponentTypes)
Retrieves a list of all component types.
Query parameters
readOnly (optional)
Query Parameter — Read only mode for attributes default: false
Return type
Example data
Content-Type: application/json
{
"componentTypes" : [ {
"code" : "ContentPage",
"i18nKey" : "type.searchboxcomponent.name",
"name" : "Link",
"attributes" : [ {
"paged" : false,
"dependsOn" : "dependsOn",
"containedTypes" : [ "MediaFormat", "MediaContainer" ],
"editable" : false,
"localized" : false,
"subTypes" : {
"CMSUserGroupRestriction" : "type.cmsusergrouprestriction.name",
"CMSCampaignRestriction" : "type.cmscampaignrestriction.name"
},
"collection" : false,
"params" : {
"typeCode" : "AbstractRestriction"
},
"uri" : "uri",
"required" : false,
"cmsStructureType" : "ShortString",
"i18nKey" : "type.searchboxcomponent.name",
"idAttribute" : "value",
"qualifier" : "cmsComponents",
"labelAttributes" : [ "label" ],
"options" : [ {
"id" : "id",
"label" : "label"
}, {
"id" : "id",
"label" : "label"
} ],
"placeholder" : "Select or create an entry",
"cmsStructureEnumType" : "cmsStructureEnumType"
}, {
"paged" : false,
"dependsOn" : "dependsOn",
"containedTypes" : [ "MediaFormat", "MediaContainer" ],
"editable" : false,
"localized" : false,
"subTypes" : {
"CMSUserGroupRestriction" : "type.cmsusergrouprestriction.name",
"CMSCampaignRestriction" : "type.cmscampaignrestriction.name"
},
"collection" : false,
"params" : {
"typeCode" : "AbstractRestriction"
},
"uri" : "uri",
"required" : false,
"cmsStructureType" : "ShortString",
"i18nKey" : "type.searchboxcomponent.name",
"idAttribute" : "value",
"qualifier" : "cmsComponents",
"labelAttributes" : [ "label" ],
"options" : [ {
"id" : "id",
"label" : "label"
}, {
"id" : "id",
"label" : "label"
} ],
"placeholder" : "Select or create an entry",
"cmsStructureEnumType" : "cmsStructureEnumType"
} ],
"category" : "Page",
"type" : "SearchBoxComponent"
}, {
"code" : "ContentPage",
"i18nKey" : "type.searchboxcomponent.name",
"name" : "Link",
"attributes" : [ {
"paged" : false,
"dependsOn" : "dependsOn",
"containedTypes" : [ "MediaFormat", "MediaContainer" ],
"editable" : false,
"localized" : false,
"subTypes" : {
"CMSUserGroupRestriction" : "type.cmsusergrouprestriction.name",
"CMSCampaignRestriction" : "type.cmscampaignrestriction.name"
},
"collection" : false,
"params" : {
"typeCode" : "AbstractRestriction"
},
"uri" : "uri",
"required" : false,
"cmsStructureType" : "ShortString",
"i18nKey" : "type.searchboxcomponent.name",
"idAttribute" : "value",
"qualifier" : "cmsComponents",
"labelAttributes" : [ "label" ],
"options" : [ {
"id" : "id",
"label" : "label"
}, {
"id" : "id",
"label" : "label"
} ],
"placeholder" : "Select or create an entry",
"cmsStructureEnumType" : "cmsStructureEnumType"
}, {
"paged" : false,
"dependsOn" : "dependsOn",
"containedTypes" : [ "MediaFormat", "MediaContainer" ],
"editable" : false,
"localized" : false,
"subTypes" : {
"CMSUserGroupRestriction" : "type.cmsusergrouprestriction.name",
"CMSCampaignRestriction" : "type.cmscampaignrestriction.name"
},
"collection" : false,
"params" : {
"typeCode" : "AbstractRestriction"
},
"uri" : "uri",
"required" : false,
"cmsStructureType" : "ShortString",
"i18nKey" : "type.searchboxcomponent.name",
"idAttribute" : "value",
"qualifier" : "cmsComponents",
"labelAttributes" : [ "label" ],
"options" : [ {
"id" : "id",
"label" : "label"
}, {
"id" : "id",
"label" : "label"
} ],
"placeholder" : "Select or create an entry",
"cmsStructureEnumType" : "cmsStructureEnumType"
} ],
"category" : "Page",
"type" : "SearchBoxComponent"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
item which serves as a wrapper object that contains a list of ComponentTypeData, never
ComponentTypeListData
401
Must be authenticated as an Admin or CMS Manager to access this resource
Gets component type by code. (getComponentTypeByCode)
Retrieves a specific instance of the CMS component type for a given code.
Path parameters
code (required)
Path Parameter — Component type code
Query parameters
readOnly (optional)
Query Parameter — Read only mode for attributes default: false
Return type
Example data
Content-Type: application/json
{
"code" : "ContentPage",
"i18nKey" : "type.searchboxcomponent.name",
"name" : "Link",
"attributes" : [ {
"paged" : false,
"dependsOn" : "dependsOn",
"containedTypes" : [ "MediaFormat", "MediaContainer" ],
"editable" : false,
"localized" : false,
"subTypes" : {
"CMSUserGroupRestriction" : "type.cmsusergrouprestriction.name",
"CMSCampaignRestriction" : "type.cmscampaignrestriction.name"
},
"collection" : false,
"params" : {
"typeCode" : "AbstractRestriction"
},
"uri" : "uri",
"required" : false,
"cmsStructureType" : "ShortString",
"i18nKey" : "type.searchboxcomponent.name",
"idAttribute" : "value",
"qualifier" : "cmsComponents",
"labelAttributes" : [ "label" ],
"options" : [ {
"id" : "id",
"label" : "label"
}, {
"id" : "id",
"label" : "label"
} ],
"placeholder" : "Select or create an entry",
"cmsStructureEnumType" : "cmsStructureEnumType"
}, {
"paged" : false,
"dependsOn" : "dependsOn",
"containedTypes" : [ "MediaFormat", "MediaContainer" ],
"editable" : false,
"localized" : false,
"subTypes" : {
"CMSUserGroupRestriction" : "type.cmsusergrouprestriction.name",
"CMSCampaignRestriction" : "type.cmscampaignrestriction.name"
},
"collection" : false,
"params" : {
"typeCode" : "AbstractRestriction"
},
"uri" : "uri",
"required" : false,
"cmsStructureType" : "ShortString",
"i18nKey" : "type.searchboxcomponent.name",
"idAttribute" : "value",
"qualifier" : "cmsComponents",
"labelAttributes" : [ "label" ],
"options" : [ {
"id" : "id",
"label" : "label"
}, {
"id" : "id",
"label" : "label"
} ],
"placeholder" : "Select or create an entry",
"cmsStructureEnumType" : "cmsStructureEnumType"
} ],
"category" : "Page",
"type" : "SearchBoxComponent"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
item which serves as a wrapper object that contains a ComponentTypeData
ComponentTypeData
400
When the code provided does not match any existing type(ComponentTypeNotFoundException).
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
get /v1/usergroups/{userGroupId}
Gets user group by id. (getUserGroupById)
Retrieves a specific user group instance that matches the given id.
Path parameters
userGroupId (required)
Path Parameter — The unique identifier of the user group
Return type
Example data
Content-Type: application/json
{
"uid" : "admin",
"name" : {
"key" : "name"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
UserGroupData
UserGroupData
400
When the user group was not found (CMSItemNotFoundException) or when there was problem during conversion (ConversionException).
401
Must be authenticated as an Admin or CMS Manager to access this resource
Finds user group by text. (getUserGroupsByText)
Retrieves a list of available user groups using a free text search field.
Query parameters
currentPage (optional)
Query Parameter — The requested page number
mask (optional)
Query Parameter — The string value on which products will be filtered
pageSize (required)
Query Parameter — The maximum number of elements in the result list.
sort (optional)
Query Parameter — The string field the results will be sorted with
Return type
Example data
Content-Type: application/json
{
"userGroups" : [ {
"uid" : "admin",
"name" : {
"key" : "name"
}
}, {
"uid" : "admin",
"name" : {
"key" : "name"
}
} ],
"pagination" : {
"count" : 0,
"totalPages" : 5,
"hasPrevious" : true,
"hasNext" : true,
"page" : 6,
"totalCount" : 1
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
item which serves as a wrapper object that contains a list of UserGroupData; never null
UserGroupListData
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
get /v1/users/{userId}
Gets user by id. (getUserDataById)
Retrieves a specific user instance that matches given id.
Path parameters
userId (required)
Path Parameter — The unique identifier of the user
Return type
Example data
Content-Type: application/json
{
"uid" : "uid",
"writeableLanguages" : [ "de", "hi" ],
"readableLanguages" : [ "de", "hi" ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
UserDataInfo
UserDataData
400
When the user was not found (CMSItemNotFoundException) or when there was a problem during conversion (ConversionException).
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
post /v1/sites/{siteId}/cmsitems/{itemUUID}/versions
Creates a CMSVersion for an item. (createVersion)
Generates a new instance of the CMSVersion for the item identified by its itemUUID.
Path parameters
itemUUID (required)
Path Parameter — The uuid of the item
siteId (required)
Path Parameter — The site identifier
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The item object containing the label and description
Return type
Example data
Content-Type: application/json
{
"itemUUID" : "itemUUID",
"uid" : "00000000",
"description" : "description",
"creationtime" : "yyyy-MM-dd HH:mm:ss+0000",
"label" : "2.0"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
The item containing version info.
CMSVersionData
400
If there is any validation error (WebserviceValidationException).
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
post /v1/sites/{siteId}/cmsitems/{itemUUID}/versions/{versionId}/rollbacks
Rolls back an item to a specific CMSVersion. (doRollbackVersion)
Sets a CMSversion of the item identified by its itemUUID to a previously
saved CMSVersion.
Path parameters
itemUUID (required)
Path Parameter — The uuid of the item
siteId (required)
Path Parameter — The site identifier
versionId (required)
Path Parameter — The uid of the cms version.
Consumes
This API call consumes the following media types via the request header:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
No Content
400
If there is any validation error (WebserviceValidationException).
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
get /v1/sites/{siteId}/cmsitems/{itemUUID}/versions/{versionId}
Gets a specific version for an item. (getVersion)
Retrieves a CMSVersion identified by its uid and for the item identified by its itemUUID.
Path parameters
itemUUID (required)
Path Parameter — The uuid of the item
siteId (required)
Path Parameter — The site identifier
versionId (required)
Path Parameter — The uid of the cms version.
Return type
Example data
Content-Type: application/json
{
"itemUUID" : "itemUUID",
"uid" : "00000000",
"description" : "description",
"creationtime" : "yyyy-MM-dd HH:mm:ss+0000",
"label" : "2.0"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The item containing version info.
CMSVersionData
400
When the version has not been found (CMSVersionNotFoundException)
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
get /v1/sites/{siteId}/cmsitems/{itemUUID}/versions
Gets all versions for an item filtered by a mask. (getVersionsForItem)
Retrieves a list of available CMSVersions by a search mask for the item identified by its itemUUID.
Path parameters
itemUUID (required)
Path Parameter — The uuid of the item
siteId (required)
Path Parameter — The site identifier
Query parameters
currentPage (optional)
Query Parameter — The current result page requested
mask (optional)
Query Parameter — Search mask applied to the LABEL field only. Uses partial matching.
pageSize (optional)
Query Parameter — Page size for paging
Return type
Example data
Content-Type: application/json
{
"pagination" : {
"count" : 0,
"totalPages" : 5,
"hasPrevious" : true,
"hasNext" : true,
"page" : 6,
"totalCount" : 1
},
"results" : [ {
"creationtime" : "2019-12-23T19:35:35+0000",
"itemUUID" : "eyJpd",
"label" : "newVersion",
"uid" : "00000000"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
item which serves as a wrapper object that contains a list of CMSVersionData; never null
CMSVersionListData
400
When the item has not been found (CMSItemNotFoundException)
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
delete /v1/sites/{siteId}/cmsitems/{itemUUID}/versions/{versionId}
Deletes a CMSVersion for an item. (removeVersion)
Removes a specific instance of the CMSVersion identified by its uid and for the item identified
by its itemUUID.
Path parameters
itemUUID (required)
Path Parameter — The uuid of the item
siteId (required)
Path Parameter — The site identifier
versionId (required)
Path Parameter — The uid of the cms version.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
No Content
400
If there is any validation error (WebserviceValidationException).
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
put /v1/sites/{siteId}/cmsitems/{itemUUID}/versions/{versionId}
Updates a CMSVersion for an item. (replaceVersion)
Replaces an existing CMSVersion identified by its uid for the item identified
by its itemUUID.
Path parameters
itemUUID (required)
Path Parameter — The uuid of the item
siteId (required)
Path Parameter — The site identifier
versionId (required)
Path Parameter — The uid of the cms version.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The item object containing the label and description
Return type
Example data
Content-Type: application/json
{
"itemUUID" : "itemUUID",
"uid" : "00000000",
"description" : "description",
"creationtime" : "yyyy-MM-dd HH:mm:ss+0000",
"label" : "2.0"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The item containing version info.
CMSVersionData
400
If there is any validation error (WebserviceValidationException).
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
get /v1/catalogs/{catalogId}/versions/{versionId}/workflows/{workflowCode}/actions/{actionCode}/comments
Gets workflow action comments. (getActionComments)
Retrieves a list of available workflow action comments for a specific workflow item.
Path parameters
actionCode (required)
Path Parameter — The code of the workflow action
catalogId (required)
Path Parameter — The id of the catalog
versionId (required)
Path Parameter — The version of the catalog
workflowCode (required)
Path Parameter — The code of the workflow
Return type
Example data
Content-Type: application/json
{
"comments" : [ {
"code" : "code",
"authorName" : "authorName",
"originalActionCode" : "originalActionCode",
"creationtime" : "yyyy-MM-dd HH:mm:ss+0000",
"text" : "text",
"decisionCode" : "decisionCode",
"createdAgoInMillis" : 128334524,
"decisionName" : "decisionName"
}, {
"code" : "code",
"authorName" : "authorName",
"originalActionCode" : "originalActionCode",
"creationtime" : "yyyy-MM-dd HH:mm:ss+0000",
"text" : "text",
"decisionCode" : "decisionCode",
"createdAgoInMillis" : 128334524,
"decisionName" : "decisionName"
} ],
"pagination" : {
"count" : 0,
"totalPages" : 5,
"hasPrevious" : true,
"hasNext" : true,
"page" : 6,
"totalCount" : 1
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The item containing the workflow action comments.
CMSCommentListData
401
Must be authenticated as an Admin or CMS Manager to access this resource
404
When no workflow or workflow action is found matching the given code (UnknownIdentifierException).
Up
get /v1/catalogs/{catalogId}/versions/{versionId}/workflows/{workflowCode}/actions
Gets a list of actions. (getActionsByWorkflowCode)
Retrieves a list of available actions for a given workflow item, catalog and version ids.
Path parameters
catalogId (required)
Path Parameter — The id of the catalog
versionId (required)
Path Parameter — The version of the catalog
workflowCode (required)
Path Parameter — The code of the workflow
Return type
Example data
Content-Type: application/json
{
"createVersion" : true,
"workflowCode" : "000000RV",
"canModifyItemInWorkflow" : true,
"attachments" : [ "attachments", "attachments" ],
"description" : "description",
"isAvailableForCurrentPrincipal" : true,
"label" : "label",
"templateCode" : "PageTranslation",
"actions" : [ {
"isCurrentUserParticipant" : true,
"actionType" : "START",
"code" : "0000000C",
"name" : "Approve",
"description" : "Decision for approving content",
"decisions" : [ {
"code" : "PageTranslationSendDEForReview",
"description" : "Decision for sending DE language for review",
"name" : "Send for Review"
} ],
"startedAgoInMillis" : 5283,
"status" : "IN_PROGRESS"
}, {
"isCurrentUserParticipant" : true,
"actionType" : "START",
"code" : "0000000C",
"name" : "Approve",
"description" : "Decision for approving content",
"decisions" : [ {
"code" : "PageTranslationSendDEForReview",
"description" : "Decision for sending DE language for review",
"name" : "Send for Review"
} ],
"startedAgoInMillis" : 5283,
"status" : "IN_PROGRESS"
} ],
"status" : "RUNNING"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The item containing the workflow items actions and decisions.
CMSWorkflowData
401
Must be authenticated as an Admin or CMS Manager to access this resource
404
When no workflow is found matching the given code (UnknownIdentifierException).
Up
post /v1/catalogs/{catalogId}/versions/{versionId}/workflows/{workflowId}/operations
Performs different operations on the workflow item. (doPerfomActionOnWorkflow)
Executes various actions, such as canceling a workflow, on the workflow item.
Path parameters
catalogId (required)
Path Parameter — The catalog identifier
versionId (required)
Path Parameter — The catalog version identifier
workflowId (required)
Path Parameter — The code of the workflow
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The item object containing all the information about operation to be performed
Return type
Example data
Content-Type: application/json
{
"createVersion" : true,
"workflowCode" : "000000RV",
"canModifyItemInWorkflow" : true,
"attachments" : [ "attachments", "attachments" ],
"description" : "description",
"isAvailableForCurrentPrincipal" : true,
"label" : "label",
"templateCode" : "PageTranslation",
"actions" : [ {
"isCurrentUserParticipant" : true,
"actionType" : "START",
"code" : "0000000C",
"name" : "Approve",
"description" : "Decision for approving content",
"decisions" : [ {
"code" : "PageTranslationSendDEForReview",
"description" : "Decision for sending DE language for review",
"name" : "Send for Review"
} ],
"startedAgoInMillis" : 5283,
"status" : "IN_PROGRESS"
}, {
"isCurrentUserParticipant" : true,
"actionType" : "START",
"code" : "0000000C",
"name" : "Approve",
"description" : "Decision for approving content",
"decisions" : [ {
"code" : "PageTranslationSendDEForReview",
"description" : "Decision for sending DE language for review",
"name" : "Send for Review"
} ],
"startedAgoInMillis" : 5283,
"status" : "IN_PROGRESS"
} ],
"status" : "RUNNING"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The workflow item.
CMSWorkflowData
400
When the payload does not have the 'operation' property. (IllegalArgumentException)
401
Must be authenticated as an Admin or CMS Manager to access this resource
404
When the item has not been found (UnknownIdentifierException)
Up
get /v1/catalogs/{catalogId}/versions/{versionId}/workflowtemplates
Gets Workflow templates for catalog version. (getWorkflowTemplatesForCatalogVersion)
Retrieves the list of available workflow templates for given catalogId and versionId.
Path parameters
catalogId (required)
Path Parameter — The catalog id
versionId (required)
Path Parameter — The catalog version identifier
Return type
Example data
Content-Type: application/json
{
"templates" : [ {
"code" : "000000RS",
"name" : "Page Translation"
}, {
"code" : "000000RS",
"name" : "Page Translation"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
WorkflowTemplateListData
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
post /v1/catalogs/{catalogId}/versions/{versionId}/workflows
Creates and start a new workflow. (doCreateWorkflow)
Generates a workflow instance containing CmsItems. The workflow is automatically started upon generation.
Path parameters
catalogId (required)
Path Parameter — The id of the catalog
versionId (required)
Path Parameter — The version of the catalog
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The item object containing all the information about the workflow to create
Return type
Example data
Content-Type: application/json
{
"createVersion" : true,
"workflowCode" : "000000RV",
"canModifyItemInWorkflow" : true,
"attachments" : [ "attachments", "attachments" ],
"description" : "description",
"isAvailableForCurrentPrincipal" : true,
"label" : "label",
"templateCode" : "PageTranslation",
"actions" : [ {
"isCurrentUserParticipant" : true,
"actionType" : "START",
"code" : "0000000C",
"name" : "Approve",
"description" : "Decision for approving content",
"decisions" : [ {
"code" : "PageTranslationSendDEForReview",
"description" : "Decision for sending DE language for review",
"name" : "Send for Review"
} ],
"startedAgoInMillis" : 5283,
"status" : "IN_PROGRESS"
}, {
"isCurrentUserParticipant" : true,
"actionType" : "START",
"code" : "0000000C",
"name" : "Approve",
"description" : "Decision for approving content",
"decisions" : [ {
"code" : "PageTranslationSendDEForReview",
"description" : "Decision for sending DE language for review",
"name" : "Send for Review"
} ],
"startedAgoInMillis" : 5283,
"status" : "IN_PROGRESS"
} ],
"status" : "RUNNING"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
The item containing the workflow info.
CMSWorkflowData
400
If there is any validation error (WebserviceValidationException).
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
get /v1/catalogs/{catalogId}/versions/{versionId}/workflows
Finds all workflows containing the given attachments. (getAllWorkflowsForAttachments)
Retrieves a list of available workflow instances that has the given CMSItem uuids as an attachment to the workflow.
Path parameters
catalogId (required)
Path Parameter — The id of the catalog
versionId (required)
Path Parameter — The version of the catalog
Query parameters
attachment (optional)
Query Parameter — The uuid of the CMSItem attached to the workflow
currentPage (required)
Query Parameter — Catalog on which to search
pageSize (required)
Query Parameter — Page size for paging
sort (optional)
Query Parameter — The requested ordering for the search results.
statuses (optional)
Query Parameter — The list of workflow statues. When none provided, the default statuses are set to RUNNING and PAUSED. This will return all active workflows.
Return type
Example data
Content-Type: application/json
{
"createVersion" : true,
"workflowCode" : "000000RV",
"canModifyItemInWorkflow" : true,
"attachments" : [ "attachments", "attachments" ],
"description" : "description",
"isAvailableForCurrentPrincipal" : true,
"label" : "label",
"templateCode" : "PageTranslation",
"actions" : [ {
"isCurrentUserParticipant" : true,
"actionType" : "START",
"code" : "0000000C",
"name" : "Approve",
"description" : "Decision for approving content",
"decisions" : [ {
"code" : "PageTranslationSendDEForReview",
"description" : "Decision for sending DE language for review",
"name" : "Send for Review"
} ],
"startedAgoInMillis" : 5283,
"status" : "IN_PROGRESS"
}, {
"isCurrentUserParticipant" : true,
"actionType" : "START",
"code" : "0000000C",
"name" : "Approve",
"description" : "Decision for approving content",
"decisions" : [ {
"code" : "PageTranslationSendDEForReview",
"description" : "Decision for sending DE language for review",
"name" : "Send for Review"
} ],
"startedAgoInMillis" : 5283,
"status" : "IN_PROGRESS"
} ],
"status" : "RUNNING"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The list of items containing the workflow info. Never null.
CMSWorkflowData
400
If there is any validation error (WebserviceValidationException).
401
Must be authenticated as an Admin or CMS Manager to access this resource
Up
get /v1/catalogs/{catalogId}/versions/{versionId}/workflows/{workflowCode}
Gets a workflow item. (getWorkflowByCode)
Retrieves a specific instance of the workflow for a given workflow code.
Path parameters
catalogId (required)
Path Parameter — The id of the catalog
versionId (required)
Path Parameter — The version of the catalog
workflowCode (required)
Path Parameter — The code of the workflow
Return type
Example data
Content-Type: application/json
{
"createVersion" : true,
"workflowCode" : "000000RV",
"canModifyItemInWorkflow" : true,
"attachments" : [ "attachments", "attachments" ],
"description" : "description",
"isAvailableForCurrentPrincipal" : true,
"label" : "label",
"templateCode" : "PageTranslation",
"actions" : [ {
"isCurrentUserParticipant" : true,
"actionType" : "START",
"code" : "0000000C",
"name" : "Approve",
"description" : "Decision for approving content",
"decisions" : [ {
"code" : "PageTranslationSendDEForReview",
"description" : "Decision for sending DE language for review",
"name" : "Send for Review"
} ],
"startedAgoInMillis" : 5283,
"status" : "IN_PROGRESS"
}, {
"isCurrentUserParticipant" : true,
"actionType" : "START",
"code" : "0000000C",
"name" : "Approve",
"description" : "Decision for approving content",
"decisions" : [ {
"code" : "PageTranslationSendDEForReview",
"description" : "Decision for sending DE language for review",
"name" : "Send for Review"
} ],
"startedAgoInMillis" : 5283,
"status" : "IN_PROGRESS"
} ],
"status" : "RUNNING"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The item containing the workflow item.
CMSWorkflowData
401
Must be authenticated as an Admin or CMS Manager to access this resource
404
When no workflow is found matching the given code (UnknownIdentifierException).
Up
put /v1/catalogs/{catalogId}/versions/{versionId}/workflows/{workflowCode}
Updates an existing workflow. (replaceWorkflow)
Provides a new workflow information for an existing workflow item.
Path parameters
catalogId (required)
Path Parameter — The id of the catalog
versionId (required)
Path Parameter — The version of the catalog
workflowCode (required)
Path Parameter — The code of the workflow
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The item object containing all the information about the workflow to edit
Return type
Example data
Content-Type: application/json
{
"createVersion" : true,
"workflowCode" : "000000RV",
"canModifyItemInWorkflow" : true,
"attachments" : [ "attachments", "attachments" ],
"description" : "description",
"isAvailableForCurrentPrincipal" : true,
"label" : "label",
"templateCode" : "PageTranslation",
"actions" : [ {
"isCurrentUserParticipant" : true,
"actionType" : "START",
"code" : "0000000C",
"name" : "Approve",
"description" : "Decision for approving content",
"decisions" : [ {
"code" : "PageTranslationSendDEForReview",
"description" : "Decision for sending DE language for review",
"name" : "Send for Review"
} ],
"startedAgoInMillis" : 5283,
"status" : "IN_PROGRESS"
}, {
"isCurrentUserParticipant" : true,
"actionType" : "START",
"code" : "0000000C",
"name" : "Approve",
"description" : "Decision for approving content",
"decisions" : [ {
"code" : "PageTranslationSendDEForReview",
"description" : "Decision for sending DE language for review",
"name" : "Send for Review"
} ],
"startedAgoInMillis" : 5283,
"status" : "IN_PROGRESS"
} ],
"status" : "RUNNING"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The item containing the workflow info.
CMSWorkflowData
400
If there is any validation error (WebserviceValidationException).
401
Must be authenticated as an Admin or CMS Manager to access this resource
404
When no workflow is found matching the given code (UnknownIdentifierException).
[ Jump to Methods ]
Table of Contents
AbstractPageData - AbstractPageDataCMSCommentData - CMSCommentDataCMSCommentListData - CMSCommentListDataCMSContentSlotIdListData - CMSContentSlotIdListDataCMSItemUuidListData - CMSItemUuidListDataCMSVersionData - CMSVersionDataCMSVersionListData - CMSVersionListDataCMSWorkflowActionData - CMSWorkflowActionDataCMSWorkflowData - CMSWorkflowDataCMSWorkflowDecisionData - CMSWorkflowDecisionDataCMSWorkflowOperationData - CMSWorkflowOperationDataCatalogDataListData - CatalogDataListDataCatalogVersionData - CatalogVersionDataCatalogVersionListData - CatalogVersionListDataCategoryData - CategoryDataCategoryDataListData - CategoryDataListDataComponentTypeAttributeData - ComponentTypeAttributeDataComponentTypeData - ComponentTypeDataComponentTypeListData - ComponentTypeListDataContentSlotTypeRestrictionsData - ContentSlotTypeRestrictionsDataDisplayConditionData - DisplayConditionDataHomePageData - HomePageDataItemSynchronizationData - ItemSynchronizationDataItemTypeData - ItemTypeDataLanguageData - LanguageDataLanguageListData - LanguageListDataMediaContainerData - MediaContainerDataMediaContainerListData - MediaContainerListDataMediaData - MediaDataMediaListData - MediaListDataNavigationEntryData - NavigationEntryDataNavigationNodeData - NavigationNodeDataNavigationNodeListData - NavigationNodeListDataOptionData - OptionDataPageContentSlotComponentData - PageContentSlotComponentDataPageContentSlotComponentListData - PageContentSlotComponentListDataPageContentSlotContainerData - PageContentSlotContainerDataPageContentSlotContainerListData - PageContentSlotContainerListDataPageContentSlotData - PageContentSlotDataPageContentSlotListData - PageContentSlotListDataPageListData - PageListDataPageRestrictionData - PageRestrictionDataPageRestrictionListData - PageRestrictionListDataPageTemplateData - PageTemplateDataPageTemplateListData - PageTemplateListDataPageTypeData - PageTypeDataPageTypeListData - PageTypeListDataPageTypeRestrictionTypeData - PageTypeRestrictionTypeDataPageTypeRestrictionTypeListData - PageTypeRestrictionTypeListDataProductData - ProductDataProductDataListData - ProductDataListDataRestrictionTypeData - RestrictionTypeDataRestrictionTypeListData - RestrictionTypeListDataSiteData - SiteDataSiteListData - SiteListDataSyncItemStatusData - SyncItemStatusDataSyncJobData - SyncJobDataSynchronizationData - SynchronizationDataUidListData - UidListDataUserDataData - UserDataDataUserGroupData - UserGroupDataUserGroupListData - UserGroupListDataWorkflowTemplateData - WorkflowTemplateDataWorkflowTemplateListData - WorkflowTemplateListDatapagination - pagination
Specifies properties of the page.
creationtime (optional)
example: yyyy-MM-dd HH:mm:ss+0000
defaultPage (optional)
example: true
modifiedtime (optional)
example: yyyy-MM-dd HH:mm:ss+0000
name (optional)
example: homepage
onlyOneRestrictionMustApply (optional)
example: false
pk (optional)
example: 8796093056052
template (optional)
example: LandingPageTemplate
title (optional)
example: {"EN":"Homepage","DE":"Startseite"}
typeCode (optional)
example: ContentPage
uid (optional)
uuid (optional)
Specifies properties of the CMS comment.
authorName (optional)
code (optional)
createdAgoInMillis (optional)
example: 128334524
creationtime (optional)
example: yyyy-MM-dd HH:mm:ss+0000
decisionCode (optional)
decisionName (optional)
originalActionCode (optional)
text (optional)
Specifies a list of available CMS comments.
comments (optional)
pagination (optional)
Specifies a list of slot ids.
slotIds (optional)
example: ["Section1Slot-Homepage","Section2Footer-Homepage"]
Specifies a list of available uuid for CMS item.
Specifies properties of the CMS version.
creationtime (optional)
example: yyyy-MM-dd HH:mm:ss+0000
description (optional)
itemUUID (optional)
label (optional)
example: 2.0
uid (optional)
example: 00000000
Specifies a list of available CMS versions.
pagination (optional)
results (optional)
example: [{"creationtime":"2019-12-23T19:35:35+0000","itemUUID":"eyJpd","label":"newVersion","uid":"00000000"}]
Specifies properties of the CMS workflow action.
actionType (optional)
example: START
code (optional)
example: 0000000C
decisions (optional)
example: [{"code":"PageTranslationSendDEForReview","description":"Decision for sending DE language for review","name":"Send for Review"}]
description (optional)
example: Decision for approving content
isCurrentUserParticipant (optional)
example: true
name (optional)
example: Approve
startedAgoInMillis (optional)
example: 5283
status (optional)
example: IN_PROGRESS
Specifies properties of the CMS workflow.
actions (optional)
attachments (optional)
canModifyItemInWorkflow (optional)
example: true
createVersion (optional)
description (optional)
isAvailableForCurrentPrincipal (optional)
example: true
label (optional)
status (optional)
example: RUNNING
templateCode (optional)
example: PageTranslation
workflowCode (optional)
example: 000000RV
Specifies properties of the CMS workflow decision.
code (optional)
example: PageTranslationSendDEForReview
description (optional)
example: Decision for sending DE language for review
name (optional)
example: Send for Review
Specifies properties of the CMS workflow operation.
actionCode (optional)
example: 000001JR
comment (optional)
createVersion (optional)
decisionCode (optional)
example: 000000RS
label (optional)
operation (optional)
Specifies a list of available catalog data.
catalogIds (optional)
example: ["electronicsContentCatalog","electronicsProductCatalog"]
active (optional)
homepage (optional)
name (optional)
pageDisplayConditions (optional)
thumbnailUrl (optional)
uuid (optional)
version (optional)
Specifies a list of available catalog versions.
Specifies properties for the category.
catalogId (optional)
example: electronicsContentCatalog
catalogVersion (optional)
example: Staged
code (optional)
example: ProductPage
description (optional)
name (optional)
thumbnailMediaCode (optional)
Specifies a list of available product categories.
pagination (optional)
productCategories (optional)
Specifies properties of the component type attribute.
cmsStructureEnumType (optional)
cmsStructureType (optional)
example: ShortString
collection (optional)
example: false
containedTypes (optional)
example: ["MediaFormat","MediaContainer"]
dependsOn (optional)
editable (optional)
example: false
i18nKey (optional)
example: type.searchboxcomponent.name
idAttribute (optional)
example: value
labelAttributes (optional)
example: ["label"]
localized (optional)
example: false
options (optional)
paged (optional)
example: false
params (optional)
example: {"typeCode":"AbstractRestriction"}
placeholder (optional)
example: Select or create an entry
qualifier (optional)
example: cmsComponents
required (optional)
example: false
subTypes (optional)
example: {"CMSUserGroupRestriction":"type.cmsusergrouprestriction.name","CMSCampaignRestriction":"type.cmscampaignrestriction.name"}
uri (optional)
Specifies properties of the component type.
attributes (optional)
category (optional)
example: Page
code (optional)
example: ContentPage
i18nKey (optional)
example: type.searchboxcomponent.name
name (optional)
example: Link
type (optional)
example: SearchBoxComponent
Specifies a list of available component types.
componentTypes (optional)
Specifies a list of valid component types for a given content slot.
contentSlotUid (optional)
example: Section1Slot-Homepage
validComponentTypes (optional)
example: ["ProductFeatureComponent","CategoryFeatureComponent"]
options (optional)
typecode (optional)
current (optional)
fallback (optional)
old (optional)
Specifies properties of the item synchronization.
itemId (optional)
itemType (optional)
example: ContentSlot
Specifies properties of the item type.
i18nKey (optional)
example: type.searchboxcomponent.name
itemType (optional)
example: ContentSlot
active (optional)
isocode (optional)
name (optional)
nativeName (optional)
required (optional)
Specifies a list of available languages.
Specifies properties of the media container.
catalogVersion (optional)
example: Online
mediaContainerUuid (optional)
example: encoded-media-container-identifier
medias (optional)
qualifier (optional)
example: summer-sales-media-container
thumbnailUrl (optional)
example: /images/summer-sales.jpeg
Specifies a list of available media containers.
mediaContainers (optional)
pagination (optional)
Specifies properties of a specific media.
altText (optional)
example: Text to display if media can't be loaded.
catalogId (optional)
example: electronicsContentCatalog
catalogVersion (optional)
example: Online
code (optional)
example: PreviewData
description (optional)
example: Text that describes a media.
downloadUrl (optional)
mime (optional)
example: image/png
url (optional)
uuid (optional)
Specifies a list of available media.
Specifies properties of the navigation entry.
itemId (optional)
example: DigitalCompactsCategoryLink
itemSuperType (optional)
example: AbstractCMSComponent
itemType (optional)
example: CMSNavigationNode
name (optional)
example: My Account
Specifies properties of the navigation node.
entries (optional)
hasChildren (optional)
example: false
itemType (optional)
example: CMSNavigationNode
name (optional)
example: My Account
parentUid (optional)
example: SiteRootNode
position (optional)
example: 3
title (optional)
example: {"EN":"Homepage","DE":"Startseite"}
uid (optional)
example: ElectronicsNavNode
uuid (optional)
Specifies a list of available navigation nodes.
navigationNodes (optional)
id (optional)
label (optional)
Specifies properties of the page content slot component.
componentId (optional)
example: AbstractCMSComponent
componentUuid (optional)
pageId (optional)
example: homepage
position (optional)
example: 1
slotId (optional)
example: Section1Slot-Homepage
Specifies a list of available page content slot components.
pageContentSlotComponentList (optional)
Specifies properties of the page content slot container.
components (optional)
containerId (optional)
containerType (optional)
pageId (optional)
example: homepage
slotId (optional)
example: Section1Slot-Homepage
Specifies a list of available content slot containers.
pageContentSlotContainerList (optional)
Specifies properties of the page content slot.
pageId (optional)
example: homepage
position (optional)
example: 1
slotId (optional)
example: Section1Slot-Homepage
slotShared (optional)
example: true
slotStatus (optional)
Specifies a list of available page content slots.
pageContentSlotList (optional)
Specifies a list of available pages.
pages (optional)
pagination (optional)
Specifies properties of the page restriction.
pageId (optional)
example: homepage
restrictionId (optional)
Specifies a list of available page restrictions.
pageRestrictionList (optional)
Specifies properties of the page template.
frontEndName (optional)
example: product/productLayout2Page
name (optional)
example: homepage
previewIcon (optional)
uid (optional)
example: ProductDetailsPageTemplate
uuid (optional)
Specifies a list of available page templates.
Specifies property of the page type.
code (optional)
example: 000000RW
description (optional)
name (optional)
type (optional)
example: ContentPage
Specifies a list of available page types.
Specifies a restriction type that can be applied to a given page type.
pageType (optional)
example: ContentPage
restrictionType (optional)
example: CMSUserGroupRestriction
Specifies a list of available restriction types for a given page type.
pageTypeRestrictionTypeList (optional)
Specifies properties of the product.
catalogId (optional)
example: electronicsContentCatalog
catalogVersion (optional)
example: Online
code (optional)
example: 489702
description (optional)
name (optional)
thumbnailMediaCode (optional)
Specifies a list of available products.
pagination (optional)
products (optional)
Specifies properties of the restriction type.
code (optional)
example: 000000RW
description (optional)
name (optional)
Specifies a list of available restriction types.
restrictionTypes (optional)
Specifies properties of the site.
contentCatalogs (optional)
example: ["apparel-deContentCatalog"]
name (optional)
example: {"en":"Apparel Site DE","de":"Bekleidungs-Website DE"}
previewUrl (optional)
example: /storefront/?site=apparel-de
uid (optional)
example: apparel-de
Specified a list of available sites.
Specifies properties of the synchronization item status.
dependentItemTypesOutOfSync (optional)
itemId (optional)
itemType (optional)
example: ContentSlot
lastModifiedDate (optional)
example: 1575388910281
lastSyncStatus (optional)
example: 1575389256116
name (optional)
example: SearchBoxSlot
selectedDependencies (optional)
sharedDependencies (optional)
status (optional)
example: NOT_SYNC
Specifies properties of the synchronization job.
code (optional)
example: ProductPage
creationDate (optional)
example: yyyy-MM-dd HH:mm:ss+0000
endDate (optional)
example: yyyy-MM-dd HH:mm:ss+0000
lastModifiedDate (optional)
example: yyyy-MM-dd HH:mm:ss+0000
sourceCatalogVersion (optional)
example: electronicsContentCatalog/Staged
startDate (optional)
example: yyyy-MM-dd HH:mm:ss+0000
syncResult (optional)
example: SUCCESS
syncStatus (optional)
example: IN_SYNC
targetCatalogVersion (optional)
example: electronicsContentCatalog/Online
Specifies a list of available synchronization items.
Specifies a list of available uids.
Specifies properties of the user data.
readableLanguages (optional)
example: ["de","hi"]
uid (optional)
writeableLanguages (optional)
example: ["de","hi"]
Specifies properties of the user group.
name (optional)
uid (optional)
example: admin
Specifies a list of available user groups.
pagination (optional)
userGroups (optional)
Specifies properties of the workflow template.
code (optional)
example: 000000RS
name (optional)
example: Page Translation
Specifies a list of available workflow templates.
Pagination info
count (optional)
Integer Number of elements on this page format: int32
hasNext (optional)
Boolean Indicates if there is next page
hasPrevious (optional)
Boolean Indicates if there is previous page
page (optional)
Integer Current page number format: int32
totalCount (optional)
Long Total number of elements format: int64
totalPages (optional)
Integer Total number of pages format: int32