REST Endpoints

JSON Data Types

Searching parameters

Introduction


This is the REST API for the Content Manager module of Videoscape Media Suite. Methods can be accessed using the following base URL:

http(s)://{VMS URL}/opencase/ContentManager/resource/rest{Method Mount Point}

REST

This API supports a Representational State Transfer (REST) model for accessing a set of resources through a fixed set of operations. The following resources are accessible through the RESTful model:

Data

All endpoints act on a common set of data. The data can be represented in different data formats (i.e. MIME types), depending on the endpoint that consumes and/or produces the data. The data format is JSON.

JSON Data Types

/api/cms/v1/bind/request/queue/available_plugins

  • Mount point: /api/cms/v1/bind/request/queue/available_plugins

The following operations are supported on this resource:

GET

This method is used to get list of available Bind Queue Plugins.

Output Payload

element produceable content type(s)
CommonListStringDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/classification/dataforclassificationassociation

  • Mount point: /api/cms/v1/classification/dataforclassificationassociation

The following operations are supported on this resource:

POST

This method is used to get list of suitable DataForClassificationAssociation objects by given POST request with DataForClassificationAssociationDTO body.

Input Payload

element consumeable content type(s)
DataForClassificationAssociationDTOapplication/json

Output Payload

element produceable content type(s)
DataForClassificationAssociationDTO application/json

Response Codes

code reason
200OK
400Bad Request
404Not Found
500Internal Server error

/api/cms/v1/bundle/template/{uuid}/activation

  • Mount point: /api/cms/v1/bundle/template/{uuid}/activation

The following operations are supported on this resource:

PUT

This method is used to Change Bundle Template Activation status. Note, that UUID in request string must be present. UUID in JSON body may be absent or else, it must be equal to UUID in request string.

Note, that in PUT operation we must provide all required fields.

URL Parameters

name description type default
uuidThe uuid of BundleTemplatepath

Input Payload

element consumeable content type(s)
ActivationDTOapplication/json

Output Payload

element produceable content type(s)
ActivationDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404UUID from request is not found in DB.
405Request path has no UUID or it doesn't match the one from request body.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

DELETE

This method is used to deactivate Bundle Tempalte by given UUID.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT
404NOT FOUND

GET

This method is used to get the activation status of the bundle template

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
ActivationDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/audit/{uuid1}/compare/{uuid2}

  • Mount point: /api/cms/v1/audit/{uuid1}/compare/{uuid2}

The following operations are supported on this resource:

GET

This method is used to get the AuditTrail DTO pair for comparison.

URL Parameters

name description type default
uuid1The uuid of the AuditTrail be compared to.path
uuid2The uuid of the AuditTrail be compared with.path

Output Payload

element produceable content type(s)
AuditTrailCompareDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/entitlement/v1/subscription

  • Mount point: /api/entitlement/v1/subscription

The following operations are supported on this resource:

POST

This method is used to create new Subscription Code. UUID must not be specified for this operation. Request body must contain all required fields.

Input Payload

element consumeable content type(s)
SubscriptionCodeDTOapplication/json

Output Payload

element produceable content type(s)
SubscriptionCodeDTO application/json

Response Codes

code reason
201Created.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is present in request path.
500Request is formed correctly, but server cannot create entity. Unexpected error.

GET

This method is used to get list of available Subscription Code DTO objects by given optional query parameters. See API Search page for parameters description.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
SubscriptionCodeDTO application/json

Response Codes

code reason
200OK

/api/entitlement/v1/subscription/{uuid}

  • Mount point: /api/entitlement/v1/subscription/{uuid}

The following operations are supported on this resource:

PUT

This method is used to update Subscription Code. Note, that UUID in request string must be present. UUID in JSON body may be absent or else, it must be equal to UUID in request string.

Note, that in PUT operation we must provide all required fields.

URL Parameters

name description type default
uuidThe uuid of Subscription Code.path

Input Payload

element consumeable content type(s)
SubscriptionCodeDTOapplication/json

Output Payload

element produceable content type(s)
SubscriptionCodeDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404UUID from request is not found in DB.
405Request path has no UUID or it doesn't match the one from request body.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

DELETE

This method is used to delete Subscription Code by given UUID.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT
404NOT FOUND

GET

This method is used to get a specific instance of the Subscription Code DTO by given UUID.

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
SubscriptionCodeDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/customattributetype/{uuid}/publishing

  • Mount point: /api/cms/v1/customattributetype/{uuid}/publishing

The following operations are supported on this resource:

PUT

This method is used to perform Publishing of Custom Attribute Type. Note, that UUID in request string must be present. UUID in JSON body must be absent.

URL Parameters

name description type default
uuidThe uuid of the Custom Attribute Type.path

Input Payload

element consumeable content type(s)
CustomAttributeTypePublishingDTOapplication/json

Output Payload

element produceable content type(s)
CustomAttributeTypePublishingDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or entity didn't pass field validation.
404UUID from request is not found in DB.
405Request path has no UUID or it doesn't match the one from request body.
500Request is formed correctly, but server cannot perform entity update, or cannot find ESB service. Unexpected error.

GET

This method is used to get a specific instance of the Custom Attribute Type Publishing Status by given UUID.

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
CustomAttributeTypePublishingDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/customattributetype/publishing

  • Mount point: /api/cms/v1/customattributetype/publishing

The following operations are supported on this resource:

GET

This method is used to get list of available Custom Attribute Type Publishing DTO objects by given optional query parameters. See API Search page for parameters description.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
CustomAttributeTypePublishingDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/catalog/hierarchy/{uuid}

  • Mount point: /api/cms/v1/catalog/hierarchy/{uuid}

The following operations are supported on this resource:

GET

This method is used to get a specific instance of the Catalog DTO by given uuid.

URL Parameters

name description type default
uuidThe uuid of the Catalogpath

Output Payload

element produceable content type(s)
CatalogDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/catalog/hierarchy/

  • Mount point: /api/cms/v1/catalog/hierarchy/

The following operations are supported on this resource:

GET

This method is used to get a list of catalogs

Output Payload

element produceable content type(s)
CatalogDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/bind/profileplugin

  • Mount point: /api/cms/v1/bind/profileplugin

The following operations are supported on this resource:

POST

This method is used to create new BindProfilePlugin. UUID must not be specified for this operation. Request body must contain all required fields.

Input Payload

element consumeable content type(s)
BindProfilePluginDTOapplication/json

Output Payload

element produceable content type(s)
BindProfilePluginDTO application/json

Response Codes

code reason
201Created.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is present in request path.
500Request is formed correctly, but server cannot create entity. Unexpected error.

GET

This method is used to get list of available BindprofilePlugin DTO objects by given optional query parameters. See API Search page for parameters description.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
BindProfilePluginDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/bind/profileplugin/{uuid}

  • Mount point: /api/cms/v1/bind/profileplugin/{uuid}

The following operations are supported on this resource:

PUT

This method is used to update BindProfilePlugin. Note, that UUID in request string must be present. UUID in JSON body may be absent or else, it must be equal to UUID in request string.

URL Parameters

name description type default
uuidThe uuid of BindprofilePlugin.path

Input Payload

element consumeable content type(s)
BindProfilePluginDTOapplication/json

Output Payload

element produceable content type(s)
BindProfilePluginDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404UUID from request is not found in DB.
405Request path has no UUID or it doesn't match the one from request body.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

GET

This method is used to get a BindProfilePlugin by given UUID.

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
BindProfilePluginDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/entitlement/v1/notifications/entitychange/queue/available_plugins

  • Mount point: /api/entitlement/v1/notifications/entitychange/queue/available_plugins

The following operations are supported on this resource:

GET

This method is used to get list of available Entity Change Priority Queue Processing Plugins.

Output Payload

element produceable content type(s)
CommonListStringDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/justintimepolicy

  • Mount point: /api/cms/v1/justintimepolicy

The following operations are supported on this resource:

POST

This method is used to create new JustInTimePolicy.

Uuid must not be specified for this operation.

Input Payload

element consumeable content type(s)
JustInTimePolicyDTOapplication/json

Output Payload

element produceable content type(s)
JustInTimePolicyDTO application/json

Response Codes

code reason
201Created.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is present in request path.
500Request is formed correctly, but server cannot create entity. Unexpected error.

GET

This method is used to get list of available JustInTimePolicy DTO objects by given optional query parameters. See API Search page for parameters description.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
JustInTimePolicyDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/justintimepolicy/{uuid}

  • Mount point: /api/cms/v1/justintimepolicy/{uuid}

The following operations are supported on this resource:

PUT

This method is used to update JustInTimePolicy.

URL Parameters

name description type default
uuidThe uuid of the JustInTimePolicy.path

Input Payload

element consumeable content type(s)
JustInTimePolicyDTOapplication/json

Output Payload

element produceable content type(s)
JustInTimePolicyDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or entity didn't pass field validation.
404UUID from request is not found in DB.
405Request path has no UUID or it doesn't match the one from request body.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

DELETE

This method is used to delete JustInTimePolicy by provided uuid.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT. JustInTimePolicy was successfully deleted.
404NOT FOUND. JustInTimePolicy with provided id was not found.

GET

This method is used to get a specific instance of the DTO by given uuid

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
JustInTimePolicyDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/conversation

  • Mount point: /api/cms/v1/conversation

The following operations are supported on this resource:

POST

This method is used to create new Conversation. UUID must not be specified for this operation. Request body must contain all required fields.

Input Payload

element consumeable content type(s)
ConversationDTOapplication/json

Output Payload

element produceable content type(s)
ConversationDTO application/json

Response Codes

code reason
201Created.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is present in request path.
500Request is formed correctly, but server cannot create entity. Unexpected error.

GET

This method is used to get list of available Conversation DTO objects by given optional query parameters. See API Search page for parameters description.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
ConversationDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/conversation/{uuid}

  • Mount point: /api/cms/v1/conversation/{uuid}

The following operations are supported on this resource:

PUT

This method is used to update Conversation. Note, that UUID in request string must be present. UUID in JSON body may be absent or else, it must be equal to UUID in request string.

Note, that in PUT operation we must provide all required fields.

URL Parameters

name description type default
uuidThe uuid of Conversation.path

Input Payload

element consumeable content type(s)
ConversationDTOapplication/json

Output Payload

element produceable content type(s)
ConversationDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404UUID from request is not found in DB.
405Request path has no UUID or it doesn't match the one from request body.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

DELETE

This method is used to delete Conversation by given UUID.

All related conversation details are removed too.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT
404NOT FOUND

GET

This method is used to get a specific instance of the Conversation DTO by given UUID.

URL Parameters

name description type default
uuidThe uuid of the conversation.path

Output Payload

element produceable content type(s)
ConversationDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/classification/collection/staticattributes/{staticAttributeDiscriminator}

  • Mount point: /api/cms/v1/classification/collection/staticattributes/{staticAttributeDiscriminator}

The following operations are supported on this resource:

GET

This method is used to retrieve all collection static attributes with the specified discriminator.

URL Parameters

name description type default
staticAttributeDiscriminatorThe static attribute discriminator, attributes of the type of which are to be retrieved.path

Output Payload

element produceable content type(s)
StaticAttributeListDTO application/json

Response Codes

code reason
200OK
400Request has missing field or field with invalid values

/api/cms/v1/classification/collection/staticattributes

  • Mount point: /api/cms/v1/classification/collection/staticattributes

The following operations are supported on this resource:

GET

This method is used to retrieve all collection static attributes.

URL Parameters

name description type default
paginationPaginationquery

Output Payload

element produceable content type(s)
StaticAttributeListDTO application/json

Response Codes

code reason
200OK

/api/pt/v1/metadatasourceplugin

  • Mount point: /api/pt/v1/metadatasourceplugin

The following operations are supported on this resource:

POST

This method is used to create new MetadataSourcePlugin. UUID must not be specified for this operation. Request body must contain all required fields.

Input Payload

element consumeable content type(s)
MetadataSourcePluginDTOapplication/json

Output Payload

element produceable content type(s)
MetadataSourcePluginDTO application/json

Response Codes

code reason
201Created.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is present in request path.
500Request is formed correctly, but server cannot create entity. Unexpected error.

GET

This method is used to get list of available MetadataSourcePlugin DTO objects by given optional query parameters. See API Search page for parameters description.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
MetadataSourcePluginDTO application/json

Response Codes

code reason
200OK

/api/pt/v1/metadatasourceplugin/{uuid}

  • Mount point: /api/pt/v1/metadatasourceplugin/{uuid}

The following operations are supported on this resource:

PUT

This method is used to update MetadataSourcePlugin. Note, that UUID in request string must be present. UUID in JSON body may be absent or else, it must be equal to UUID in request string.

Note, that in PUT operation we must provide all required fields.

URL Parameters

name description type default
uuidThe uuid of MetadataSourcePlugin.path

Input Payload

element consumeable content type(s)
MetadataSourcePluginDTOapplication/json

Output Payload

element produceable content type(s)
MetadataSourcePluginDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404UUID from request is not found in DB.
405Request path has no UUID or it doesn't match the one from request body.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

DELETE

This method is used to delete MetadataSourcePlugin by given UUID.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT
404NOT FOUND

GET

This method is used to get a specific MetadataSourcePlugin by given UUID.

URL Parameters

name description type default
uuidThe uuid of the plugin.path

Output Payload

element produceable content type(s)
MetadataSourcePluginDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/classification/association

  • Mount point: /api/cms/v1/classification/association

The following operations are supported on this resource:

POST

This method is used to get list of suitable ProgramOrCollectionForClassification objects by given POST request with ProgramOrCollectionForClassificationDTO body.

URL Parameters

name description type default
paginationPaginationquery

Input Payload

element consumeable content type(s)
ProgramOrCollectionForClassificationDTOapplication/json

Output Payload

element produceable content type(s)
ProgramOrCollectionForClassificationDTO application/json

Response Codes

code reason
200OK
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
500Request is formed correctly, but server cannot create entity. Unexpected error.

/api/cms/v1/content/bundlecleanup

  • Mount point: /api/cms/v1/content/bundlecleanup

The following operations are supported on this resource:

GET

This method is used to get list of available BundleCleanup DTO objects by given optional query parameters. See API Search page for parameters description.

For Bundle and Bundle type use next tokens: bundle_name:operator:value and bundle_type_name:operator:value

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
BundleCleanupDTO application/json

Response Codes

code reason
200OK
400Invalid query parameters

/api/cms/v1/classification/cipublishinstance/{uuid}

  • Mount point: /api/cms/v1/classification/cipublishinstance/{uuid}

The following operations are supported on this resource:

GET

This method is used to get a specific instance of the Publish Instance DTO by given uuid.

URL Parameters

name description type default
uuidThe uuid of the Publish Instancepath

Output Payload

element produceable content type(s)
CIPublishInstanceDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/classification/cipublishinstance/

  • Mount point: /api/cms/v1/classification/cipublishinstance/

The following operations are supported on this resource:

GET

This method is used to get a list of available Publish Instance objects.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
CIPublishInstanceDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/classification/simplesearch

  • Mount point: /api/cms/v1/classification/simplesearch

The following operations are supported on this resource:

POST

This method is used fo rseraching of metadata of Classification/Collection/ or Logical Video based on search term across all relevent fields for VCM. UUID must not be specified for this operation. Request body must contain all required fields.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Input Payload

element consumeable content type(s)
SimpleSearchDTOapplication/json

Output Payload

element produceable content type(s)
SimpleSearchDTO application/json

Response Codes

code reason
200OK
400Bad Request
500Internal Server error

/api/cms/v1/content/assetadi/{uuid}

  • Mount point: /api/cms/v1/content/assetadi/{uuid}

The following operations are supported on this resource:

GET

This method is used to get a specific instance of the ViewAssetADI DTO by given uuid.

URL Parameters

name description type default
uuidThe uuid of the Asset.path

Output Payload

element produceable content type(s)
ViewAssetADIDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/content/bundle/{uuid}/activation

  • Mount point: /api/cms/v1/content/bundle/{uuid}/activation

The following operations are supported on this resource:

PUT

This method is used to perform activate or deactivate operation for Bundle. Note, that UUID in request string must be present. UUID in JSON body may be absent or else, it must be equal to UUID in request string. It should be uuid of Bundle.

Note, that in PUT operation we must provide all required fields.

URL Parameters

name description type default
uuidThe uuid of Bundle.path

Input Payload

element consumeable content type(s)
ActivationDTOapplication/json

Output Payload

element produceable content type(s)
ActivationDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404UUID from request is not found in DB.
405Request path has no UUID or it doesn't match the one from request body.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

DELETE

This method is used to deactivate Bundle by given UUID.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT
404NOT FOUND

GET

This method is used to get an activation status of Bundle by given UUID.

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
ActivationDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/bundle/template/{uuid}/publishing

  • Mount point: /api/cms/v1/bundle/template/{uuid}/publishing

The following operations are supported on this resource:

PUT

This method is used to Change Bundle Template Publish status. Note, that UUID in request string must be present. UUID in JSON body may be absent or else, it must be equal to UUID in request string.

Note, that in PUT operation we must provide all required fields.

URL Parameters

name description type default
uuidThe uuid of Bundle Templatepath

Input Payload

element consumeable content type(s)
BundleTemplatePublishDTOapplication/json

Output Payload

element produceable content type(s)
BundleTemplatePublishDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404UUID from request is not found in DB.
405Request path has no UUID or it doesn't match the one from request body.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

GET

This method is used to get the publishing status of the bundle template

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
BundleTemplatePublishDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/content/bundle/bundleitem/{itemUuid}/childrenlist

  • Mount point: /api/cms/v1/content/bundle/bundleitem/{itemUuid}/childrenlist

The following operations are supported on this resource:

GET

This method is used to get list of available Bundle Items which has given parent UUID by given optional query parameters.

URL Parameters

name description type default
itemUuidUUID of parent bundle itempath
searchSearchquery
sortSearchquery
paginationPaginationquery

Output Payload

element produceable content type(s)
BundleItemDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/content/bundle/{bundleUuid}/bundleitem/{itemUuid}/childrenlist

  • Mount point: /api/cms/v1/content/bundle/{bundleUuid}/bundleitem/{itemUuid}/childrenlist

The following operations are supported on this resource:

GET

This method is used to get list of available Bundle Items which has given parent UUID and bundle UUID by given optional query parameters.

URL Parameters

name description type default
bundleUuidUUID of Bundle to which item belongspath
itemUuidUUID of parent bundle itempath
searchSearchquery
sortSearchquery
paginationPaginationquery

Output Payload

element produceable content type(s)
BundleItemDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/bundlexslt

  • Mount point: /api/cms/v1/bundlexslt

The following operations are supported on this resource:

POST

This method is used to create new Bundle Xslt.

Input Payload

element consumeable content type(s)
BundleXsltDTOapplication/json

Output Payload

element produceable content type(s)
BundleXsltDTO application/json

Response Codes

code reason
201Created.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is present in request path.
500Request is formed correctly, but server cannot create entity. Unexpected error.

GET

This method is used to get list of Bundle Xslt json objects by given optional query parameters. See API Search page for parameters description.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
BundleXsltDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/bundlexslt/{uuid}

  • Mount point: /api/cms/v1/bundlexslt/{uuid}

The following operations are supported on this resource:

PUT

This method is used to perform update and partial update of the Bundle Xslt.

URL Parameters

name description type default
uuidThe uuid of the Bundle Xslt.path

Input Payload

element consumeable content type(s)
BundleXsltDTOapplication/json

Output Payload

element produceable content type(s)
BundleXsltDTO application/json

Response Codes

code reason
200OK
400NOT FOUND

GET

This method is used to get a specific instance of Bundle Xslt by given UUID.

URL Parameters

name description type default
uuidThe uuid of the Bundle Xslt to return.path

Output Payload

element produceable content type(s)
BundleXsltDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/content/bundlexslt/{uuid}

  • Mount point: /api/cms/v1/content/bundlexslt/{uuid}

The following operations are supported on this resource:

DELETE

This method is used to perform deletion of the Bundle Xslt.

The data associated with the Bundle Xslt i.e. Xslt code will also be deleted.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204No Content
404NOT FOUND

/api/entitlement/v1/entitychangeplugin/{uuid}/activation

  • Mount point: /api/entitlement/v1/entitychangeplugin/{uuid}/activation

The following operations are supported on this resource:

PUT

This method is used to activate/deactivate EntityChangePlugin. Note, that UUID in request string must be present. UUID in JSON body may be absent or else, it must be equal to UUID in request string.

Note, that in PUT operation we must provide all required fields.

URL Parameters

name description type default
uuidThe uuid of plugin.path

Input Payload

element consumeable content type(s)
ActivationDTOapplication/json

Output Payload

element produceable content type(s)
ActivationDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404UUID from request is not found in DB.
405Request path has no UUID or it doesn't match the one from request body.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

DELETE

This method is used to deactivate EntityChangePlugin by given UUID.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT
404NOT FOUND

GET

This method is used to get a activation status of EntityChangePlugin by given UUID.

URL Parameters

name description type default
uuidThe uuid of the plugin.path

Output Payload

element produceable content type(s)
ActivationDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/feedtype

  • Mount point: /api/cms/v1/feedtype

The following operations are supported on this resource:

POST

This method is used to create new FeedType. UUID must not be specified for this operation. Request body must contain all required fields.

Input Payload

element consumeable content type(s)
FeedTypeDTOapplication/json

Output Payload

element produceable content type(s)
FeedTypeDTO application/json

Response Codes

code reason
201Created.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is present in request path.
500Request is formed correctly, but server cannot create entity. Unexpected error.

GET

This method is used to get list of available FeedType DTO objects by given optional query parameters. See API Search page for parameters description.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
FeedTypeDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/feedtype/{uuid}

  • Mount point: /api/cms/v1/feedtype/{uuid}

The following operations are supported on this resource:

PUT

This method is used to update FeedType. Note, The uuid in the path must exist

Note, that in PUT operation we must provide all required fields.

URL Parameters

name description type default
uuidThe uuid of the Feed Type.path

Input Payload

element consumeable content type(s)
FeedTypeDTOapplication/json

Output Payload

element produceable content type(s)
FeedTypeDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404UUID from request is not found in DB.
405Request path has no UUID or it doesn't match the one from request body.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

DELETE

This method is used to delete FeedType by given UUID.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT
404NOT FOUND

GET

This method is used to get a specific FeedType DTO by given UUID.

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
FeedTypeDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/bind/profile/{uuid}/componentcreatesassociation

  • Mount point: /api/cms/v1/bind/profile/{uuid}/componentcreatesassociation

The following operations are supported on this resource:

PUT

This method is used to set ComponentCreateAssociation rule reference and boolean flags to allow/deny association for BindProfile. UUID in JSON body must be absent. If rule is absent it will be created automaticaly.

Note, that in PUT operation we must provide all required fields.

URL Parameters

name description type default
uuidThe uuid of BindProfile.path

Input Payload

element consumeable content type(s)
BindProfileComponentCreateAssociationDTOapplication/json

Output Payload

element produceable content type(s)
BindProfileComponentCreateAssociationDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404BindProfile with passed UUID is not found in DB.
405Request path has no BindProfile UUID or Request body has UUID of rule.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

GET

This method is used to get a BindProfileComponentCreateAssociation rules.

URL Parameters

name description type default
uuidThe uuid of the BindProfile.path

Output Payload

element produceable content type(s)
BindProfileComponentCreateAssociationDTO application/json

Response Codes

code reason
200OK
404BindProfile NOT FOUND

/api/cms/v1/classification/detail

  • Mount point: /api/cms/v1/classification/detail

The following operations are supported on this resource:

POST

This method is used to get list of suitable ClassificationDetails objects by given POST request with ClassificationDetailsDTO body.

Input Payload

element consumeable content type(s)
ClassificationDetailsDTOapplication/json

Output Payload

element produceable content type(s)
ClassificationDetailsDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/advancedsearch/performsearch

  • Mount point: /api/cms/v1/advancedsearch/performsearch

The following operations are supported on this resource:

POST

This method is used to perform search or get search facet (get search count, in the POST facet_result_only=true). UUID must not be specified for this operation. Request body must contain all required fields.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Input Payload

element consumeable content type(s)
PerformSearchDTOapplication/json

Output Payload

element produceable content type(s)
PerformSearchDTO application/json

Response Codes

code reason
200OK
400Bad Request
500Internal Server error

/api/entitlement/v1/currency

  • Mount point: /api/entitlement/v1/currency

The following operations are supported on this resource:

POST

This method is used to create new Currency. UUID must not be specified for this operation. Request body must contain all required fields.

Input Payload

element consumeable content type(s)
CurrencyDTOapplication/json

Output Payload

element produceable content type(s)
CurrencyDTO application/json

Response Codes

code reason
201Created.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is present in request path.
500Request is formed correctly, but server cannot create entity. Unexpected error.

GET

This method is used to get list of available Currency DTO objects by given optional query parameters. See API Search page for parameters description.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
CurrencyDTO application/json

Response Codes

code reason
200OK

/api/entitlement/v1/currency/{uuid}

  • Mount point: /api/entitlement/v1/currency/{uuid}

The following operations are supported on this resource:

PUT

This method is used to update Currency. Note, that UUID in request string must be present. UUID in JSON body may be absent or else, it must be equal to UUID in request string.

Note, that in PUT operation we must provide all required fields.

URL Parameters

name description type default
uuidThe uuid of Currency.path

Input Payload

element consumeable content type(s)
CurrencyDTOapplication/json

Output Payload

element produceable content type(s)
CurrencyDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404UUID from request is not found in DB.
405Request path has no UUID or it doesn't match the one from request body.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

DELETE

This method is used to delete Currency by given UUID.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT
404NOT FOUND

GET

This method is used to get a specific instance of the DTO by given UUID.

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
CurrencyDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/pt/v1/metadatasourceplugin/{uuid}/activation

  • Mount point: /api/pt/v1/metadatasourceplugin/{uuid}/activation

The following operations are supported on this resource:

PUT

This method is used to activate/deactivate MetadataSourcePlugin. Note, that UUID in request string must be present. UUID in JSON body may be absent or else, it must be equal to UUID in request string.

Note, that in PUT operation we must provide all required fields.

URL Parameters

name description type default
uuidThe uuid of MetadataSourcePlugin.path

Output Payload

element produceable content type(s)
ActivationDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404UUID from request is not found in DB.
405Request path has no UUID or it doesn't match the one from request body.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

DELETE

This method is used to deactivate MetadataSourcePlugin by given UUID.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT
404NOT FOUND

GET

This method is used to get a activation status of MetadataSourcePlugin by given UUID.

URL Parameters

name description type default
uuidThe uuid of the plugin.path

Output Payload

element produceable content type(s)
ActivationDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/pt/v1/metadatasourceplugin/availablefields

  • Mount point: /api/pt/v1/metadatasourceplugin/availablefields

The following operations are supported on this resource:

GET

This method is used to get list of available fields for mapping.

Output Payload

element produceable content type(s)
AvailableFieldsForMappingDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/bundle/template/{uuid}/copyandedit

  • Mount point: /api/cms/v1/bundle/template/{uuid}/copyandedit

The following operations are supported on this resource:

PUT

This method is used to copy, edit and save a new Bundle Template based on the given source DTO. Source DTO should contain properties that are wanted to be changed in the copied Bundle Template instance. Note, that UUID in request string must be present. UUID in JSON body may be absent or else, it must be equal to UUID in request string.

Note, that in PUT operation we must provide all required fields. 'name' and 'resource_key' fields should be unique.

URL Parameters

name description type default
uuidThe uuid of the source BundleTemplate.path

Input Payload

element consumeable content type(s)
BundleTemplateDTOapplication/json

Output Payload

element produceable content type(s)
BundleTemplateDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404UUID from request is not found in DB.
405Request path has no UUID or it doesn't match the one from request body.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

/api/cms/v1/advancedsearch/searchconfigdata

  • Mount point: /api/cms/v1/advancedsearch/searchconfigdata

The following operations are supported on this resource:

POST

This method is used to create new SearchConfigData. UUID must not be specified for this operation. Request body must contain all required fields.

Input Payload

element consumeable content type(s)
SearchConfigDataDTOapplication/json

Output Payload

element produceable content type(s)
SearchConfigDataDTO application/json

Response Codes

code reason
201Created.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is present in request path.
500Request is formed correctly, but server cannot create entity. Unexpected error.

GET

This method is used to get list of available SearchConfigData DTO objects by given optional query parameters. See API Search page for parameters description.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
SearchConfigDataDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/advancedsearch/searchconfigdata/{uuid}

  • Mount point: /api/cms/v1/advancedsearch/searchconfigdata/{uuid}

The following operations are supported on this resource:

PUT

This method is used to update SearchConfigData. Note, that UUID in request string must be present. UUID in JSON body may be absent or else, it must be equal to UUID in request string.

URL Parameters

name description type default
uuidThe uuid of SearchConfigData.path

Input Payload

element consumeable content type(s)
SearchConfigDataDTOapplication/json

Output Payload

element produceable content type(s)
SearchConfigDataDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404UUID from request is not found in DB.
405Request path has no UUID or it doesn't match the one from request body.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

DELETE

This method is used to delete SearchConfigData by given UUID.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT
404NOT FOUND

GET

This method is used to get a specific instance of the SearchConfigData DTO by given UUID.

URL Parameters

name description type default
uuidThe uuid of the SearchConfigData.path

Output Payload

element produceable content type(s)
SearchConfigDataDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/originmapping

  • Mount point: /api/cms/v1/originmapping

The following operations are supported on this resource:

POST

This method is used to create new OriginMapping. UUID must not be specified for this operation. Request body must contain all required fields.

Input Payload

element consumeable content type(s)
OriginMappingDTOapplication/json

Output Payload

element produceable content type(s)
OriginMappingDTO application/json

Response Codes

code reason
201Created.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is present in request path.
500Request is formed correctly, but server cannot create entity. Unexpected error.

GET

This method is used to get list of available OriginMapping DTO objects by given optional query parameters. See API Search page for parameters description.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
OriginMappingDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/originmapping/{uuid}

  • Mount point: /api/cms/v1/originmapping/{uuid}

The following operations are supported on this resource:

PUT

This method is used to update OriginMapping. Note, that UUID in request string must be present. UUID in JSON body may be absent or else, it must be equal to UUID in request string.

Note, that in PUT operation we must provide all required fields.

URL Parameters

name description type default
uuidThe uuid of OriginMapping.path

Input Payload

element consumeable content type(s)
OriginMappingDTOapplication/json

Output Payload

element produceable content type(s)
OriginMappingDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404UUID from request is not found in DB.
405Request path has no UUID or it doesn't match the one from request body.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

DELETE

This method is used to delete OriginMapping by given UUID.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT
404NOT FOUND

GET

This method is used to get a specific instance of the OriginMapping DTO by given UUID.

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
OriginMappingDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/classification/citreepublish/

  • Mount point: /api/cms/v1/classification/citreepublish/

The following operations are supported on this resource:

POST

This method is used to perform publish operation of classification trees into CI subsystem.

Input Payload

element consumeable content type(s)
CITreePublishDTOapplication/json

Output Payload

element produceable content type(s)
CITreePublishDTO application/json

Response Codes

code reason
200OK
400Bad Request
500Internal Server error

/api/entitlement/v1/notifications/notification/queue/available_plugins

  • Mount point: /api/entitlement/v1/notifications/notification/queue/available_plugins

The following operations are supported on this resource:

GET

This method is used to get list of available Notification Priority Queue Processing Plugins.

Output Payload

element produceable content type(s)
CommonListStringDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/content/commonentity/type/{uuid}

  • Mount point: /api/cms/v1/content/commonentity/type/{uuid}

The following operations are supported on this resource:

GET

Returns a specific instance of the CommonEntityType DTO by given UUID.

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
CommonEntityTypeDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/content/commonentity/type

  • Mount point: /api/cms/v1/content/commonentity/type

The following operations are supported on this resource:

GET

Returns list of all common entity types

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
CommonEntityTypeDTO application/json

Response Codes

code reason
200OK
500Internal server error

/api/cms/v1/conversation/{uuid}/retry

  • Mount point: /api/cms/v1/conversation/{uuid}/retry

The following operations are supported on this resource:

PUT

This method is used to perform retry operation for Conversation. Note, that UUID in request string must be present. UUID in JSON body may be absent or else, it must be equal to UUID in request string. It should be uuid of Conversation.

URL Parameters

name description type default
uuidThe uuid of Conversation.path

Input Payload

element consumeable content type(s)
ConversationRetryDTOapplication/json

Output Payload

element produceable content type(s)
ConversationRetryDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404UUID from request is not found in DB.
405Request path has no UUID or it doesn't match the one from request body.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

/api/cms/v1/bind/profile/{uuid}/activation

  • Mount point: /api/cms/v1/bind/profile/{uuid}/activation

The following operations are supported on this resource:

PUT

This method is used to perform Activation/Deactivation of Bind Profile. Note, that UUID in request string must be present. UUID in JSON body must be absent.

URL Parameters

name description type default
uuidThe uuid of the Action profile.path

Input Payload

element consumeable content type(s)
ActivationDTOapplication/json

Output Payload

element produceable content type(s)
ActivationDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or entity didn't pass field validation.
404UUID from request is not found in DB.
405Request path has no UUID or it doesn't match the one from request body.
500Request is formed correctly, but server cannot perform entity update, or cannot find ESB service. Unexpected error.

DELETE

This method is used to perform deactivation of Bind Profile.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT. deactivation was successful
404NOT FOUND. Entity with provided UUID was not found.

GET

This method is used to get a specific instance of the DTO by given UUID.

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
ActivationDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/bundle/urlsignerconfig

  • Mount point: /api/cms/v1/bundle/urlsignerconfig

The following operations are supported on this resource:

POST

This method is used to create URL Signer Configuration

Input Payload

element consumeable content type(s)
UrlSignerConfigurationDTOapplication/json

Output Payload

element produceable content type(s)
UrlSignerConfigurationDTO application/json

Response Codes

code reason
201Created.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is presented in request path.
500Request is formed correctly, but server cannot create entity. Unexpected error.

GET

This method is used to get list of available URL Signer Configuration DTO objects by given optional query parameters. See API Search page for parameters description.

API Search is not available for the inner model UrlSignerSettingsDTO.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
UrlSignerConfigurationDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/bundle/urlsignerconfig/{uuid}

  • Mount point: /api/cms/v1/bundle/urlsignerconfig/{uuid}

The following operations are supported on this resource:

PUT

This method is used to update URL Signer Configuration.

URL Parameters

name description type default
uuidThe uuid of the object.path

Input Payload

element consumeable content type(s)
UrlSignerConfigurationDTOapplication/json

Output Payload

element produceable content type(s)
UrlSignerConfigurationDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404UUID from request is not found in DB.
405Request path has no UUID, or (Request body has UUID and it's different from UUID in path).
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

DELETE

This method is used to delete URL Signer Configuration by given uuid.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT
404NOT FOUND

GET

This method is used to get a specific instance of the URL Signer Configuration DTO by given UUID.

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
UrlSignerConfigurationDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/content/commonentity/category/

  • Mount point: /api/cms/v1/content/commonentity/category/

The following operations are supported on this resource:

POST

This method is used to create new Category.

Uuid must not be specified for this operation. Name field is required.Locale is required and may be provided through parent_category_ref or by locale_ref. If both fields are provided, parent locale must be equal to provided locale.

Input Payload

element consumeable content type(s)
CategoryDTOapplication/json

Output Payload

element produceable content type(s)
CategoryDTO application/json

Response Codes

code reason
201Created.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is present in request path.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

GET

This method is used to get list of available Category DTO objects by given optional query parameters. See API Search page for parameters description.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
CategoryDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/content/commonentity/category/{uuid}

  • Mount point: /api/cms/v1/content/commonentity/category/{uuid}

The following operations are supported on this resource:

PUT

This method is used to perform update or partial update of Category.

UUID: Note, that UUID in request string must be present. UUID in JSON body may be absent or else, it must be equal to UUID in request string. name: For update/partial update It's necessary to provide name field, as it's required.parent_category_ref: if field is skipped, it will not be changed. If field is set to null explicitly, parent will be removed and Category will be moved to the root level. if field is specified, it will be validated.locale_ref: field should be skipped, but if it's present, it must refer to the same Locale.order_number: if field is skipped, or set to 0 - server will assign a new order_number, coresponding to Category's children Set. In another case it will be validated and set to Category.

URL Parameters

name description type default
uuidThe uuid of the Category.path

Input Payload

element consumeable content type(s)
CategoryDTOapplication/json

Output Payload

element produceable content type(s)
CategoryDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400error in JSON request, or entity didn't pass field validation
404UUID from request is not found in DB.
405Request path has no UUID or it doesn't match the one from request body.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

DELETE

This method is used to delete category by provided uuid.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT. Category was successfully deleted.
404NOT FOUND. Category with provided id was not found.

GET

This method is used to get a specific instance of the DTO given the uuid

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
CategoryDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/content/bundle

  • Mount point: /api/cms/v1/content/bundle

The following operations are supported on this resource:

POST

This method is used to create new Bundle. UUID must not be specified for this operation. Request body must contain all required fields.

Input Payload

element consumeable content type(s)
BundleDTOapplication/json

Output Payload

element produceable content type(s)
BundleDTO application/json

Response Codes

code reason
201Created.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is present in request path.
500Request is formed correctly, but server cannot create entity. Unexpected error.

GET

This method is used to get list of available Bundle DTO objects by given optional query parameters. See API Search page for parameters description.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
BundleDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/content/bundle/{uuid}

  • Mount point: /api/cms/v1/content/bundle/{uuid}

The following operations are supported on this resource:

PUT

This method is used to update Bundle. Note, that UUID in request string must be present. UUID in JSON body may be absent or else, it must be equal to UUID in request string.

Note, that in PUT operation we must provide all required fields.

URL Parameters

name description type default
uuidThe uuid of Bundle.path

Input Payload

element consumeable content type(s)
BundleDTOapplication/json

Output Payload

element produceable content type(s)
BundleDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404UUID from request is not found in DB.
405Request path has no UUID or it doesn't match the one from request body.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

DELETE

This method is used to delete Bundle by given UUID.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT
404NOT FOUND

GET

This method is used to get a specific instance of the Bundle DTO by given UUID.

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
BundleDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/classification/collection/details

  • Mount point: /api/cms/v1/classification/collection/details

The following operations are supported on this resource:

POST

This method is used to get list of suitable CollectionDetails objects by given POST request with CollectionDetailsDTO body

Input Payload

element consumeable content type(s)
CollectionDetailsDTOapplication/json

Output Payload

element produceable content type(s)
CollectionDetailsDTO application/json

Response Codes

code reason
200OK
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Not Found
500Request is formed correctly, but server cannot create entity. Unexpected error.

/api/cms/v1/classification/entity/summary

  • Mount point: /api/cms/v1/classification/entity/summary

The following operations are supported on this resource:

POST

This method is used for Classification Summary. Request body must contain all required fields.

Input Payload

element consumeable content type(s)
ClassificationSummaryDTOapplication/json

Output Payload

element produceable content type(s)
ClassificationSummaryDTO application/json

Response Codes

code reason
200OK
400Request body has missing field or field with invalid values

/api/cms/v1/retentionpolicy

  • Mount point: /api/cms/v1/retentionpolicy

The following operations are supported on this resource:

POST

This method is used to create new RetentionPolicy.

Uuid must not be specified for this operation. You may specify array of unused policies, or leave it blank to apply to all policies. Each Policy must be used only in single RetentionPolicy, each Retention Policy must have unique combination of Rule Enum and DeletionPsysicalAssestOnly.

Input Payload

element consumeable content type(s)
RetentionPolicyDTOapplication/json

Output Payload

element produceable content type(s)
RetentionPolicyDTO application/json

Response Codes

code reason
201Created.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is present in request path.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

GET

This method is used to get list of available RetentionPolicy DTO objects by given optional query parameters. See API Search page for parameters description.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
RetentionPolicyDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/retentionpolicy/{uuid}

  • Mount point: /api/cms/v1/retentionpolicy/{uuid}

The following operations are supported on this resource:

PUT

This method is used to perform update or partial update of RetentionPolicy.

URL Parameters

name description type default
uuidThe uuid of the RetentionPolicy.path

Input Payload

element consumeable content type(s)
RetentionPolicyDTOapplication/json

Output Payload

element produceable content type(s)
RetentionPolicyDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or entity didn't pass field validation.
404UUID from request is not found in DB.
405Request path has no UUID or it doesn't match the one from request body.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

DELETE

This method is used to delete RetentionPolicy by provided uuid.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT. RetentionPolicy was successfully deleted.
404NOT FOUND. RetentionPolicy with provided id was not found.

GET

This method is used to get a specific instance of the DTO by given uuid

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
RetentionPolicyDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/classification/program/details

  • Mount point: /api/cms/v1/classification/program/details

The following operations are supported on this resource:

POST

This method is used to get list of suitable ProgramDetails objects by given POST request with ProgramDetailsDTO body.

Input Payload

element consumeable content type(s)
ProgramDetailsDTOapplication/json

Output Payload

element produceable content type(s)
ProgramDetailsDTO application/json

Response Codes

code reason
200OK
400Bad Request
404Not Found
500Internal Server error

/api/cms/v1/content/bundlesearch

  • Mount point: /api/cms/v1/content/bundlesearch

The following operations are supported on this resource:

POST

This method is used for searching of Bundles. UUID must not be specified for this operation. Request body must contain all required fields.

Input Payload

element consumeable content type(s)
BundleSearchDTOapplication/json

Output Payload

element produceable content type(s)
BundleSearchDTO application/json

Response Codes

code reason
201Created.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is present in request path.
500Request is formed correctly, but server cannot create entity. Unexpected error.

/api/cms/v1/classification/dataforcreateclassification

  • Mount point: /api/cms/v1/classification/dataforcreateclassification

The following operations are supported on this resource:

POST

This method is used to get data for classification by POST with given DataForClassificationDTO in request body.

Input Payload

element consumeable content type(s)
DataForClassificationDTOapplication/json

Output Payload

element produceable content type(s)
DataForClassificationDTO application/json

Response Codes

code reason
200OK
400Bad Request
404Not Found
500Internal Server error

/api/cms/v1/bind/profile/{profileuuid}/chainingrules

  • Mount point: /api/cms/v1/bind/profile/{profileuuid}/chainingrules

The following operations are supported on this resource:

PUT

This method is used for creating/updating all chaining rules at once (as for main bundle and for childBundels). Note, that UUID in request string must be present.

Note, that in PUT operation we must provide all required fields.

URL Parameters

name description type default
profileuuidThe uuid of the BindProfile.path

Input Payload

element consumeable content type(s)
BindProfileChainingDTOapplication/json

Output Payload

element produceable content type(s)
BindProfileChainingDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404UUID from request is not found in DB.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

DELETE

This method is used to delete all chaining rules for BindProfile (as for main Bundle and for childBundles) by BindProfile uuid.

URL Parameters

name description type default
profileuuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT
404NOT FOUND

GET

This method is used to get all chaining rules for BindProfile by BindProfile uuid.

URL Parameters

name description type default
profileuuidThe uuid of the BindProfile.path

Output Payload

element produceable content type(s)
BindProfileChainingDTO application/json

Response Codes

code reason
200OK
404BindProfile NOT FOUND

/api/cms/v1/bundle/template/

  • Mount point: /api/cms/v1/bundle/template/

The following operations are supported on this resource:

POST

This method is used to create new Bundle Template. UUID must not be specified for this operation. Request body must contain all required fields.

Input Payload

element consumeable content type(s)
BundleTemplateDTOapplication/json

Output Payload

element produceable content type(s)
BundleTemplateDTO application/json

Response Codes

code reason
201Created.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is present in request path.
500Request is formed correctly, but server cannot create entity. Unexpected error.

/api/cms/v1/bundle/template/{uuid}

  • Mount point: /api/cms/v1/bundle/template/{uuid}

The following operations are supported on this resource:

PUT

This method is used to update Bundle Template. Note, that UUID in request string must be present. UUID in JSON body may be absent or else, it must be equal to UUID in request string.

Note, that in PUT operation we must provide all required fields.

URL Parameters

name description type default
uuidThe uuid of BundleTemplate.path

Input Payload

element consumeable content type(s)
BundleTemplateDTOapplication/json

Output Payload

element produceable content type(s)
BundleTemplateDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404UUID from request is not found in DB.
405Request path has no UUID or it doesn't match the one from request body.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

GET

This method is used to get a Bundle Template by given UUID.

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
BundleTemplateDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/entitlement/v1/bundle/template/{uuid}

  • Mount point: /api/entitlement/v1/bundle/template/{uuid}

The following operations are supported on this resource:

DELETE

This method is used to delete BundleTemplate by given UUID.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT
404NOT FOUND

/api/cms/v1/bundle/template

  • Mount point: /api/cms/v1/bundle/template

The following operations are supported on this resource:

GET

This method is used to get list of available Bundle Template DTO objects by given optional query parameters. See API Search page for parameters description.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
BundleTemplateDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/conversation/type/{uuid}

  • Mount point: /api/cms/v1/conversation/type/{uuid}

The following operations are supported on this resource:

GET

This method is used to get a specific instance of the ConversationType DTO by given UUID.

URL Parameters

name description type default
uuidThe uuid of the conversation.path

Output Payload

element produceable content type(s)
ConversationTypeDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/conversation/type

  • Mount point: /api/cms/v1/conversation/type

The following operations are supported on this resource:

GET

This method is used to get list of available ConversationType DTO objects by given optional query parameters. See API Search page for parameters description.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
ConversationTypeDTO application/json

Response Codes

code reason
200OK

/api/pt/v1/imageprofile

  • Mount point: /api/pt/v1/imageprofile

The following operations are supported on this resource:

POST

This method is used to create new iamge profile. UUID must not be specified for this operation. Request body must contain all required fields.

Input Payload

element consumeable content type(s)
ImageProfileDTOapplication/json

Output Payload

element produceable content type(s)
ImageProfileDTO application/json

Response Codes

code reason
201Created.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is present in request path.
500Request is formed correctly, but server cannot create entity. Unexpected error.

GET

This method is used to get list of available image profile DTO objects by given optional query parameters. See API Search page for parameters description.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
ImageProfileDTO application/json

Response Codes

code reason
200OK

/api/pt/v1/imageprofile/{uuid}

  • Mount point: /api/pt/v1/imageprofile/{uuid}

The following operations are supported on this resource:

PUT

This method is used to update image profile. Note, that UUID in request string must be present. UUID in JSON body may be absent or else, it must be equal to UUID in request string.

Note, that in PUT operation we must provide all required fields.

URL Parameters

name description type default
uuidThe uuid of image profile.path

Input Payload

element consumeable content type(s)
ImageProfileDTOapplication/json

Output Payload

element produceable content type(s)
ImageProfileDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404UUID from request is not found in DB.
405Request path has no UUID or it doesn't match the one from request body.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

DELETE

This method is used to delete ImageProfile by given UUID.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT
404NOT FOUND

GET

This method is used to get a specific ImageProfile by given UUID.

URL Parameters

name description type default
uuidThe uuid of the image profile.path

Output Payload

element produceable content type(s)
ImageProfileDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/entitlement/v1/entitychangeplugin/{uuid}/availableclasses

  • Mount point: /api/entitlement/v1/entitychangeplugin/{uuid}/availableclasses

The following operations are supported on this resource:

GET

This method is used to get a list of allowed classes for assigning to EntityChangePlugin. If uuid is pointed list includes current assigned class too.

URL Parameters

name description type default
uuidThe uuid of the EntityChangePlugin.path

Output Payload

element produceable content type(s)
AvailableEntityChangePluginClassDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/locale/{uuid}

  • Mount point: /api/cms/v1/locale/{uuid}

The following operations are supported on this resource:

GET

This method is used to get a specific Locale DTO by given UUID.

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
LocaleDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/locale

  • Mount point: /api/cms/v1/locale

The following operations are supported on this resource:

GET

This method is used to get list of available Locale DTO objects by given optional query parameters. See API Search page for parameters description.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
LocaleDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/audit/{uuid}

  • Mount point: /api/cms/v1/audit/{uuid}

The following operations are supported on this resource:

GET

This method is used to get a specific AuditTrail DTO by given uuid.

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
AuditTrailDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/audit

  • Mount point: /api/cms/v1/audit

The following operations are supported on this resource:

GET

This method is used to get list of available AuditTrail DTO objects by given optional query parameters. See API Search page for parameters description.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
AuditTrailDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/classification/staticattributes/{staticAttributeDiscriminator}

  • Mount point: /api/cms/v1/classification/staticattributes/{staticAttributeDiscriminator}

The following operations are supported on this resource:

GET

This method is used to retrieve all classification static attributes with the specified discriminator.

URL Parameters

name description type default
staticAttributeDiscriminatorThe static attribute discriminator, attributes of the type of which are to be retrieved.path

Output Payload

element produceable content type(s)
StaticAttributeListDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/classification/staticattributes

  • Mount point: /api/cms/v1/classification/staticattributes

The following operations are supported on this resource:

GET

This method is used to retrieve all classification static attributes.

URL Parameters

name description type default
paginationPaginationquery

Output Payload

element produceable content type(s)
StaticAttributeListDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/audit/{uuid}/history/

  • Mount point: /api/cms/v1/audit/{uuid}/history/

The following operations are supported on this resource:

GET

This method is used to get a History set of AuditTrail DTO for Entity by given AuditTrail-uuid.

URL Parameters

name description type default
uuidThe uuid of the object.path
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
AuditTrailDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/content/bundle/warning/{uuid}

  • Mount point: /api/cms/v1/content/bundle/warning/{uuid}

The following operations are supported on this resource:

DELETE

This method is used to delete Bundle Warning by given UUID.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT
404NOT FOUND

/api/cms/v1/content/bundle/{bundleUuid}/warning/{uuid}

  • Mount point: /api/cms/v1/content/bundle/{bundleUuid}/warning/{uuid}

The following operations are supported on this resource:

GET

This method is used to get a specific instance of the Bundle Warning DTO by given uuid and bundle uuid.

URL Parameters

name description type default
uuidpath
bundleUuidpath

Output Payload

element produceable content type(s)
BundleWarningDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/content/bundle/{bundleUuid}/warning

  • Mount point: /api/cms/v1/content/bundle/{bundleUuid}/warning

The following operations are supported on this resource:

GET

This method is used to get list of available Bundle Warning DTO objects by given optional query parameters and bundle uuid. See API Search page for parameters description.

URL Parameters

name description type default
bundleUuidpath
searchquery
sortquery
paginationquery

Output Payload

element produceable content type(s)
BundleWarningDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/content/bundle/bundleitem

  • Mount point: /api/cms/v1/content/bundle/bundleitem

The following operations are supported on this resource:

POST

This method is used to create new Bundle Item. UUID must not be specified for this operation. Request body must contain all required fields.

Input Payload

element consumeable content type(s)
BundleItemDTOapplication/json

Output Payload

element produceable content type(s)
BundleItemDTO application/json

Response Codes

code reason
201Created.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is present in request path.
500Request is formed correctly, but server cannot create entity. Unexpected error.

/api/cms/v1/content/bundle/bundleitem/{uuid}

  • Mount point: /api/cms/v1/content/bundle/bundleitem/{uuid}

The following operations are supported on this resource:

PUT

This method is used to update existing Bundle Item. Request body must contain all required fields.

URL Parameters

name description type default
uuidUUID bundle itempath

Input Payload

element consumeable content type(s)
BundleItemDTOapplication/json

Output Payload

element produceable content type(s)
BundleItemDTO application/json

Response Codes

code reason
200OK.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved or BundleItem is not found
500Request is formed correctly, but server cannot update entity. Unexpected error.

DELETE

This method is used to delete Bundle Item by given UUID.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT
404NOT FOUND

/api/cms/v1/content/bundle/{bundleUuid}/bundleitem/{uuid}

  • Mount point: /api/cms/v1/content/bundle/{bundleUuid}/bundleitem/{uuid}

The following operations are supported on this resource:

GET

This method is used to get a specific instance of the Bundle Item DTO by given uuid and bundle uuid.

URL Parameters

name description type default
bundleUuidUUID of bundlepath
uuidUUID bundle itempath

Output Payload

element produceable content type(s)
BundleItemDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/content/bundle/{bundleUuid}/bundleitem

  • Mount point: /api/cms/v1/content/bundle/{bundleUuid}/bundleitem

The following operations are supported on this resource:

GET

This method is used to get list of available Bundle Items DTO objects by given optional query parameters and bundle uuid. See API Search page for parameters description.

URL Parameters

name description type default
bundleUuidUUID bundlepath
searchSearchquery

Output Payload

element produceable content type(s)
BundleItemDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/classification/hierarchy/

  • Mount point: /api/cms/v1/classification/hierarchy/

The following operations are supported on this resource:

POST

This method is used to get list of suitable ClassificationNodeDTO objects by given POST request with ClassificationNodeDTO body.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Input Payload

element consumeable content type(s)
ClassificationNodeDTOapplication/json

Output Payload

element produceable content type(s)
ClassificationNodeDTO application/json

Response Codes

code reason
200OK

/api/entitlement/v1/productization/policy/{uuid}

  • Mount point: /api/entitlement/v1/productization/policy/{uuid}

The following operations are supported on this resource:

GET

This method is used to get a specific instance of the Policy DTO by given UUID.

URL Parameters

name description type default
uuidThe uuid of the policy.path

Output Payload

element produceable content type(s)
PolicyDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/entitlement/v1/productization/policy

  • Mount point: /api/entitlement/v1/productization/policy

The following operations are supported on this resource:

GET

This method is used to get list of available Policy DTO objects by given optional query parameters. See API Search page for parameters description.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
PolicyDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/type/folder

  • Mount point: /api/cms/v1/type/folder

The following operations are supported on this resource:

POST

This method is used to create Bundle Folder Type

Input Payload

element consumeable content type(s)
BundleFolderTypeDTOapplication/json

Output Payload

element produceable content type(s)
BundleFolderTypeDTO application/json

Response Codes

code reason
201Created.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is present in request path.
500Request is formed correctly, but server cannot create entity. Unexpected error.

GET

This method is used to get list of available Bundle Folder Type DTO objects by given optional query parameters. See API Search page for parameters description.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
BundleFolderTypeDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/type/folder/{uuid}

  • Mount point: /api/cms/v1/type/folder/{uuid}

The following operations are supported on this resource:

PUT

This method is used to update Bundle Folder Type.

URL Parameters

name description type default
uuidThe uuid of BundleTemplate.path

Input Payload

element consumeable content type(s)
BundleFolderTypeDTOapplication/json

Output Payload

element produceable content type(s)
BundleFolderTypeDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404UUID from request is not found in DB.
405Request path has no UUID or it doesn't match the one from request body.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

GET

This method is used to get a specific Bundle Folder Type DTO by given UUID.

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
BundleFolderTypeDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/feedtype/{uuid}/activation

  • Mount point: /api/cms/v1/feedtype/{uuid}/activation

The following operations are supported on this resource:

PUT

This method is used to activate/deactivate FeedType. Note, that UUID in request string must be present. UUID in JSON body must be absent.

Note, that in PUT operation we must provide all required fields.

URL Parameters

name description type default
uuidThe uuid of FeedType.path

Input Payload

element consumeable content type(s)
ActivationDTOapplication/json

Output Payload

element produceable content type(s)
ActivationDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404UUID from request is not found in DB.
405Request path has no UUID or it doesn't match the one from request body.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

DELETE

This method is used to deactivate FeedType by given UUID.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT
404NOT FOUND

GET

This method is used to get a activation status of FeedType by given UUID.

URL Parameters

name description type default
uuidThe uuid of the FeedType.path

Output Payload

element produceable content type(s)
ActivationDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/pt/v1/xlsparserconfig

  • Mount point: /api/pt/v1/xlsparserconfig

The following operations are supported on this resource:

POST

This method is used to create XLS Parser Configuration

Input Payload

element consumeable content type(s)
XlsParserConfigDTOapplication/json

Output Payload

element produceable content type(s)
XlsParserConfigDTO application/json

Response Codes

code reason
201Created.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is presented in request path.
500Request is formed correctly, but server cannot create entity. Unexpected error.

GET

This method is used to get list of available XLS Parser Configuration DTO objects by given optional query parameters. See API Search page for parameters description.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
XlsParserConfigDTO application/json

Response Codes

code reason
200OK

/api/pt/v1/xlsparserconfig/{uuid}

  • Mount point: /api/pt/v1/xlsparserconfig/{uuid}

The following operations are supported on this resource:

PUT

This method is used to update XLS Parser Configuration.

URL Parameters

name description type default
uuidThe uuid of the object.path

Input Payload

element consumeable content type(s)
XlsParserConfigDTOapplication/json

Output Payload

element produceable content type(s)
XlsParserConfigDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404UUID from request is not found in DB.
405Request path has no UUID, or (Request body has UUID and it's different from UUID in path).
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

DELETE

This method is used to delete XLS Parser Configuration by given uuid.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT
404NOT FOUND

GET

This method is used to get a specific XLS Parser Configuration DTO by given uuid.

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
XlsParserConfigDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/bind/profile/{profileuuid}/childbundleassociation

  • Mount point: /api/cms/v1/bind/profile/{profileuuid}/childbundleassociation

The following operations are supported on this resource:

POST

This method is used to create new ChildBundleAssociation. UUID of BindProfile must be specified for this operation. Request body must contain all required fields.

URL Parameters

name description type default
profileuuidThe uuid of the BindProfile.path

Input Payload

element consumeable content type(s)
BindProfileChildBundleAssociationDTOapplication/json

Output Payload

element produceable content type(s)
BindProfileChildBundleAssociationDTO application/json

Response Codes

code reason
201Created.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is present in request path.
500Request is formed correctly, but server cannot create entity. Unexpected error.

GET

This method is used to get list of ChildBundleAssociation rules which belong to BindProfile with defined uuid by given optional query parameters. See API Search page for parameters description.

URL Parameters

name description type default
profileuuidThe uuid of the BindProfile.path
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
BindProfileChildBundleAssociationDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/bind/profile/{profileuuid}/childbundleassociation/{uuid}

  • Mount point: /api/cms/v1/bind/profile/{profileuuid}/childbundleassociation/{uuid}

The following operations are supported on this resource:

PUT

This method is used to update ChildBundleAssociation. Note, that UUID in request string must be present as for BindProfile and for ChildBundleAssociation. UUID in JSON body must be absent.

Note, that in PUT operation we must provide all required fields.

URL Parameters

name description type default
profileuuidThe uuid of the BindProfile.path
uuidThe uuid of the ChildBundleAssociation.path

Input Payload

element consumeable content type(s)
BindProfileChildBundleAssociationDTOapplication/json

Output Payload

element produceable content type(s)
BindProfileChildBundleAssociationDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404UUID from request is not found in DB.
405Request path has no UUID or it doesn't match the one from request body.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

GET

This method is used to get a ChildBundleAssociation rule by uuid and by BindProfile uuid.

URL Parameters

name description type default
profileuuidThe uuid of the BindProfile.path
uuidThe uuid of the ChildBundleAssociation.path

Output Payload

element produceable content type(s)
BindProfileChildBundleAssociationDTO application/json

Response Codes

code reason
200OK
404BindProfile or ChildBundleAssociation NOT FOUND

/api/cms/v1/bind/profile/childbundleassociation/{uuid}

  • Mount point: /api/cms/v1/bind/profile/childbundleassociation/{uuid}

The following operations are supported on this resource:

DELETE

This method is used to delete ChildBundleAssociation by given UUID.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT
404NOT FOUND

/api/cms/v1/classification/delete

  • Mount point: /api/cms/v1/classification/delete

The following operations are supported on this resource:

POST

This method is used to delete Classification Node and all nodes with the same path in the same catalog by given POST request with DeleteClassificationDTO body.

Input Payload

element consumeable content type(s)
DeleteClassificationDTOapplication/json

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
200OK
400Bad Request
404Not Found
500Internal Server Error

/api/cms/v1/type/component/{uuid}

  • Mount point: /api/cms/v1/type/component/{uuid}

The following operations are supported on this resource:

GET

This method is used to get a specific Component Type DTO by given UUID.

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
ComponentTypeDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/type/component

  • Mount point: /api/cms/v1/type/component

The following operations are supported on this resource:

GET

This method is used to get list of available Component Type DTO objects by given optional query parameters. See API Search page for parameters description.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
ComponentTypeDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/content/commonentity

  • Mount point: /api/cms/v1/content/commonentity

The following operations are supported on this resource:

POST

This method is used to create new CommonEntity. UUID must not be specified for this operation. Request body must contain all required fields.

Input Payload

element consumeable content type(s)
CommonEntityDTOapplication/json

Output Payload

element produceable content type(s)
CommonEntityDTO application/json

Response Codes

code reason
201Created.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is present in request path.
500Request is formed correctly, but server cannot create entity. Unexpected error.

GET

This method is used to get list of available CommonEntity DTO objects by given optional query parameters. See API Search page for parameters description.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
CommonEntityDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/content/commonentity/{uuid}

  • Mount point: /api/cms/v1/content/commonentity/{uuid}

The following operations are supported on this resource:

PUT

This method is used to update CommonEntity. Note, that UUID in request string must be present. UUID in JSON body may be absent or else, it must be equal to UUID in request string.

Note, that in PUT operation we must provide all required fields.

URL Parameters

name description type default
uuidThe uuid of CommonEntity.path

Input Payload

element consumeable content type(s)
CommonEntityDTOapplication/json

Output Payload

element produceable content type(s)
CommonEntityDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404UUID from request is not found in DB.
405Request path has no UUID or it doesn't match the one from request body.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

DELETE

This method is used to delete CommonEntity by given UUID.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT. Common Entity was successfully deleted.
404NOT FOUND. CommonEntity with provided uuid was not found.

GET

This method is used to get a specific instance of the CommonEntity DTO by given UUID.

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
CommonEntityDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/feed

  • Mount point: /api/cms/v1/feed

The following operations are supported on this resource:

POST

This method is used to create new Feed. UUID must not be specified for this operation. Request body must contain all required fields.

Input Payload

element consumeable content type(s)
FeedDTOapplication/json

Output Payload

element produceable content type(s)
FeedDTO application/json

Response Codes

code reason
201Created.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is present in request path.
500Request is formed correctly, but server cannot create entity. Unexpected error.

GET

This method is used to get list of available Feed DTO objects by given optional query parameters. See API Search page for parameters description.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
FeedDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/feed/{uuid}

  • Mount point: /api/cms/v1/feed/{uuid}

The following operations are supported on this resource:

PUT

This method is used to update Feed. Note, The uuid in the path must exist. Type of Feed (Bundle or Product) can`t be changed.

Note, that in PUT operation we must provide all required fields.

URL Parameters

name description type default
uuidThe uuid of the Feed.path

Input Payload

element consumeable content type(s)
FeedDTOapplication/json

Output Payload

element produceable content type(s)
FeedDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404UUID from request is not found in DB.
405Request path has no UUID or it doesn't match the one from request body.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

GET

This method is used to get a specific Feed DTO by given UUID.

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
FeedDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/customattributetype

  • Mount point: /api/cms/v1/customattributetype

The following operations are supported on this resource:

POST

This method is used to create new CustomAttributeType. UUID must not be specified for this operation. Request body must contain all required fields.

Input Payload

element consumeable content type(s)
CustomAttributeTypeDTOapplication/json

Output Payload

element produceable content type(s)
CustomAttributeTypeDTO application/json

Response Codes

code reason
201Created.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is present in request path.
500Request is formed correctly, but server cannot create entity. Unexpected error.

GET

This method is used to get list of available CustomAttributeType DTO objects by given optional query parameters. See API Search page for parameters description.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
CustomAttributeTypeDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/customattributetype/{uuid}

  • Mount point: /api/cms/v1/customattributetype/{uuid}

The following operations are supported on this resource:

PUT

This method is used to update CustomAttributeType. Note, that UUID in request string must be present. UUID in JSON body may be absent or else, it must be equal to UUID in request string.

Note, that in PUT operation we must provide all required fields.

URL Parameters

name description type default
uuidThe uuid of CustomAttributeType.path

Input Payload

element consumeable content type(s)
CustomAttributeTypeDTOapplication/json

Output Payload

element produceable content type(s)
CustomAttributeTypeDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404UUID from request is not found in DB.
405Request path has no UUID or it doesn't match the one from request body.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

DELETE

This method is used to delete CustomAttributeType by given UUID.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT. Custom Attribute Type was successfully deleted.
404NOT FOUND. CustomAttributeType with provided uuid was not found.

GET

This method is used to get a specific instance of the CustomAttributeType DTO by given UUID.

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
CustomAttributeTypeDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/entitlement/v1/productresolutionplugin

  • Mount point: /api/entitlement/v1/productresolutionplugin

The following operations are supported on this resource:

POST

This method is used to create new ProductResolutionPlugin. UUID must not be specified for this operation. Request body must contain all required fields.

Input Payload

element consumeable content type(s)
ProductResolutionPluginDTOapplication/json

Output Payload

element produceable content type(s)
ProductResolutionPluginDTO application/json

Response Codes

code reason
201Created.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is present in request path.
500Request is formed correctly, but server cannot create entity. Unexpected error.

GET

This method is used to get list of available ProductResolutionPlugin DTO objects by given optional query parameters. See API Search page for parameters description.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
ProductResolutionPluginDTO application/json

Response Codes

code reason
200OK

/api/entitlement/v1/productresolutionplugin/{uuid}

  • Mount point: /api/entitlement/v1/productresolutionplugin/{uuid}

The following operations are supported on this resource:

PUT

This method is used to update ProductResolutionPlugin. Note, that UUID in request string must be present. UUID in JSON body may be absent or else, it must be equal to UUID in request string.

Note, that in PUT operation we must provide all required fields.

URL Parameters

name description type default
uuidThe uuid of ProductResolutionPlugin.path

Input Payload

element consumeable content type(s)
ProductResolutionPluginDTOapplication/json

Output Payload

element produceable content type(s)
ProductResolutionPluginDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404UUID from request is not found in DB.
405Request path has no UUID or it doesn't match the one from request body.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

DELETE

This method is used to delete ProductResolutionPlugin by given UUID. Predefined plugin can`t be deleted.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT
404NOT FOUND

GET

This method is used to get a ProductResolutionPlugin by given UUID.

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
ProductResolutionPluginDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/pt/v1/metadatasourceplugin/{uuid}/availableclasses

  • Mount point: /api/pt/v1/metadatasourceplugin/{uuid}/availableclasses

The following operations are supported on this resource:

GET

This method is used to get list of available classes and specific setting for it. If uuid is pointed list contains allowed classes include class of current plugin.

URL Parameters

name description type default
uuidThe uuid of the plugin.path
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
AvailableMetadataSourcePluginClassDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/classification/findbyid

  • Mount point: /api/cms/v1/classification/findbyid

The following operations are supported on this resource:

POST

This method is used for searching of metadta of Classification/Collection/ or Logical Video by uuids. UUID must not be specified for this operation. Request body must contain all required fields.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Input Payload

element consumeable content type(s)
BundleMetadataSearchDTOapplication/json

Output Payload

element produceable content type(s)
BundleMetadataSearchDTO application/json

Response Codes

code reason
200OK
400Bad Request
500Internal Server error

/api/cms/v1/classification/dataforassociation

  • Mount point: /api/cms/v1/classification/dataforassociation

The following operations are supported on this resource:

POST

This method is used to get list of suitable DataForAssociation objects by given POST request with DataForAssociationDTO body.

Input Payload

element consumeable content type(s)
DataForAssociationDTOapplication/json

Output Payload

element produceable content type(s)
DataForAssociationDTO application/json

Response Codes

code reason
200OK
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Not Found
500Request is formed correctly, but server cannot create entity. Unexpected error.

/api/cms/v1/classification/collection/association

  • Mount point: /api/cms/v1/classification/collection/association

The following operations are supported on this resource:

POST

This method is used to get list of suitable ProgramOrCollectionForCollection objects by given POST request with ProgramOrCollectionForCollectionDTO body.

URL Parameters

name description type default
paginationPaginationquery

Input Payload

element consumeable content type(s)
ProgramOrCollectionForCollectionDTOapplication/json

Output Payload

element produceable content type(s)
ProgramOrCollectionForCollectionDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/bind/profile/{uuid}/updaterules

  • Mount point: /api/cms/v1/bind/profile/{uuid}/updaterules

The following operations are supported on this resource:

PUT

This method is used to set ComponentUpdate rule, BundleUpdate rule, BindProfilePlugin reference and boolean flags to allow/deny updates for BindProfile. UUID in JSON body must be absent. If rule is absent it will be create automaticaly.

Note, that in PUT operation we must provide all required fields.

URL Parameters

name description type default
uuidThe uuid of BindProfile.path

Input Payload

element consumeable content type(s)
BindProfileUpdateRuleDTOapplication/json

Output Payload

element produceable content type(s)
BindProfileUpdateRuleDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404BindProfile with passed UUID is not found in DB.
405Request path has no BindProfile UUID or Request body has UUID of rule.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

GET

This method is used to get a BindProfileUpdate rules.

URL Parameters

name description type default
uuidThe uuid of the BindProfile.path

Output Payload

element produceable content type(s)
BindProfileUpdateRuleDTO application/json

Response Codes

code reason
200OK
404BindProfile NOT FOUND

/api/cms/v1/bundle/template/typeitem/

  • Mount point: /api/cms/v1/bundle/template/typeitem/

The following operations are supported on this resource:

POST

This method is used to create new BundleTypeItem. UUID must not be specified for this operation. Request body must contain all required fields.

Input Payload

element consumeable content type(s)
BundleTypeItemDTOapplication/json

Output Payload

element produceable content type(s)
BundleTypeItemDTO application/json

Response Codes

code reason
201Created.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is present in request path.
500Request is formed correctly, but server cannot create entity. Unexpected error.

GET

This method is used to get list of Bundle Type Item DTO objects by given optional query parameters. See API Search page for parameters description.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
BundleTypeItemDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/bundle/template/typeitem/{uuid}

  • Mount point: /api/cms/v1/bundle/template/typeitem/{uuid}

The following operations are supported on this resource:

PUT

This method is used to update BundleTypeItem for specific bundle template. Note, that UUID in request string must be present. UUID in JSON body may be absent or else, it must be equal to UUID in request string.

Note, that in PUT operation we must provide all required fields.

URL Parameters

name description type default
uuidThe uuid of BundleTypeItem.path

Input Payload

element consumeable content type(s)
BundleTypeItemDTOapplication/json

Output Payload

element produceable content type(s)
BundleTypeItemDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404UUID from request is not found in DB.
405Request path has no UUID or it doesn't match the one from request body.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

DELETE

This method is used to delete BundleTypeItem by given UUID.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT
404NOT FOUND

GET

This method is used to get a BundleTypeItem by given UUID.

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
BundleTypeItemDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/bundle/urlsignerconfig/{uuid}/activation

  • Mount point: /api/cms/v1/bundle/urlsignerconfig/{uuid}/activation

The following operations are supported on this resource:

PUT

This method is used to change URL Signer Configuration activation status. Note, that UUID in request string must be present. UUID in JSON body may be absent or else, it must be equal to UUID in request string.

Note, that in PUT operation we must provide all required fields.

URL Parameters

name description type default
uuidThe uuid of the objectpath

Input Payload

element consumeable content type(s)
ActivationDTOapplication/json

Output Payload

element produceable content type(s)
ActivationDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404UUID from request is not found in DB.
405Request path has no UUID or it doesn't match the one from request body.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

DELETE

This method is used to deactivate URL Signer Configuration by given UUID.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT
404NOT FOUND

GET

This method is used to get the activation status of the URL Signer Configuration

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
ActivationDTO application/json

Response Codes

code reason
200OK

/api/pt/v1/imageprofile/availableformats

  • Mount point: /api/pt/v1/imageprofile/availableformats

The following operations are supported on this resource:

GET

This method is used to get list of allowed images formats which are supported. Search, Sort and Pagination are not supported for this API.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
ImageProfileAvailableFormatDTO application/json

Response Codes

code reason
200OK

/api/pt/v1/charconversion

  • Mount point: /api/pt/v1/charconversion

The following operations are supported on this resource:

POST

This method is used to create Character Conversion Mapping

Input Payload

element consumeable content type(s)
CharConversionMappingDTOapplication/json

Output Payload

element produceable content type(s)
CharConversionMappingDTO application/json

Response Codes

code reason
201Created.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is presented in request path.
500Request is formed correctly, but server cannot create entity. Unexpected error.

GET

This method is used to get list of available Character Conversion Mapping DTO objects by given optional query parameters. See API Search page for parameters description.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
CharConversionMappingDTO application/json

Response Codes

code reason
200OK

/api/pt/v1/charconversion/{uuid}

  • Mount point: /api/pt/v1/charconversion/{uuid}

The following operations are supported on this resource:

PUT

This method is used to update Character Conversion Mapping.

URL Parameters

name description type default
uuidThe uuid of BundleTemplate.path

Input Payload

element consumeable content type(s)
CharConversionMappingDTOapplication/json

Output Payload

element produceable content type(s)
CharConversionMappingDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404UUID from request is not found in DB.
405Request path has no UUID, or (Request body has UUID and it's different from UUID in path).
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

DELETE

This method is used to delete Character Conversion Mapping by given uuid.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT
404NOT FOUND

GET

This method is used to get a specific Character Conversion Mapping DTO by given uuid.

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
CharConversionMappingDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/bundle/template/{uuid}/fulltree

  • Mount point: /api/cms/v1/bundle/template/{uuid}/fulltree

The following operations are supported on this resource:

GET

This method is used to get a full tree of Bundle Template by given uuid.

URL Parameters

name description type default
uuidThe uuid of the Bundle Template.path

Output Payload

element produceable content type(s)
BundleTemplateFullTreeDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/bind/profile/{profileuuid}/componentassociation

  • Mount point: /api/cms/v1/bind/profile/{profileuuid}/componentassociation

The following operations are supported on this resource:

POST

This method is used to create new ComponentAssociation. UUID of BindProfile must be specified for this operation. Request body must contain all required fields.

URL Parameters

name description type default
profileuuidThe uuid of the BindProfile.path

Input Payload

element consumeable content type(s)
BindProfileComponentAssociationDTOapplication/json

Output Payload

element produceable content type(s)
BindProfileComponentAssociationDTO application/json

Response Codes

code reason
201Created.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is present in request path.
500Request is formed correctly, but server cannot create entity. Unexpected error.

GET

This method is used to get list of ComponentAssociation rules which belong to BindProfile with defined uuid by given optional query parameters. See API Search page for parameters description.

URL Parameters

name description type default
profileuuidThe uuid of the BindProfile.path

Output Payload

element produceable content type(s)
BindProfileComponentAssociationDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/bind/profile/{profileuuid}/componentassociation/{uuid}

  • Mount point: /api/cms/v1/bind/profile/{profileuuid}/componentassociation/{uuid}

The following operations are supported on this resource:

PUT

This method is used to update ComponentAssociation. Note, that UUID in request string must be present as for BindProfile and for ComponentAssociation. UUID in JSON body must be absent.

Note, that in PUT operation we must provide all required fields.

URL Parameters

name description type default
profileuuidThe uuid of the BindProfile.path
uuidThe uuid of the ComponentAssociation.path

Input Payload

element consumeable content type(s)
BindProfileComponentAssociationDTOapplication/json

Output Payload

element produceable content type(s)
BindProfileComponentAssociationDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404UUID from request is not found in DB.
405Request path has no UUID or it doesn't match the one from request body.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

GET

This method is used to get a ComponentAssociation rule by uuid and by BindProfile uuid.

URL Parameters

name description type default
profileuuidThe uuid of the BindProfile.path
uuidThe uuid of the ComponentAssociation.path
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
BindProfileComponentAssociationDTO application/json

Response Codes

code reason
200OK
404BindProfile or ComponentAssociation NOT FOUND

/api/cms/v1/bind/profile/componentassociation/{uuid}

  • Mount point: /api/cms/v1/bind/profile/componentassociation/{uuid}

The following operations are supported on this resource:

DELETE

This method is used to delete ComponentAssociation by given UUID.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT
404NOT FOUND

/api/cms/v1/bind/profile

  • Mount point: /api/cms/v1/bind/profile

The following operations are supported on this resource:

POST

This method is used to create new BindProfile. UUID must not be specified for this operation. Request body must contain all required fields.

Input Payload

element consumeable content type(s)
BindProfileDTOapplication/json

Output Payload

element produceable content type(s)
BindProfileDTO application/json

Response Codes

code reason
201Created.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is present in request path.
500Request is formed correctly, but server cannot create entity. Unexpected error.

GET

This method is used to get list of available Bindprofile DTO objects by given optional query parameters. See API Search page for parameters description.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
BindProfileDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/bind/profile/{uuid}

  • Mount point: /api/cms/v1/bind/profile/{uuid}

The following operations are supported on this resource:

PUT

This method is used to update BindProfile Note, that UUID in request string must be present. UUID in JSON body may be absent or else, it must be equal to UUID in request string.

Note, that in PUT operation we must provide all required fields.

URL Parameters

name description type default
uuidThe uuid of BindprofilePlugin.path

Input Payload

element consumeable content type(s)
BindProfileDTOapplication/json

Output Payload

element produceable content type(s)
BindProfileDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404UUID from request is not found in DB.
405Request path has no UUID or it doesn't match the one from request body.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

GET

This method is used to get a BindProfile by given UUID.

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
BindProfileDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/classification/collection/save/

  • Mount point: /api/cms/v1/classification/collection/save/

The following operations are supported on this resource:

POST

This method is used to perform create, update and delete operations under Collection.

Input Payload

element consumeable content type(s)
SaveCollectionDTOapplication/json

Output Payload

element produceable content type(s)
SaveCollectionDTO application/json

Response Codes

code reason
200OK
400Bad Request
500Internal Server error

/api/cms/v1/content/componentsearch

  • Mount point: /api/cms/v1/content/componentsearch

The following operations are supported on this resource:

POST

This method is used for Component search. UUID must not be specified for this operation. Request body must contain all required fields.

Input Payload

element consumeable content type(s)
ComponentSearchDTOapplication/json
RestApiParameterHolderapplication/json

Output Payload

element produceable content type(s)
ComponentSearchDTO application/json

Response Codes

code reason
201Created.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is present in request path.
500Request is formed correctly, but server cannot perform operation. Unexpected error.

/api/cms/v1/advancedsearch/entityfieldinfo/{uuid}

  • Mount point: /api/cms/v1/advancedsearch/entityfieldinfo/{uuid}

The following operations are supported on this resource:

GET

This method is used to get a specific instance of the EntityFieldInfo DTO by given UUID.

URL Parameters

name description type default
uuidThe uuid of the EntityFieldInfo.path

Output Payload

element produceable content type(s)
EntityFieldInfoDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/advancedsearch/entityfieldinfo

  • Mount point: /api/cms/v1/advancedsearch/entityfieldinfo

The following operations are supported on this resource:

GET

This method is used to get list of available EntityFieldInfo DTO objects by given optional query parameters. See API Search page for parameters description.

URL Parameters

name description type default
paginationPaginationquery

Output Payload

element produceable content type(s)
EntityFieldInfoDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/bind/profile/{uuid}/bundleassociation

  • Mount point: /api/cms/v1/bind/profile/{uuid}/bundleassociation

The following operations are supported on this resource:

PUT

This method is used to update BundleAssociation and BindID rules for BindProfile.

Note, that in PUT operation we must provide all required fields.

URL Parameters

name description type default
uuidThe uuid of BindProfile.path

Input Payload

element consumeable content type(s)
BindProfileBundleAssociationDTOapplication/json

Output Payload

element produceable content type(s)
BindProfileBundleAssociationDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404BindProfile with passed UUID is not found in DB.
405Request path has no BindProfile UUID
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

GET

This method is used to get a BindProfileBundleAssociation rule and BindProfileBindID rule.

URL Parameters

name description type default
uuidThe uuid of the BindProfile.path

Output Payload

element produceable content type(s)
BindProfileBundleAssociationDTO application/json

Response Codes

code reason
200OK
404BindProfile NOT FOUND or BundleAssociation rule is not set up

/api/entitlement/v1/notificationplugin

  • Mount point: /api/entitlement/v1/notificationplugin

The following operations are supported on this resource:

POST

This method is used to create new NotificationPlugin. UUID must not be specified for this operation. Request body must contain all required fields.

Input Payload

element consumeable content type(s)
NotificationPluginDTOapplication/json

Output Payload

element produceable content type(s)
NotificationPluginDTO application/json

Response Codes

code reason
201Created.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is present in request path.
500Request is formed correctly, but server cannot create entity. Unexpected error.

GET

This method is used to get list of available NotificationPlugin DTO objects by given optional query parameters. See API Search page for parameters description.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
NotificationPluginDTO application/json

Response Codes

code reason
200OK

/api/entitlement/v1/notificationplugin/{uuid}

  • Mount point: /api/entitlement/v1/notificationplugin/{uuid}

The following operations are supported on this resource:

PUT

This method is used to update NotificationPlugin. Note, that UUID in request string must be present. UUID in JSON body may be absent or else, it must be equal to UUID in request string.

Note, that in PUT operation we must provide all required fields.

URL Parameters

name description type default
uuidThe uuid of NotificationPlugin.path

Input Payload

element consumeable content type(s)
NotificationPluginDTOapplication/json

Output Payload

element produceable content type(s)
NotificationPluginDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404UUID from request is not found in DB.
405Request path has no UUID or it doesn't match the one from request body.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

DELETE

This method is used to delete NotificationPlugin by given UUID. Default plugin can`t be deleted.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT
404NOT FOUND

GET

This method is used to get a NotificationPlugin by given UUID.

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
NotificationPluginDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/content/componentcleanup

  • Mount point: /api/cms/v1/content/componentcleanup

The following operations are supported on this resource:

GET

This method is used to get list of available ComponentCleanup DTO objects by given optional query parameters. See API Search page for parameters description.

To specify component binding status, use next search token: component_binding_status:equals:BOUND/UNBOUND/BIND_QUEUEonly [equals] operator is supported for component_binding_status

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
ComponentCleanupDTO application/json

Response Codes

code reason
200OK
400Invalid query parameters

/api/cms/v1/content/bundle/{uuid}/productize

  • Mount point: /api/cms/v1/content/bundle/{uuid}/productize

The following operations are supported on this resource:

PUT

This method is used to perform productize operation for Bundle. Note, that UUID in request string must be present. UUID in JSON body may be absent or else, it must be equal to UUID in request string. It should be uuid of Bundle.

Note, that in PUT operation we must provide all required fields.

URL Parameters

name description type default
uuidThe uuid of Bundle.path

Input Payload

element consumeable content type(s)
BundleProductizeDTOapplication/json

Output Payload

element produceable content type(s)
BundleProductizeDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404UUID from request is not found in DB.
405Request path has no UUID or it doesn't match the one from request body.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

GET

This method is used to get list of created products with Bundle by given UUID.

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
BundleProductizeDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/bundle/urlsigner/{uuid}

  • Mount point: /api/cms/v1/bundle/urlsigner/{uuid}

The following operations are supported on this resource:

GET

This method is used to get a specific instance of the URL Signer DTO by given UUID.

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
UrlSignerDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/bundle/urlsigner

  • Mount point: /api/cms/v1/bundle/urlsigner

The following operations are supported on this resource:

GET

This method is used to get list of available URL Signer DTO objects by given optional query parameters. See API Search page for parameters description.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
UrlSignerDTO application/json

Response Codes

code reason
200OK

/api/entitlement/v1/entities

  • Mount point: /api/entitlement/v1/entities

The following operations are supported on this resource:

GET

This method is used to get list of available Entity DTO objects.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
EntityDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/conversation/details

  • Mount point: /api/cms/v1/conversation/details

The following operations are supported on this resource:

POST

This method is used to create new Conversation details. UUID must not be specified for this operation. Request body must contain all required fields.

Input Payload

element consumeable content type(s)
ConversationDetailsDTOapplication/json

Output Payload

element produceable content type(s)
ConversationDetailsDTO application/json

Response Codes

code reason
201Created.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is present in request path.
500Request is formed correctly, but server cannot create entity. Unexpected error.

/api/cms/v1/conversation/details/{uuid}

  • Mount point: /api/cms/v1/conversation/details/{uuid}

The following operations are supported on this resource:

PUT

This method is used to update Conversation Details. Note, that UUID in request string must be present. UUID in JSON body may be absent or else, it must be equal to UUID in request string.

Note, that in PUT operation we must provide all required fields.

URL Parameters

name description type default
uuidThe uuid of Conversation.path

Input Payload

element consumeable content type(s)
ConversationDetailsDTOapplication/json

Output Payload

element produceable content type(s)
ConversationDetailsDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404UUID from request is not found in DB.
405Request path has no UUID or it doesn't match the one from request body.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

DELETE

This method is used to delete Conversation Details by given UUID.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT
404NOT FOUND

/api/cms/v1/conversation/{conversationUuid}/details/{uuid}

  • Mount point: /api/cms/v1/conversation/{conversationUuid}/details/{uuid}

The following operations are supported on this resource:

GET

This method is used to get a specific instance of the ConversationDetails DTO by given uuid and conversation uuid.

URL Parameters

name description type default
uuidThe uuid of the conversation details.path
conversationUuidThe conversation uuid of the conversation.path

Output Payload

element produceable content type(s)
ConversationDetailsDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/conversation/{conversationUuid}/details

  • Mount point: /api/cms/v1/conversation/{conversationUuid}/details

The following operations are supported on this resource:

GET

This method is used to get list of available ConversationDetails DTO objects by given optional query parameters. See API Search page for parameters description.

URL Parameters

name description type default
conversationUuidThe conversation uuid of the conversation.path
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
ConversationDetailsDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/classification/program/save/

  • Mount point: /api/cms/v1/classification/program/save/

The following operations are supported on this resource:

POST

This method is used to perform update operation under Program.

Input Payload

element consumeable content type(s)
SaveProgramDTOapplication/json

Output Payload

element produceable content type(s)
SaveProgramDTO application/json

Response Codes

code reason
200OK
400Bad Request
500Internal Server error

/api/entitlement/v1/entitychangeplugin/

  • Mount point: /api/entitlement/v1/entitychangeplugin/

The following operations are supported on this resource:

POST

This method is used to create new EntityChangePlugin. UUID must not be specified for this operation. Request body must contain all required fields.

Input Payload

element consumeable content type(s)
EntityChangePluginDTOapplication/json

Output Payload

element produceable content type(s)
EntityChangePluginDTO application/json

Response Codes

code reason
201Created.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is present in request path.
500Request is formed correctly, but server cannot create entity. Unexpected error.

/api/entitlement/v1/entitychangeplugin/{uuid}

  • Mount point: /api/entitlement/v1/entitychangeplugin/{uuid}

The following operations are supported on this resource:

PUT

This method is used to update EntityChangePlugin. Note, that UUID in request string must be present. UUID in JSON body may be absent or else, it must be equal to UUID in request string.

URL Parameters

name description type default
uuidThe uuid of EntityChangePlugin.path

Input Payload

element consumeable content type(s)
EntityChangePluginDTOapplication/json

Output Payload

element produceable content type(s)
EntityChangePluginDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404UUID from request is not found in DB.
405Request path has no UUID or it doesn't match the one from request body.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

DELETE

This method is used to delete EntityChangePlugin by given UUID.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT
404NOT FOUND

GET

This method is used to get a EntityChangePlugin by given UUID.

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
EntityChangePluginDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/entitlement/v1/entitychangeplugin

  • Mount point: /api/entitlement/v1/entitychangeplugin

The following operations are supported on this resource:

GET

This method is used to get list of available EntityChangePlugin DTO objects by given optional query parameters. See API Search page for parameters description.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
EntityChangePluginDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/classification/save/

  • Mount point: /api/cms/v1/classification/save/

The following operations are supported on this resource:

POST

This method is used to perform create, update and delete operations under Classification.

Input Payload

element consumeable content type(s)
SaveClassificationDTOapplication/json

Output Payload

element produceable content type(s)
SaveClassificationDTO application/json

Response Codes

code reason
200OK
400Bad Request
500Internal Server error

/api/cms/v1/content/component

  • Mount point: /api/cms/v1/content/component

The following operations are supported on this resource:

POST

This method is used to create new Component. UUID must not be specified for this operation. Request body must contain all required fields.

Input Payload

element consumeable content type(s)
ComponentDTOapplication/json

Output Payload

element produceable content type(s)
ComponentDTO application/json

Response Codes

code reason
201Created.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is present in request path.
500Request is formed correctly, but server cannot create entity. Unexpected error.

GET

This method is used to get list of available Component DTO objects by given optional query parameters. See API Search page for parameters description.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
ComponentDTO application/json

Response Codes

code reason
200OK

/api/cms/v1/content/component/{uuid}

  • Mount point: /api/cms/v1/content/component/{uuid}

The following operations are supported on this resource:

PUT

This method is used to update Component. Note, that UUID in request string must be present. UUID in JSON body may be absent or else, it must be equal to UUID in request string.

Note, that in PUT operation we must provide all required fields.

URL Parameters

name description type default
uuidThe uuid of Component.path

Input Payload

element consumeable content type(s)
ComponentDTOapplication/json

Output Payload

element produceable content type(s)
ComponentDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404UUID from request is not found in DB.
405Request path has no UUID or it doesn't match the one from request body.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

DELETE

This method is used to delete Component by given UUID.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT
404NOT FOUND

GET

This method is used to get a specific instance of the Component DTO by given UUID.

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
ComponentDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/pt/v1/imagerepositorynodeconfig

  • Mount point: /api/pt/v1/imagerepositorynodeconfig

The following operations are supported on this resource:

POST

This method is used to create Folder Type CDN Mapping

Input Payload

element consumeable content type(s)
FolderTypeCdnMappingDTOapplication/json

Output Payload

element produceable content type(s)
FolderTypeCdnMappingDTO application/json

Response Codes

code reason
201Created.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is presented in request path.
500Request is formed correctly, but server cannot create entity. Unexpected error.

GET

This method is used to get list of available Folder Type CDN Mapping DTO objects by given optional query parameters. See API Search page for parameters description.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
FolderTypeCdnMappingDTO application/json

Response Codes

code reason
200OK

/api/pt/v1/imagerepositorynodeconfig/{uuid}

  • Mount point: /api/pt/v1/imagerepositorynodeconfig/{uuid}

The following operations are supported on this resource:

PUT

This method is used to update Folder Type CDN Mapping.

URL Parameters

name description type default
uuidThe uuid of Folder Type CDN Mapping.path

Input Payload

element consumeable content type(s)
FolderTypeCdnMappingDTOapplication/json

Output Payload

element produceable content type(s)
FolderTypeCdnMappingDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404UUID from request is not found in DB.
405Request path has no UUID, or (Request body has UUID and it's different from UUID in path).
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

DELETE

This method is used to delete Folder Type CDN Mapping by given uuid.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT
404NOT FOUND

GET

This method is used to get a specific Folder Type CDN Mapping DTO by given uuid.

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
FolderTypeCdnMappingDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/pt/v1/spreadsheetingestion

  • Mount point: /api/pt/v1/spreadsheetingestion

The following operations are supported on this resource:

POST

This method is used for Spreadsheet Ingestion. Request body must contain all required fields.

Input Payload

element consumeable content type(s)
SpreadsheetIngestionDTOapplication/json

Output Payload

element produceable content type(s)
SpreadsheetIngestionDTO application/json

Response Codes

code reason
201Created.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is present in request path.
500Request is formed correctly, but server cannot create entity. Unexpected error.

/api/cms/v1/content/commonentitysearch

  • Mount point: /api/cms/v1/content/commonentitysearch

The following operations are supported on this resource:

POST

This method is used for Common Entity search. UUID must not be specified for this operation. Request body must contain all required fields.

Input Payload

element consumeable content type(s)
CommonEntitySearchDTOapplication/json

Output Payload

element produceable content type(s)
CommonEntitySearchDTO application/json

Response Codes

code reason
201Created.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is present in request path.
500Request is formed correctly, but server cannot perform operation. Unexpected error.

/api/cms/v1/audit/{uuid}/details/

  • Mount point: /api/cms/v1/audit/{uuid}/details/

The following operations are supported on this resource:

GET

This method is used to get a specific AuditTrail Details DTO by given uuid.

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
AuditTrailDetailsDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/advancedsearch/filterdata/{type}

  • Mount point: /api/cms/v1/advancedsearch/filterdata/{type}

The following operations are supported on this resource:

GET

This method is used to get a specific instance of the FilterData DTO by given type.

URL Parameters

name description type default
typeThe type of the FilterData.path

Output Payload

element produceable content type(s)
FilterDataDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/cms/v1/advancedsearch/filterdata

  • Mount point: /api/cms/v1/advancedsearch/filterdata

The following operations are supported on this resource:

GET

This method is used to get list of available FilterData DTO objects by given optional query parameters.

URL Parameters

name description type default
paginationPaginationquery

Output Payload

element produceable content type(s)
FilterDataDTO application/json

Response Codes

code reason
200OK

Type APINode

JSON object description

nametyperequireddescription
pathPatternGroupNamestringfalse
dTOClassstringfalse
resourceHandlersArray[APIResource]false
moduleByCodefalse
pathPatternstringfalse
requestHandlerClassNamestringfalse
versionstringfalse
parentAPINodefalse

Type APIPagination

JSON object description

nametyperequireddescription
pageNumberintfalse
pageSizeintfalse

Type APIReference

JSON object description

nametyperequireddescription
hrefstringfalseThe url that references the other DTO
namestringfalseThe name of the referenced DTO
uuidstringfalse[REQUIRED] The uuid of the referenced DTO

Type APIResource

JSON object description

nametyperequireddescription
pathPatternstringfalse
requestHandlerClassNamestringfalse

Type APISearch

JSON object description

nametyperequireddescription
searchTermstringfalse

Type APISort

JSON object description

nametyperequireddescription
fieldNamestringfalse
ascendingbooleanfalse

Type ActivationDTO

JSON object description

nametyperequireddescription
is_activebooleanfalse[REQUIRED] Shows entity active (true) or not (false)

Type AuditTrailAdditionalInfo

JSON object description

nametyperequireddescription
webservice_namestringfalseName of web service that produced Audit Trail
pluginstringfalseName of plugin
method_paramsstringfalseParams of audited method
job_namestringfalseName of job that produced Audit Trail
method_namestringfalseName of audited method

Type AuditTrailCompareDTO

JSON object description

nametyperequireddescription
audit_trail_details_2AuditTrailDetailsDTOfalseSecond Audit Trail Details data
audit_trail_details_1AuditTrailDetailsDTOfalseFirst Audit Trail Details data
uuidstringfalse[READ_ONLY] Relative composed UUID1+UUID2 of Audit Trails

Type AuditTrailDTO

JSON object description

nametyperequireddescription
entity_discriminatorstringfalseThe Entity Discriminator of the Audit Trail
operationstringtrueAudited (CREATE, UPDATE, DELETE) operation
contains_audit_databooleanfalseAudit Data presence flag. The Audit Data should be retrieved as a sub resource
last_modified_dateDatetrueThe Last Modified Date of the Audit Trail
additional_infoAuditTrailAdditionalInfofalseThe Additional Info of the Audit Trail
entity_restriction_keystringfalseThe entity restriction key
accountstringfalseThe account of user who performed the operation
entity_idstringtrueThe Entity ID of the Audit Trail
sourcestringfalseThe source (WEB_SERVICE, UI) of the Audit Trail
entity_external_idstringfalseThe Entity External ID of the Audit Trail
entity_namestringfalseThe Entity Name of the Audit Trail
uuidstringfalse[READ_ONLY] The UUID of the Audit Trail

Type AuditTrailDetailsDTO

JSON object description

nametyperequireddescription
operationstringfalse[READ_ONLY] Audited (CREATE, UPDATE, DELETE) operation; OCM_AUDIT_TRAIL -> OPERATION
last_modified_dateDatefalse[READ_ONLY] The Last Modified Date of the Audit Trail
entity_uuidstringfalse[READ_ONLY] Audited Entity uuid: OCM_AUDIT_TRAIL ->ENTITY_ID
accountstringfalse[READ_ONLY] The account of user who performed the operation; OCM_AUDIT_TRAIL -> ACCOUNT
general_detailsAuditTrailDetailsInfofalseDetails Info of the Audit Trail. OCM_AUDIT_TRAIL -> AUDIT_DATA
uuidstringfalse[READ_ONLY] The UUID of the Audit Trail

Type AuditTrailDetailsInfo

JSON object description

nametyperequireddescription
locale_pkstringfalseLocale PK
discriminatorstringfalseAudited entity type discriminator
common_entity_pkstringfalseCommon Entity Pk
component_pkstringfalseComponent Pk
subscription_code_pkstringfalseSubscription Code Pk
bundle_item_pkstringfalse
custom_attribute_pkstringfalseCustom Attribute Pk
additionalInfoMap[string,string]false

Type AvailableEntityChangePluginClassDTO

JSON object description

nametyperequireddescription
class_namesSetfalse[READ_ONLY] The list of allowed class names

Type AvailableFieldsForMappingDTO

JSON object description

nametyperequireddescription
available_fieldsSetfalse[READ_ONLY] List of fields which are allowed for mapping

Type AvailableMetadataSourcePluginClassDTO

JSON object description

nametyperequireddescription
class_namestringfalse[READ_ONLY] The class name
settingsSetfalse[READ_ONLY] The list of specific settings` keys

Type BindProfileBundleAssociationDTO

JSON object description

nametyperequireddescription
bind_id_ruleCommonRuleDTOfalseBind ID Rule. The rule must have no right hand side. position_type cannot be 'ANY'. [REQUIRED] if bundle_association_rule has right_hand_side='BIND_ID'
bundle_association_ruleCommonRuleDTOtrue[REQUIRED] Bundle association rule
uuidstringfalse

Type BindProfileChainingDTO

JSON object description

nametyperequireddescription
bind_profile_to_chain_to_refDTOReferencefalseReference to Parent BindProfile which will be chained. Must have one of allowed values or null
available_bind_profile_to_chain_refsSetfalse[READ ONLY] List of BindProfile reference which can be used for chaining for main Bundle
sub_bundle_chain_rulesSetfalseList of rules for chaining for child bundles
uuidstringfalse

Type BindProfileChildBundleAssociationDTO

JSON object description

nametyperequireddescription
child_bundle_association_ruleCommonRuleDTOtrue[REQUIRED] As bundle can hold more than one child bundle of the same type, this rule directs incoming content to the correct child bundle
bundle_type_item_referencesSetfalse[REQUIRED] [READ_ONLY_AFTER_CREATION] List of bundletypeItems references which points place of tree to which component belongs
uuidstringfalse[READ_ONLY] The UUID of the BindProfileChildBundleAssociation

Type BindProfileComponentAssociationDTO

JSON object description

nametyperequireddescription
is_delete_allowedbooleanfalse[READ_ONLY] Shows that associated components can be deleted. If false field delete_obsolete_component will be ignored
rulesSettrueList of rules for association
component_type_refDTOReferencefalse[READ_ONLY] Points component type with which rule is associated
bundle_type_item_referencesSetfalse[REQUIRED, READ_ONLY after creation] List of bundletypeItems references which points place of tree to which component belongs
delete_obsolete_componentbooleanfalse[REQUIRED if is_delete_allowed=true] Shows that associated components will be deleted
uuidstringfalse[READ_ONLY] The UUID of the BindProfileComponentAssociation

Type BindProfileComponentCreateAssociationDTO

JSON object description

nametyperequireddescription
component_associate_rulestringfalseRule describing how to identify an existing component in a system, when processing a create new bundle
allow_component_create_associationbooleanfalseBoolean flag indicating, that Components supports association instead of creation new Component
uuidstringfalse

Type BindProfileDTO

JSON object description

nametyperequireddescription
is_activebooleanfalse[READ_ONLY] Shows if BindProfile is active
component_association_rule_refsSetfalse[READ_ONLY] References to component association rules of BindProfile
allow_component_plugin_updatesbooleanfalse[READ_ONLY] Shows if its Allowed component updates using plugin
last_modifiedDatefalse[READ_ONLY] The date of the last modification
allow_bundle_updatesbooleanfalse[READ_ONLY] Shows if bind profile supports bundle updates
chaining_rules_refDTOReferencefalse[READ_ONLY] BindProfileChaining rule (BindChainRule) of BindProfile
create_association_rules_refDTOReferencefalse[READ_ONLY] Allow component association on create new bundle rule (ComponentCreateAssociationRule) of BindProfile
auto_publishbooleanfalseShows if Bundle should be activated when minimum rules are met. Default value: false if ommited
allow_component_create_associationbooleanfalse[READ_ONLY] Shows if its Allowed component association on create new bundle
update_rule_refDTOReferencefalse[READ_ONLY] Reference to update rules of BindProfile
descriptionstringfalseThe description of the BindProfile
namestringtrue[REQUIRED] The name of the BindProfile
bundle_template_refDTOReferencetrue[REQUIRED] [READ_ONLY_AFTER_CREATION] The reference to BundleTemplate of the BindProfile
wait_to_advance_workflowbooleanfalseShows if wait fo advance workflow
bundle_association_rule_refDTOReferencefalse[READ_ONLY] Reference to BundleAssociation and BindID rules of BindProfile
child_bundle_association_rule_refsSetfalse[READ_ONLY] References to component association rules of BindProfile
uuidstringfalse[READ_ONLY] The UUID of the BindProfile

Type BindProfilePluginDTO

JSON object description

nametyperequireddescription
plugin_classstringfalse[REQUIRED_FOR_ACTIVATION] Full class name of plugin implementation
is_activebooleantrue[REQUIRED] Shows if plugin is active
namestringtrue[REQUIRED] The name of the BindProfilePlugin
configurationstringfalseConfiguration of plugin
uuidstringfalse[READ_ONLY] The UUID of the BindProfilePlugin

Type BindProfileUpdateRuleDTO

JSON object description

nametyperequireddescription
bind_profile_plugin_refDTOReferencefalseReference to bindProfilePlugin
allow_bundle_updatebooleanfalseBoolean flag indicating, that Bundle suppors update instead of creation new Bundle
component_update_rulestringfalseRule describing how to identify an existing component in a bundle, when processing an update or (if plugin is chosen) when plugin does not handle a particular component type
allow_component_update_pluginbooleanfalseBoolean flag indicating, that we allow component update with using plugin. In this case reference to plugin is required
allow_associationbooleanfalseBoolean flag indicating, that it is allowed to associate existing component with Bundle. Default value is false
bundle_update_ruleCommonRuleDTOfalseRule describing how to update bundle. [required] if allow_bundle_update = true
uuidstringfalse

Type BundleCleanupDTO

JSON object description

nametyperequireddescription
is_activebooleanfalseShows if Bundle is active
bundle_refDTOReferencefalseReference to the corresponding Bundle
last_modifiedDatefalseShows the last midified date
bundle_type_refDTOReferencefalseReference to the corresponding BundleType
alt_codestringfalseShows alternative code of the Bundle
uuidstringfalse

Type BundleDTO

JSON object description

nametyperequireddescription
custom_attributesSetfalseThe references to Bundle custom attributes
is_activebooleantrue[READ-ONLY]The active status of the Bundle
ciidstringfalse[READ_ONLY] The ciid of the Bundle
bind_idstringfalse[READ_ONLY] The bind id of the Bundle
version_numberintfalse[READ_ONLY] The version number of the Bundle
shop_idstringfalseThe shop id of the Bundle
source_asset_idstringfalse[READ_ONLY] The source asset id of the Bundle
last_modifiedDatefalse[READ_ONLY] The last modified date of the Bundle
auto_publish_check_requiredbooleanfalse[READ_ONLY] The auto publish check required for Bundle
subscription_code_refsSetfalseThe reference to Bundle subscription codes
auto_snapshot_allowedbooleanfalseThe autosnapshot allowed for Bundle
bundle_items_api_refAPIReferencefalse[READ_ONLY] The API reference to Bundle's Bundle Items
component_source_xml_refDTOReferencefalse[READ ONLY] The reference to Bundle source xml. Not implemented yet. Please do not use it
is_publishablebooleanfalseThe publishable status of the Bundle. Default value is false if ommited on creation
asset_idstringfalse[READ_ONLY] The asset id of the Bundle
namestringtrue[REQUIRED] The name of the Bundle
product_refsSetfalse[READ_ONLY] The references to products created using Bundle
completebooleanfalse[READ_ONLY] The complate status of the Bundle
external_idstringfalseThe external id of the Bundle
last_status_change_dateDatefalse[READ_ONLY] The last status change date of the Bundle
repository_ingest_file_pathstringfalse[READ_ONLY] The repository ingest file path of the Bundle
restriction_keystringfalse[READ_ONLY_AFTER_CREATION] The restriction key of the Bundle
alt_codestringfalseThe alt code of the Bundle
bundle_classificationstringfalse[READ_ONLY] The classification of the Bundle
bundle_type_refDTOReferencetrue[REQUIRED][READ_ONLY_AFTER_CREATION] The reference to Bundle type
provider_refDTOReferencefalseThe references to Bundle provider
create_dateDatefalse[READ_ONLY] The create date of the Bundle
uuidstringfalse[READ_ONLY] The UUID of the Bundle

Type BundleFolderTypeDTO

JSON object description

nametyperequireddescription
resource_labelsSetfalseThe resource labels of the Bundle Folder Type for different locale
namestringfalseThe name of the Bundle Folder Type
resource_keystringfalseThe resource key of the Bundle Folder Type
uuidstringfalseThe uuid of the Bundle Folder Type

Type BundleItemDTO

JSON object description

nametyperequireddescription
component_refDTOReferencetrue[REQUIRED] [READ_ONLY_AFTER_CREATION] The reference to Component
generation_typestringfalse[READ_ONLY] The generation type of the Bundle item
parent_bundle_item_refDTOReferencetrue[REQUIRED] [READ_ONLY_AFTER_CREATION] The reference to parent Bundle item
sub_order_numberintfalseThe sub order number of the Bundle item
bundle_refDTOReferencetrue[REQUIRED] [READ_ONLY_AFTER_CREATION] The reference to Bundle
order_numberintfalseThe order number of the Bundle item
bundle_type_item_refDTOReferencefalse[READ_ONLY] The reference to Bundle type item
bundle_item_resource_typeBundleItemResourceTypeEnumfalse[READ_ONLY] The resource type of the Bundle item
namestringfalse[READ_ONLY] The name of the Bundle item
child_bundle_items_api_refAPIReferencefalseThe API reference to children Bundle Items
end_dateDatefalseThe end date of the BundleItem
start_dateDatefalseThe start date of the BundleItem
uuidstringfalse[READ_ONLY] The UUID of the Bundle item

Type BundleMetadataSearchDTO

JSON object description

nametyperequireddescription
producerSetfalseThe names of the producers
directorSetfalseThe names of the directors
typestringfalseThe name of the Bundle classification type
actorSetfalseThe names of the actors
sort_fieldDTOSortFieldfalseThe sort field object that defines sorting for search result
ratingSetfalseThe ratings of the Bundle
collectionSetfalseThe collections that current Bundle is associated with
namestringfalseThe name of the Bundle
usage_typeSetfalseThe usage type of the Bundle
providerstringfalseThe name of the provider
classificationSetfalseThe classifications that the current Bundle is associated with
uuidsSetfalse[REQUIRED] The list of Bundle uuids to search metadata
localestringfalseThe locale of the localized metadata or common entity to search by
end_dateDatefalseThe end date filter
studio_codestringfalseThe studio codes of the Bundle
formatSetfalseThe formats of the Bundle
start_dateDatefalseThe start date filter
catalogSetfalseThe catalogs that the current Bundle is associated with
genreSetfalseThe genres of the Bundle
uuidstringfalseThe UUID of the Bundle

Type BundleProductizeDTO

JSON object description

nametyperequireddescription
policy_refsSettrue[REQUIRED] The references to product policies
product_refsSetfalseThe references on products related to bundle with given uuid
uuidstringfalse[READ_ONLY] The UUID of the Bundle

Type BundleSearchDTO

JSON object description

nametyperequireddescription
sortingSortingfalseThe Sorting object, contains sorting info for Bundle Search
is_activebooleanfalseThe active status of the Bundle
to_last_modifiedstringfalseThe ending last modified date of the Bundle
from_last_modifiedstringfalseThe starting last modified date of the Bundle
search_termstringfalseThe term for the Bundle search
paginationPaginationfalseThe Pagination object, contains pagination info for Bundle Search
common_entity_discriminatorstringfalseThe common entity discriminator for the Bundle search
custom_attribute_type_namestringfalseThe custom attribute type name for the Bundle search
bundle_type_uuid_listSetfalseThe Bundle Type UUIDs of the Bundle
filter_typestringfalseThe filter type for the Bundle search. Default value is BUNDLE
bundle_dto_listSetfalse[READ_ONLY] The list of found Bundle objects

Type BundleTemplateDTO

JSON object description

nametyperequireddescription
is_activebooleanfalse[READ_ONLY] The activation status of the Bundle Template
is_publishedbooleanfalse[READ_ONLY] The published status of the Bundle Template
last_modified_dateDatefalse[READ_ONLY] The last modified status of the Bundle Template
bundle_type_item_refSetfalse[READ_ONLY] The bundle folders associated with the Bundle Template
resource_labelsSetfalseThe resource labels of the Bundle Template for different locale
descriptionstringfalseThe description of the Bundle Template
namestringfalse[REQUIRED] [READ_ONLY if 'is_published'==TRUE] The name of the Bundle Template
child_bundle_type_itemSetfalse[READ_ONLY] The root bundle folders associated with the Bundle Template
bundle_classificationstringfalse[READ_ONLY] The bundle classification of the Bundle Template
resource_keystringtrue[REQUIRED] [READ_ONLY_AFTER_CREATION] The resource key of the Bundle Template
uuidstringfalse[READ_ONLY] The uuid of the Bundle Template

Type BundleTemplateFullTreeDTO

JSON object description

nametyperequireddescription
is_activebooleanfalse[READ_ONLY] The activation status of the Bundle Template
is_publishedbooleanfalse[READ_ONLY] The published status of the Bundle Template
last_modified_dateDatefalse[READ_ONLY] The last modified status of the Bundle Template
child_bundle_type_itemsSetfalse[READ_ONLY] The root bundle items which belong to the Bundle Template
resource_labelsSetfalseThe resource labels of the Bundle Template for different locale
descriptionstringfalseThe description of the Bundle Template
namestringfalse[REQUIRED] [READ_ONLY if 'is_published'==TRUE] The name of the Bundle Template
bundle_classificationstringfalse[READ_ONLY] The bundle classification of the Bundle Template
resource_keystringtrue[REQUIRED] [READ_ONLY_AFTER_CREATION] The resource key of the Bundle Template
uuidstringfalse[READ_ONLY] The uuid of the Bundle Template

Type BundleTemplatePublishDTO

JSON object description

nametyperequireddescription
is_publishedbooleantrue[REQUIRED] The publish status of the Bundle Template Resource
uuidstringfalseThe UUID of the Bundle Template Publish Resource

Type BundleTypeItemDTO

JSON object description

nametyperequireddescription
max_occurenceinttrue[REQUIRED] The maximum occurence of the current bundle type item. Must be a value >=1 or -1. If the value is -1 it means that there can be N of the current bundle type item. Always defaults to 1 for Bundle Folder Types
min_occurenceinttrue[REQUIRED] The minimum occurence of the current bundle type item. Must be a value >= 0. Always defaults to 1 for Bundle Folder Types
parent_bundle_type_item_refDTOReferencefalseThe Parent Bundle Type Item (Bundle Folder)
discriminatorstringfalse[READ_ONLY] The discriminator of the current bundle type item. Allowed values: 'BUNDLE_TYPE', 'BUNDLE_FOLDER_TYPE' or 'COMPONENT_TYPE'
child_bundle_type_items_refSetfalse[READ_ONLY] The child bundle type items (bundle folders)
add_schedulebooleantrue[REQUIRED] Determines if add schedules to the components
bundle_template_refDTOReferencefalse[REQUIRED] [READ_ONLY_AFTER_CREATION] The Bundle Template which the bundle type item (bundle folder) belongs to
type_refDTOReferencetrue[REQUIRED] [READ_ONLY_AFTER_CREATION] The type of the current bundle type item
uuidstringfalse[READ_ONLY] The uuid of the Bundle Type Item

Type BundleWarningDTO

JSON object description

nametyperequireddescription
message_dateDatefalse[READ_ONLY] The message date of the BundleWarning
bundle_refDTOReferencefalse[READ_ONLY] The reference to associated Bundle
validation_messagestringfalse[READ_ONLY] The validation message of the BundleWarning
event_typestringfalse[READ_ONLY] The event type of the BundleWarning
create_dateDatefalse[READ_ONLY] The create date of the BundleWarning
uuidstringfalse[READ_ONLY] The UUID of the BundleWarning

Type BundleXsltDTO

JSON object description

nametyperequireddescription
custom_xslt_codestringfalseThe source code of the XSLT
is_activebooleantrue[REQUIRED] The active status of the Bundle Xslt
last_modifiedDatefalse[READ_ONLY] The last modified date of the Bundle Xslt
descriptionstringfalseThe description of the Bundle Xslt
namestringtrue[REQUIRED] The name of the Bundle Xslt
is_previewablebooleanfalseThe previewable status of the Bundle Xslt
xslt_idstringtrue[REQUIRED] The Identifier of the Bundle XSLT
uuidstringfalse[READ_ONLY] The UUID of the Bundle Xslt

Type CIPublishInstanceDTO

JSON object description

nametyperequireddescription
last_modified_dateDatefalse[READ_ONLY] The last modified date of the Publish Instance
typestringfalse[READ_ONLY] The type of the Publish Instance
total_countintfalse[READ_ONLY] Shows the number of Tree Instances inside current Publish Instance
status_messagestringfalse[READ_ONLY] The status message of the Publish Instance
overall_statusstringfalse[READ_ONLY] The status enum of the Publish Instance
completed_countintfalse[READ_ONLY] Shows the number of completed Tree Instances inside current Publish Instance
tree_instancesSetfalse[READ_ONLY] Collection of the CI Classification Tree Instances related to current Publish Instance
create_dateDatefalse[READ_ONLY] The create date of the Publish Instance
uuidstringfalse[READ_ONLY] The UUID of the CI Classification Publish Instance

Type CITreePublishDTO

JSON object description

nametyperequireddescription
publish_methodstringfalse[REQUIRED] The CI publish method
node_uuidsArray[string]falseThe classification node uuids of the trees to publish. Only if NODE_UUID is used as the publish_method
uuidstringfalse

Type CatalogDTO

JSON object description

nametyperequireddescription
is_defaultbooleanfalse[READ_ONLY] Is the current catalog, the default catalog?
parent_catalog_refDTOReferencefalse[READ_ONLY] The reference to parent catalog
nameSetfalse[READ_ONLY] CatalogMetadata inside the catalog bundle
uuidstringfalse[READ_ONLY] The UUID of the Catalog

Type CategoryDTO

JSON object description

nametyperequireddescription
last_modified_dateDatefalse[READ_ONLY] The date of the last modification of Category
order_numberintfalseThe order number of Category. Number must be unique between Categories with the same inheritance level
parent_category_refDTOReferencefalseThe reference to parent Category. See DTOReference
locale_refDTOReferencefalse[DEPRECATED] Use resource_key and resource_label instead. The reference to Category's Locale. See DTOReference
resource_labelDTOResourceLabelfalse[REQUIRED][LOCALE_READ_ONLY_AFTER_CREATION] The resource label of the Category with Locale
extra_infosArray[CommonEntityExtraInfoDTO]falseList of additional information entity DTOs defined for the common entity.
namestringfalse[REQUIRED] The name of the Category
external_idstringfalseThe external id of Category
child_category_refsSetfalse[READ_ONLY]The Set of references to child Categories. See DTOReference
resource_keystringfalse[REQUIRED][READ_ONLY_AFTER_CREATION] The resource key of the Category
create_dateDatefalse[READ_ONLY] The date of creation of Category
uuidstringfalse[READ_ONLY] The uuid of the Category

Type CharConversionMappingDTO

JSON object description

nametyperequireddescription
last_modified_dateDatefalse[READ_ONLY] The last modified date of the Character Conversion Mapping
descriptionstringfalseThe description of the Character Conversion Mapping
to_charstringfalseThe single ASCII character to convert to
from_charstringtrue[REQUIRED] The single non-ASCII character to convert from.
uuidstringfalse[READ_ONLY] The uuid of the Character Conversion Mapping

Type ClassificationDetailsDTO

JSON object description

nametyperequireddescription
classification_start_dateDatefalseClassificationAttribute.startDate. This is from ClassificationNode's associated Classification's Component called Classification Attribute
classification_node_uuidstringfalseBundle.uuid of BundleType ClassificationNode
classification_uuidstringfalseBundle.uuid of Bundle Type ClassificationNode's associated child Bundle Classification
catalog_uuidstringtrue[REQUIRED] The Catalog uuid
is_adult_ratingbooleanfalseClassificationAttribute.isAdultRating
image_infosArray[DTOImageInfo]falseA list of images of the Classification Bundle, they all Physical Asset Images under the Images folder.
asset_associationsArray[DTOAssetAssociation]falseA list of objects representing program assetAssociations for the classification node.
classification_custom_attributesArray[DTOClassificationCustomAttribute]falseA list of classification custom attributes.
classification_nodesArray[DTOClassificationNodeDetailsWithSiblings]falseA list of Classification Nodes that shares the same Classification
classification_idstringfalseBundle.ciid of classification
usage_typestringfalseClassificationAttribute.usageType
classification_node_uuidsArray[string]true[REQUIRED] List of UUIDs of Classification Nodes
classification_type_refDTOReferencefalseClassificationAttribute.type. This is a common entity representing the type of the classification.
classification_end_dateDatefalseClassificationAttribute.endDate. This is from ClassificationNode's associated Classification's Component called Classification Attribute
metadatasArray[DTOMetadataClassification]falseA list of Metadata associated with the Logical Video or Collection Bundle
uuidstringfalse

Type ClassificationNodeDTO

JSON object description

nametyperequireddescription
classification_node_uuidstringfalseThe current Bundle uuid representing the classification node
classification_uuidstringfalseThe Classification Bundle uuid that is associated with the current classification node uuid
catalog_uuidstringtrue[REQUIRED] Specifies which classification hierarchy to fetch
has_associationsbooleanfalse
sub_order_numberintfalse
order_numberintfalse
namestringfalseMetadataClassification.name with the specified locale in the json request
parent_classification_node_uuidstringfalseIf passed, means that we are fetching all of the child classification node of the specified parent classification node uuid that belongs to this specified catalog uuid
classification_type_refDTOReferencefalseThis is a common entity representing the type of the classification.
localestringtrue[REQUIRED] The locale of the metadata. I.e. the name
end_dateDatetrue[REQUIRED] The end date of the window of time which at least some part of classification node exists
pathstringfalse
start_dateDatetrue[REQUIRED] The start date of the window of time which at least some part of classification node exists
parent_classification_node_refDTOReferencefalseThe Reference Object Representing the parent classification node

Type ClassificationSummaryDTO

JSON object description

nametyperequireddescription
dateDatefalse
entity_idsSettrue[REQUIRED] The collection of Bundle uuid's to summarise
image_infoSetfalse
last_availability_start_dateDatefalse
is_hiatus_availablebooleanfalse
first_availability_start_dateDatefalse
entity_typestringfalse
titlestringfalse
localestringtrue[REQUIRED] The locale of Classification
episode_numberstringfalse
is_trailer_presentbooleanfalse
asset_typeSetfalse
provider_refDTOReferencefalse
episode_titlestringfalse
uuidstringfalse

Type CollectionDetailsDTO

JSON object description

nametyperequireddescription
classification_associationsArray[DTOClassificationAssociation]falseA list of merged classification associations
generation_typestringfalseThe association's generation type
asset_associationsArray[DTOAssetAssociation]falseA list of merged collection/program associations
image_infosArray[DTOImageInfo]falseA list of image information attached to the current collection
license_windowsArray[DTOLicensingWindow]falseA list of licensing windows
offer_windowsArray[DTOOfferWindow]falseA list of offer windows
provider_refDTOLocalizedReferencefalseThe provider of the collection
metadatasArray[DTOAssetMetadata]falseA list of collection metadatas
availability_windowsArray[DTOAvailabilityWindow]falseA list of availability windows
collection_uuidstringtrue[REQUIRED] The Collection uuid
collection_type_refDTOReferencefalseThe type of the collection, i.e. SHOW_COLLECTION etc.

Type CommonEntityDTO

JSON object description

nametyperequireddescription
custom_attributesSetfalseThe custom attributes of the Common Entity
typestringfalse[REQUIRED] Type of common entity object
last_modifiedDatefalse[READ_ONLY] Last modification date of the common entity
locales_refSetfalse[DEPRECATED] Use resource_key and resource_labels instead.
resource_labelsSetfalseThe resource labels of the Common Entity for different locale
extra_infosArray[CommonEntityExtraInfoDTO]falseList of additional information entity DTOs defined for the common entity.
apply_to_all_localesbooleanfalse
external_idstringfalseThe external id of the common entity
resource_keystringfalse[READ_ONLY_AFTER_CREATION] The resource key of the Common Entity
create_dateDatefalse[READ_ONLY] Creation date of the common entity
uuidstringfalse[READ_ONLY] The UUID of the common entity

Type CommonEntityExtraInfoDTO

JSON object description

nametyperequireddescription
contentstringfalse[REQUIRED] A content of the additional information entity
uuidstringfalse[READ_ONLY] The UUID of the additional information entity

Type CommonEntitySearchDTO

JSON object description

nametyperequireddescription
sortingSortingfalseThe Sorting object, contains sorting info for Common Entity search
discriminatorstringfalseCommon Entity discriminator
search_termstringfalseCommon Entity Search Term
commonEntityResultDtosSetfalse
paginationPaginationfalseThe Pagination object, contains pagination info for Common Entity search

Type CommonEntityTypeDTO

JSON object description

nametyperequireddescription
discriminatorstringfalseThe discriminator of the common entity type
namestringfalseThe name of the CommonEntity Type
uuidstringfalseThe uuid of the CommonEntity Type

Type CommonListStringDTO

JSON object description

nametyperequireddescription
descriptionstringfalse[READ_ONLY] Descpiption of list
listArray[string]false[READ_ONLY] String list
uuidstringfalse

Type CommonRuleDTO

JSON object description

nametyperequireddescription
right_hand_sidestringfalseType of searching bundlePosition
positionintfalsePosition. Shows value of position where matching pattern will be used. Must be >= 0. Required for position type = {NTH,NTHLAST}
delimstringfalseDelimiter for pattern. Is used only for rule_type = FILENAME. If delim==null it will not be used. If it!=null will be used for position_type={ANY,FIRST,LAST}
position_typestringfalsePosition type. Shows position where matching pattern will be used
rule_typestringfalseType of rule. Point to object for which matching will be used

Type ComponentCleanupDTO

JSON object description

nametyperequireddescription
component_refDTOReferencefalseReference to the corresponding Component
last_modifiedDatefalseLast modified date of the Component
discriminatorstringfalseShows discriminator of the Component
component_binding_statusComponentBindingStatusfalseShows Component binding status: BOUND, UNBOUND, BIND_QUEUE, null means all
alt_codestringfalseShows alternative code of the Component
uuidstringfalse

Type ComponentDTO

JSON object description

nametyperequireddescription
custom_attributesSetfalseThe custom attributes of the Component
ciidstringfalseThe ciid of the Component
generation_typestringfalse[READ_ONLY] he generation type of component. It can be either SYSTEM or USER
version_numberintfalse[READ_ONLY] The version of the Component
source_asset_idstringfalseThe source asset id of the Component
external_versionstringfalseThe external version of the Component
last_modifiedDatefalse[READ_ONLY] The last modified date of the Component
component_source_xml_refDTOReferencefalseThe reference to Component source xml
component_typestringfalse[READ_ONLY_AFTER_CREATION] Type of the component
asset_idstringfalse[READ_ONLY_AFTER_CREATION] The asset id of the Component
namestringtrue[REQUIRED] The name of the Component
external_idstringfalseThe external id of the Component
repository_ingest_file_pathstringfalseThe repository ingest file path of the Component
restriction_keystringfalse[READ_ONLY_AFTER_CREATION] The restriction key of the Component
alt_codestringfalseThe alt code of the Component
create_dateDatefalse[READ_ONLY] The created date of the Component
uuidstringfalse[READ_ONLY] The uuid of the Component

Type ComponentSearchDTO

JSON object description

nametyperequireddescription
sortingSortingfalseThe Sorting object, contains sorting info for Component search
search_termstringfalseThe term for the Component seacrh
paginationPaginationfalseThe Pagination object, contains pagination info for Component search
component_dto_listSetfalse[READ_ONLY] The list of found Component objects
component_type_uuidstringfalseThe UUID of the Component's Component Type

Type ComponentTypeDTO

JSON object description

nametyperequireddescription
discriminatorstringfalseThe component discriminator of the component type
namestringfalseThe name of the Component Type
uuidstringfalseThe uuid of the Component Type

Type ConversationDTO

JSON object description

nametyperequireddescription
actionstringfalse[REQUIRED] The action type of the Conversation
conversation_type_refDTOReferencefalse[REQUIRED][READ_ONLY_AFTER_CREATION] The Conversation Type of the Conversation
bundle_refDTOReferencefalse[REQUIRED][READ_ONLY_AFTER_CREATION] The reference to Bundle
transaction_dateDatefalse[REQUIRED] The transaction date of the Conversation
transaction_details_refsSetfalse[READ_ONLY] The references to Conversation details
conversation_idstringfalse[READ_ONLY] The conversation id of the Conversation
is_bundle_activebooleanfalse[REQUIRED] The active status of Bundle
transaction_typestringfalse[READ_ONLY] The ConversationType name of the Conversation
statusstringfalse[REQUIRED] The status of the Conversation
versionintfalse[REQUIRED] The version of the Conversation
uuidstringfalse[READ_ONLY] The UUID of the Conversation

Type ConversationDetailsDTO

JSON object description

nametyperequireddescription
level_typestringfalseThe level type of the Conversation details
message_dateDatefalse[REQUIRED] The message date of the Conversation details
status_codestringfalse[REQUIRED] The status code of the Conversation details
short_messagestringfalseThe short message of the Conversation details
detailed_messagestringfalse[REQUIRED] The detailed message of the Conversation details
message_typestringfalse[REQUIRED] The message type of the Conversation details
conversation_refDTOReferencefalse[REQUIRED][READ_ONLY_AFTER_CREATION] The reference to Conversation
uuidstringfalse[READ_ONLY] The UUID of the Conversation details

Type ConversationRetryDTO

JSON object description

nametyperequireddescription
perform_retrybooleantrue[REQUIRED] The retry flag of the Conversation
uuidstringfalse[READ_ONLY] The UUID of the Conversation

Type ConversationTypeDTO

JSON object description

nametyperequireddescription
entity_change_plugin_refDTOReferencefalse[READ_ONLY] Reference to Entity Change Plugin of ConversationType
namestringfalse[READ_ONLY] The UUID of the ConversationType
uuidstringfalse[READ_ONLY] The UUID of the ConversationType

Type CurrencyDTO

JSON object description

nametyperequireddescription
is_activebooleantrue[REQUIRED] Shows if Currency is active
is_defaultbooleanfalseShows if Currency is a default one
iso_localestringtrue[REQUIRED] The ISO code for locale
last_modifiedDatefalse[READ_ONLY] Date+Time when Currency was modified
namestringtrue[REQUIRED] The name of Currency
iso_currency_codestringtrue[REQUIRED] The ISO code for currency (3 chars)
uuidstringfalse[READ_ONLY] The UUID of the Currency

Type CustomAttributeTypeDTO

JSON object description

nametyperequireddescription
is_requiredbooleanfalseShows if attribute is required. Default value is false
entry_modestringtrue[REQUIRED] The Entry Mode of the Custom Attribute. Requried on Publish
default_valuestringfalseThe Default Value of the Custom Attribute
is_publishedbooleanfalse[READ_ONLY] Whether the Custom Attribute is Published and ready to use by the associated Components
typestringtrue[REQUIRED] The Type of the Custom Attribute. Requried on Publish
common_entity_type_refsSetfalseThe Common Entity Type to associate to, must specify at least one. Required on Publish when target == CustomAttributeTarget.COMMON_ENTITY
last_modifiedDatefalse[READ_ONLY] The last modified date of the Custom Attribute
targetstringfalse[REQUIRED] ['COMPONENT' or 'COMMON_ENTITY'] Whether the Custom Attribute associated to Components or Common Entities
resource_labelsSetfalseThe Resource Labels (language, label) pair corresponding to the resource key
identifierstringfalseIdentifier for CustomAttributeType
descriptionstringfalseThe description of the Custom Attribute Type
namestringtrue[REQUIRED] The name of the Custom Attribute Type
list_item_resource_bundlesSetfalseRequired and only used if Custom Attribute is of 'pre-defined' or 'pre-defined-multiple' type, It is the associated pre-defined items for custom attribute, its resource key and resource labels for each of the item
resource_keystringtrue[REQUIRED] The resource key of the resource labels
component_type_refsSetfalseThe Component Type to associate to, must specify at least one. Required on Publish when target == CustomAttributeTarget.COMPONENT
uuidstringfalse[READ_ONLY] The UUID of the Custom Attribute Type

Type CustomAttributeTypePublishingDTO

JSON object description

nametyperequireddescription
is_publishedbooleanfalse[REQUIRED] The Publish Status of the Custom Attribute Type
uuidstringfalse[READ_ONLY] The UUID of the Custom Attribute Type

Type DTOAssetAssociation

JSON object description

nametyperequireddescription
generation_typestringfalseThe association's bundleItem.generationType
merged_offer_visibility_windowsArray[DTODateRange]falseThe merged offer visibility windows.
asset_uuidstringfalseThe uuid of the Logical Video Bundle or Collections Bundle
association_uuidstringfalseThe Classification Bundle's bundleItem that associates to a Logical Video Bundle or Collection Bundle
asset_typestringfalseThe type of the associated bundle
order_numintfalseThe association's bundleitem.orderNumber
metadatasArray[DTOMetadata]falseThe metadatas attached to the asset from association
visibility_windowsArray[DTODateRange]falseOffer Windows of the Program/Collection, the Association Window and the Classification Node Schedule. It can end up with a list of start/end dates that can be greater than the total number of classification node for that classification
asset_subtypestringfalseThe discriminator of the SHOW_COLLECTION bundle

Type DTOAssetMetadata

JSON object description

nametyperequireddescription
summarystringfalseThe summary of asset's Metadata
namestringtrue[REQUIRED] The name of Metadata
localestringtrue[REQUIRED] The locale of Metadata
genre_refDTOReferencefalseThe Genre common entity of asset's Metadata
uuidstringfalseThe uuid of asset's Metadata

Type DTOAssetMetadataSave

JSON object description

nametyperequireddescription
actionstringtrue[REQUIRED]
summarystringfalseThe summary of asset's Metadata
namestringtrue[REQUIRED] The name of Metadata
localestringtrue[REQUIRED] The locale of Metadata
genre_refDTOReferencefalseThe Genre common entity of asset's Metadata
uuidstringfalseThe uuid of asset's Metadata

Type DTOAssociationMetadata

JSON object description

nametyperequireddescription
namestringtrue[REQUIRED] The name of Metadata
localestringtrue[REQUIRED] The locale of Metadata
uuidstringfalseThe identifier of the association metadata.

Type DTOAssociationSave

JSON object description

nametyperequireddescription
actionstringtrue[REQUIRED]
generation_typestringfalseGeneration type, default value is USER
association_start_dateDatetrue[REQUIRED_for_CREATE,UPDATE] Start date of association
target_uuidstringfalse[REQUIRED_for_CREATE,UPDATE] The Target uuid for association (can be uuid of Classification, Node or Collection)
association_uuidstringfalse[REQUIRED_for_CREATE,UPDATE] The Target Bundle's bundleItem uuid that associates to a child Bundle
association_end_dateDatetrue[REQUIRED_for_CREATE,UPDATE] End date of association
order_numintfalseThe association's bundleitem.orderNumber

Type DTOAvailabilityWindow

JSON object description

nametyperequireddescription
offer_type_refDTOReferencefalseThe offer type of the Availability Window. Eg: IPPR, FREE, etc
usage_typestringfalseThe usage type of the Availability Window
end_dateDatefalseThe end date of the Availability Window
start_dateDatefalseThe start date of the Availability Window
uuidstringfalseThe identifier of the Availability Window

Type DTOAvailabilityWindowSave

JSON object description

nametyperequireddescription
actionstringtrue[REQUIRED]
offer_type_refDTOReferencefalseThe offer type of the Availability Window. Eg: IPPR, FREE, etc
usage_typestringfalseThe usage type of the Availability Window
end_dateDatefalseThe end date of the Availability Window
start_dateDatefalseThe start date of the Availability Window
uuidstringfalseThe identifier of the Availability Window

Type DTOClassificationAssociation

JSON object description

nametyperequireddescription
generation_typestringfalseThe association's generation type.
classification_uuidstringfalseThe identifier of the classification.
classification_type_refDTOReferencefalseThis is a common entity representing the type of the classification.
association_uuidstringfalseThe association's UUID.
order_numintfalseThe association's order number.
merged_classification_node_scheduleArray[DTODateRange]falseA list of merged classification node schedules.
metadatasArray[DTOClassificationPath]falseA list of classification path for all languages.
visibility_windowsArray[DTODateRange]falseThe association's visibility windows.

Type DTOClassificationCustomAttribute

JSON object description

nametyperequireddescription
valuestringfalseCustom Attribute value
namestringfalseCustom Attribute name
uuidstringfalseCustom Attribute UUID

Type DTOClassificationCustomAttributeSave

JSON object description

nametyperequireddescription
actionstringtrue[REQUIRED]
valuestringfalseCustom Attribute value
namestringfalseCustom Attribute name
uuidstringfalseCustom Attribute UUID

Type DTOClassificationNodeDetails

JSON object description

nametyperequireddescription
classification_node_end_dateDatefalseEnd date for classification node, mapped from ClassificationNode.ClassificationNodeAttribute.endDate
classification_uuidstringfalseThe Classification Bundle uuid that is associated with the current classification node uuid
catalog_uuidstringfalseThe catalog to which classification belongs
classification_node_uuidstringfalseClassificationNode UUID
sub_order_numberintfalseAdditional order number of classification node, used when order numbers are the same, mapped from bundleItem.subOrderNumber
order_numberintfalseOrder number, mapped from BundleItem.orderNumber
classification_type_refDTOReferencefalseThe reference to the classification type common entity of node's classification
classification_node_start_dateDatefalseStart date for classification node, mapped from ClassificationNode.ClassificationNodeAttribute.startDate
metadatasArray[DTOMetadataClassificationNode]falseList of classification node metadatas

Type DTOClassificationNodeDetailsSave

JSON object description

nametyperequireddescription
actionstringtrue[REQUIRED]
classification_node_end_dateDatefalseEnd date for classification node, mapped from ClassificationNode.ClassificationNodeAttribute.endDate
classification_uuidstringfalseThe Classification Bundle uuid that is associated with the current classification node uuid
classification_node_uuidstringfalseClassificationNode UUID
catalog_uuidstringtrue[REQUIRED] The catalog to which classification belongs
sub_order_numberintfalseAdditional order number of classification node, used when order numbers are the same, mapped from bundleItem.subOrderNumber
order_numberintfalseOrder number, mapped from BundleItem.orderNumber
parent_classification_node_uuidstringtrue[REQUIRED] The parent of the classification node to point to
classification_type_refDTOReferencefalseThe reference to the classification type common entity of node's classification
classification_node_start_dateDatefalseStart date for classification node, mapped from ClassificationNode.ClassificationNodeAttribute.startDate
metadatasArray[DTOMetadataClassificationNode]falseList of classification node metadatas

Type DTOClassificationNodeDetailsWithSiblings

JSON object description

nametyperequireddescription
classification_node_end_dateDatefalseEnd date for classification node, mapped from ClassificationNode.ClassificationNodeAttribute.endDate
classification_uuidstringfalseThe Classification Bundle uuid that is associated with the current classification node uuid
catalog_uuidstringfalseThe catalog to which classification belongs
classification_node_uuidstringfalseClassificationNode UUID
sub_order_numberintfalseAdditional order number of classification node, used when order numbers are the same, mapped from bundleItem.subOrderNumber
order_numberintfalseOrder number, mapped from BundleItem.orderNumber
parent_classification_nodeDTOClassificationNodeDetailsfalseParent Classification Node Details
sibling_nodesArray[DTOClassificationNodeDetails]falseList of Classification Node Details
classification_type_refDTOReferencefalseThe reference to the classification type common entity of node's classification
classification_node_start_dateDatefalseStart date for classification node, mapped from ClassificationNode.ClassificationNodeAttribute.startDate
metadatasArray[DTOMetadataClassificationNode]falseList of classification node metadatas

Type DTOClassificationNodeWithChildren

JSON object description

nametyperequireddescription
classification_node_end_dateDatefalseEnd date for classification node, mapped from ClassificationNode.ClassificationNodeAttribute.endDate
classification_node_uuidstringfalseClassificationNode UUID
sub_order_numberintfalseAdditional order number of classification node, used when order numbers are the same, mapped from bundleItem.subOrderNumber
order_numberintfalseOrder number, mapped from BundleItem.orderNumber
child_classification_nodesArray[DTOClassificationNodeDetails]falseEnd date for classification node, mapped from ClassificationNode.ClassificationNodeAttribute.endDate
classification_node_start_dateDatefalseStart date for classification node, mapped from ClassificationNode.ClassificationNodeAttribute.startDate
metadatasArray[DTOMetadataClassificationNode]falseList of classification node metadatas

Type DTOClassificationPath

JSON object description

nametyperequireddescription
classification_node_pathstringfalseThe classification path.
localestringfalseThe locale of the language.
uuidstringfalseThe identifier.

Type DTOCollectionAssociation

JSON object description

nametyperequireddescription
generation_typestringfalseThe association's generation type.
association_uuidstringfalseThe association's UUID.
order_numintfalseThe association's order number.
metadatasArray[DTOAssociationMetadata]falseA list of collection name for all languages.
visibility_windowsArray[DTODateRange]falseThe association's visibility windows.
merged_collection_offer_scheduleArray[DTODateRange]falseA list of merged collection offer schedules.
collection_uuidstringfalseThe identifier of the collection.

Type DTODateRange

JSON object description

nametyperequireddescription
end_dateDatefalse
start_dateDatefalse

Type DTOImageInfo

JSON object description

nametyperequireddescription
image_type_refDTOReferencefalseThe first ImageType common entity of Physical Asset Image
file_sizelongfalseThe file size in bytes of Physical Asset Image
access_urlstringfalseThe asset URL of Physical Asset Image, mapped from PhysicalAssetImage.cdnURL field
physical_asset_image_uuidstringfalseThe uuid of the Physical Asset Image Object
namestringfalseThe name of the Physical Asset Image Object
localestringfalseThe locale field of Physical Asset Image
heightintfalseThe height in pixels of Physical Asset Image
end_dateDatefalseThe end date of the Bundle containing Physical Asset Image
widthintfalseThe width in pixels of Physical Asset Image
start_dateDatefalseThe start date of the Bundle containing Physical Asset Image

Type DTOImageInfoSave

JSON object description

nametyperequireddescription
actionstringtrue[REQUIRED]
image_type_refDTOReferencefalseThe first ImageType common entity of Physical Asset Image
file_sizelongfalseThe file size in bytes of Physical Asset Image
access_urlstringfalseThe asset URL of Physical Asset Image, mapped from PhysicalAssetImage.cdnURL field
physical_asset_image_uuidstringfalseThe uuid of the Physical Asset Image Object
namestringfalseThe name of the Physical Asset Image Object
heightintfalseThe height in pixels of Physical Asset Image
localestringfalseThe locale field of Physical Asset Image
end_dateDatefalseThe end date of the Bundle containing Physical Asset Image
association_uuidstringfalseThe UUID of image association to target
widthintfalseThe width in pixels of Physical Asset Image
start_dateDatefalseThe start date of the Bundle containing Physical Asset Image

Type DTOLicensingWindow

JSON object description

nametyperequireddescription
end_dateDatefalseThe end date of the Licensing Window
start_dateDatefalseThe start date of the Licensing Window
uuidstringfalseThe identifier of the Licensing Window

Type DTOLicensingWindowSave

JSON object description

nametyperequireddescription
actionstringtrue[REQUIRED]
end_dateDatefalseThe end date of the Licensing Window
start_dateDatefalseThe start date of the Licensing Window
uuidstringfalseThe identifier of the Licensing Window

Type DTOLocalizedReference

JSON object description

nametyperequireddescription
hrefstringfalseThe url that references the other DTO
namestringfalseThe name of the referenced DTO
resource_bundleDTOResourceBundlefalseResource bundle for localization.
uuidstringfalse[REQUIRED] The uuid of the referenced DTO

Type DTOMetadata

JSON object description

nametyperequireddescription
namestringtrue[REQUIRED] The name of Metadata
localestringtrue[REQUIRED] The locale of Metadata

Type DTOMetadataClassification

JSON object description

nametyperequireddescription
toggle_labelstringfalseThe toggle label of Metadata Classification
short_namestringfalseThe short title of Metadata Classification
provider_brandingstringfalseThe provider branding of Metadata Classification
synopsisstringfalseThe long summary of Metadata Classification
long_namestringfalseThe long title of Metadata Classification
namestringtrue[REQUIRED] The name of Metadata
localestringtrue[REQUIRED] The locale of Metadata
soft_namestringfalseThe soft name of Metadata Classification
medium_namestringfalseThe medium title of Metadata Classification
uuidstringfalseThe uuid of Metadata Classification

Type DTOMetadataClassificationNode

JSON object description

nametyperequireddescription
localestringfalseLocale field of Classification Node Metadata
pathstringfalsePath to this classification node from the root node

Type DTOMetadataClassificationSave

JSON object description

nametyperequireddescription
actionstringtrue[REQUIRED]
toggle_labelstringfalseThe toggle label of Metadata Classification
short_namestringfalseThe short title of Metadata Classification
provider_brandingstringfalseThe provider branding of Metadata Classification
synopsisstringfalseThe long summary of Metadata Classification
long_namestringfalseThe long title of Metadata Classification
namestringtrue[REQUIRED] The name of Metadata
localestringtrue[REQUIRED] The locale of Metadata
soft_namestringfalseThe soft name of Metadata Classification
medium_namestringfalseThe medium title of Metadata Classification
uuidstringfalseThe uuid of Metadata Classification

Type DTOOfferWindow

JSON object description

nametyperequireddescription
generation_typestringfalseThe value indicating if it is a 'SYSTEM' generated or 'USER' generated
catalog_uuidstringfalseThe identifier of the catalog
planner_retentionintfalseThe planner retention of the OfferWindow
offer_type_refDTOReferencefalseThe offer type of the Offer Window. Eg: IPPR, FREE, etc
usage_typestringfalseThe usage type of the Offer Window
expiry_dateDatefalseThe expiry date of the Offer Window
end_dateDatefalse[READ_ONLY] The end date of the Offer Window, which calculated dynamically by offerType offerEndCalculator.
start_dateDatefalseThe start date of the Offer Window
uuidstringfalseThe identifier of the Offer Window

Type DTOOfferWindowSave

JSON object description

nametyperequireddescription
actionstringtrue[REQUIRED]
generation_typestringfalseThe value indicating if it is a 'SYSTEM' generated or 'USER' generated
catalog_uuidstringfalseThe identifier of the catalog
planner_retentionintfalseThe planner retention of the OfferWindow
offer_type_refDTOReferencefalseThe offer type of the Offer Window. Eg: IPPR, FREE, etc
usage_typestringfalseThe usage type of the Offer Window
expiry_dateDatefalseThe expiry date of the Offer Window
end_dateDatefalse[READ_ONLY] The end date of the Offer Window, which calculated dynamically by offerType offerEndCalculator.
start_dateDatefalseThe start date of the Offer Window
uuidstringfalseThe identifier of the Offer Window

Type DTOProgramMetadata

JSON object description

nametyperequireddescription
studio_code_refDTOReferencefalseThe value of the studio code.
summarystringfalseThe value of the summary.
titlestringfalseThe name of the programme.
marketing_messagestringfalseThe value of the marketing message.
localestringfalseThe locale of the language.
episode_numberintfalseThe value of the episode number.
genre_refDTOReferencefalseThe value of the genre/sub genre.
episode_titlestringfalseThe name of the episode.
uuidstringfalseThe identifier of the program metadata.

Type DTOReference

JSON object description

nametyperequireddescription
hrefstringfalseThe url that references the other DTO
namestringfalseThe name of the referenced DTO
uuidstringfalse[REQUIRED] The uuid of the referenced DTO

Type DTOResourceBundle

JSON object description

nametyperequireddescription
resource_labelsSetfalseThe Resource Labels (language, label) pair corresponding to the resource key
resource_keystringtrue[REQUIRED] The resource key of the resource labels

Type DTOResourceLabel

JSON object description

nametyperequireddescription
labelstringfalseThe resource label corresponding to the language
languagestringfalseThe language of the resource label

Type DTOSortField

JSON object description

nametyperequireddescription
field_namestringtrue[REQUIRED] The name of the sort field.
orderSortOrdertrue[REQUIRED] The sort order. Possible values: ['ASC', 'DESC']

Type DTOTrailerInfo

JSON object description

nametyperequireddescription
file_sizelongfalseThe file size of the trailer.
access_urlstringfalseThe url of the location of the image.
namestringfalseThe file name of the trailer.
physical_asset_video_uuidstringfalseThe identifier of the trailer.
durationstringfalseThe duration of the trailer.

Type DataForAssociationDTO

JSON object description

nametyperequireddescription
asset_uuidsArray[string]true[REQUIRED] Bundle UUIDs of PROGRAM or COLLECTION
offer_visibility_windowsArray[DTOOfferWindow]falseThe list of offer windows
typestringfalseThe type of the asset
asset_uuidstringfalseBundle UUID of PROGRAM or COLLECTION
metadatasArray[DTOMetadata]falseThe metadatas attached to the asset

Type DataForClassificationAssociationDTO

JSON object description

nametyperequireddescription
classification_uuidstringfalseThe current Bundle uuid representing the Classification
usage_typestringfalseClassificationAttribute.usageType. Usage type of the Classification Bundle
classification_type_refDTOReferencefalseClassificationAttribute.type. This is a common entity representing the type of the Classification
classification_uuidsArray[string]true[REQUIRED] List of UUIDs of Classifications
merged_classification_nodesArray[DTODateRange]falseThe list of classification node that belong to the current classification and merge them by start/end if they overlap
metadatasArray[DTOMetadataClassification]falseA list of object representing the metadatas of the of the current Classification, in all of the locales

Type DataForClassificationDTO

JSON object description

nametyperequireddescription
classification_node_uuidstringtrue[REQUIRED] ClassificationNode UUID
classification_uuidstringfalseThe Classification Bundle uuid that is associated with the current classification node uuid
classification_nodesArray[DTOClassificationNodeWithChildren]falseThe list of the classification nodes with the same classification, path and catalog as the requested node.
classification_type_refDTOReferencefalseReference to ClassificationAttribute.classificationType

Type DeleteClassificationDTO

JSON object description

nametyperequireddescription
catalog_uuidstringtrue[REQUIRED] The Catalog uuid
classification_node_uuidstringtrue[REQUIRED] UUID of Classification Node that should be deleted
uuidstringfalse

Type EntityChangePluginDTO

JSON object description

nametyperequireddescription
process_all_entitiesbooleanfalseTrue - plugin will process all entities, False - plugin will process only entities from list 'entity_to_process'. If False then 'entity_to_process' has to contain at least one entity
plugin_typestringtrue[REQUIRED] Type of plugin
plugin_classstringtrue[REQUIRED] Full class name of plugin implementation
is_activebooleanfalse[READ_ONLY] Shows if EntityChangePlugin is active.
entity_to_processSetfalseList of types of entities which should be processed by plugin
process_all_pluginsbooleanfalseTrue - plugin will call all none CORE plugins which have active status for processing entity. (Related from custom implementation of plugin). False - plugin will call plugins from list 'plugin_to_process' only
namestringtrue[REQUIRED] The name of the EntityChangePlugin
last_runlongfalse[READ_ONLY] The POSIX time that this plugin was last processed successfully
intervallongtrue[REQUIRED] Interval for start plugin in milliseconds. Default value is 60 000 ms
plugin_to_processSetfalseList of none CORE plugins which should be called by plugin for processing of entity
uuidstringfalse[READ_ONLY] The UUID of the EntityChangePlugin

Type EntityDTO

JSON object description

nametyperequireddescription
class_namestringfalseFull class name of Entity
namestringfalseThe name of Entity

Type EntityFieldInfoDTO

JSON object description

nametyperequireddescription
field_namestringfalse[READ_ONLY] The name of the field
discriminatorstringfalse[READ_ONLY] The specific discriminator of the field
field_name_resource_bundleDTOResourceBundlefalse[READ_ONLY] The DTOResourceBundle that is used to represent the name of the field in different locale
entity_typestringfalse[READ_ONLY] The entity type of the field
field_idstringfalse[READ_ONLY] The id of the field that is generated
localization_methodstringfalse[READ_ONLY] The localization method of the field or null for custom attributes
field_description_resource_bundleDTOResourceBundlefalse[READ_ONLY] The DTOResourceBundle that is used to represent the description of the field in different locale
field_typestringfalse[READ_ONLY] The type of the field (e.g. STRING, DATE, INTEGER)
uuidstringfalse[READ_ONLY] The UUID of the field

Type FeedDTO

JSON object description

nametyperequireddescription
is_activebooleantrue[REQUIRED] Shows if Feed is active
last_modifiedDatefalse[READ_ONLY] Date+Time when Feed was modified
descriptionstringfalseThe description ofthe Feed
namestringtrue[REQUIRED] The name of the Feed
bundle_type_refsSetfalse[REQUIRED if use_allbundle_type = false] List of references to Bundle Types which are processed by Feed. If use_all_bundle_type=true list must be empy. If use_all_bundle_type=false must have at least one Bundle Type
is_product_feedbooleanfalseDefines type of Feed. True - product, False - bundle
feed_type_refDTOReferencetrue[REQUIRED] Reference to FeedType which defines a type of Feed
use_all_bundle_typebooleantrue[REQUIRED] Shows if Feed will process all bundletypes
uuidstringfalse[READ_ONLY] The UUID of the Feed

Type FeedTypeDTO

JSON object description

nametyperequireddescription
is_activebooleanfalse[READ_ONLY] The activation status of the Feed Type
is_productbooleanfalse[READ_ONLY_AFTER_CREATION] Shows if FeedType is Product (true) or Bundle (false)
last_modified_dateDatefalse[READ_ONLY] The last modified date of the Feed Type
descriptionstringfalseThe Description of the Feed Type
entity_change_plugin_refDTOReferencetrue[REQUIRED] The reference to the Feed Entity Change Plugin it applies to
xslt_bytestringfalseThe XSLT source code for the Feed Type
namestringtrue[REQUIRED] The name of the Feed Type
uuidstringfalse[READ_ONLY] The uuid of the Feed Type DTO

Type FilterDataDTO

JSON object description

nametyperequireddescription
filter_typestringfalse[READ_ONLY] The type of the filter
filter_instancesSetfalse[READ_ONLY] The list of filter instances
uuidstringfalse

Type FolderTypeCdnMappingDTO

JSON object description

nametyperequireddescription
image_type_refDTOReferencefalseimage type which is linked to image cdn mapping
descriptionstringfalseThe description of the Folder Type CDN Mapping
destinationstringfalseThe destination of the Folder Type CDN Mapping. Should start and end with a slash symbol '/', consist of Repository Node name + relative path to the destination folder
uuidstringfalse[READ_ONLY] The uuid of the Folder Type CDN Mapping

Type ImageProfileAvailableFormatDTO

JSON object description

nametyperequireddescription
format_namestringfalse[READ_ONLY] The file format name
color_depthArray[int]false[READ_ONLY] The list of allowed color depth values for file format name

Type ImageProfileDTO

JSON object description

nametyperequireddescription
image_type_refDTOReferencefalseimage type which is linked to image profile
is_activebooleanfalse[REQUIRED] Shows that image profile is active (true) or not (false)
letter_boxing_background_colorintfalse[REQUIRED if letter_boxing=true and file format is not PNG] The background color for image
related_thumbnailbooleanfalse[ACTUAL for image_type=ARTWORK only] Determines that thumbnail will be created (true) or not (false) for ARTWORK image
letter_boxingbooleanfalse[REQUIRED] Shows that letterBoxing is used for image transformation
target_device_refsSetfalseList device targets which is linked to image profile
last_modifiedDatefalse[READ_ONLY] The date of the last modification
selected_file_formatstringfalse[REQUIRED] The selected image file format. Must be one from available file format values. See AvailableImageFormat API Transparency property available for PNG format only.
selected_color_depthintfalse[REQUIRED] The selected color depth for image. Must be one from available file format values for selected image file format
related_thumbnail_heightintfalse[REQUIRED if related_thumbnail=true] The height of thumbnail image. Must be > 0 and <=9999
related_thumbnail_widthintfalse[REQUIRED if related_thumbnail=true] The width of thumbnail image. Must be > 0 and <=9999
descriptionstringfalseThe description of Image Profile
namestringfalse[REQUIRED] The name of Image Profile
renaming_optionsstringfalseThe options for renaming image. Default renaming will be done by concatenating the original image name, associated image profile, and any options listed here (such as $d for date extension).
heightintfalse[REQUIRED] The height of image. Must be > 0 and <=9999
widthintfalse[REQUIRED] The width of image. Must be > 0 and <=9999
transparentbooleanfalse[ACTUAL for PNG file format only] Shows that image background must be transparent
uuidstringfalse[READ_ONLY] The uuid of Image Profile

Type JustInTimePolicyDTO

JSON object description

nametyperequireddescription
is_activebooleanfalseShows if JustInTimePolicy is active. Default value for POST operations: false.
hours_before_offer_startintfalseShows the number of hours before offer window start for JustInTimePolicy to make the action. Default value for POST operations: 48. [REQUIRED] for active policy
last_modifiedDatefalse[READ_ONLY] The last modified date of JustInTimePolicy
descriptionstringfalseThe description of JustInTimePolicy
entity_change_plugin_refDTOReferencefalseThe reference to entityChangePlugin. [REQUIRED] for active policy.
namestringfalse[REQUIRED] The name of the JustInTimePolicy
create_dateDatefalse[READ_ONLY] The creation date of JustInTimePolicy
uuidstringfalse[READ_ONLY] The uuid of the JustInTimePolicy

Type LocaleDTO

JSON object description

nametyperequireddescription
localeCodestringfalseConcatenation of language and country
countrystringfalseThe country code of the Locale
isDefaultbooleanfalseis the localeCode the default locale?
languageNamestringfalseLanguage Display Name
languagestringfalseThe language code of the Locale
uuidstringfalseThe uuid of the Locale

Type MetadataSourcePluginDTO

JSON object description

nametyperequireddescription
plugin_classstringfalseThe full name of implementation class of MetadataSourcePlugin
is_activebooleanfalse[READ_ONLY] Shows that plugin is active (true) or not (false)
field_mapping_schemastringfalse[READ_ONLY] The xsd which describes scheme of allowed mapping rules
plugin_specific_valuesSetfalseList of plugin`s specific settings
namestringfalse[REQUIRED, UNIQUE] The name of MetadataSourcePlugin
field_mapping_xmlstringfalseThe mapping XML which describes rules how to map input data to inner model data
selected_field_mapSetfalseList of fields which will be mapped to locales by plugin
uuidstringfalse[READ_ONLY] The uuid of MetadataSourcePlugin

Type NotificationPluginDTO

JSON object description

nametyperequireddescription
plugin_classstringfalseFull class name of plugin implementation
is_activebooleantrue[REQUIRED] Shows if plugin is active
is_defaultbooleanfalse[READ_ONLY] Shows if plugin is predefined (default). All new plugins will have dafult value = false
namestringtrue[REQUIRED] The name of the NotificationPlugin
uuidstringfalse[READ_ONLY] The UUID of the NotificationPlugin

Type OriginMappingDTO

JSON object description

nametyperequireddescription
url_signer_config_refDTOReferencefalseThe reference to UrlSignerConfiguration
public_urlstringtrue[REQUIRED] The public url of the OriginMapping
namestringtrue[REQUIRED] The name of the OriginMapping
origin_base_urlstringtrue[REQUIRED] The origin base url of the OriginMapping
uuidstringfalse[READ_ONLY] The UUID of the OriginMapping

Type Pagination

JSON object description

nametyperequireddescription
first_page_urlstringfalse
page_sizeintfalse[REQUIRED] The size of page
total_pagesintfalse
last_page_urlstringfalse
total_countlongfalse
page_numberintfalse[REQUIRED] The number of page
next_page_urlstringfalse
previous_page_urlstringfalse

Type PerformSearchDTO

JSON object description

nametyperequireddescription
search_typeSearchTypetrue[REQUIRED] The type of search (searching by availability or offers)
producerSetfalseThe names of the producers
directorSetfalseThe names of the directors
typestringfalseThe name of the Bundle classification type
actorSetfalseThe names of the actors
sort_fieldDTOSortFieldfalseThe sort field object that defines sorting for search result
ratingSetfalseThe ratings of the Bundle
exclude_bundle_typeSetfalseThe list of bundle types (bundle templates), that should be excluded
search_termstringfalseThe term for the search
classification_filtersSetfalseThe classification filters
classification_usage_type_filtersSetfalseThe classification usage type filters
program_usage_type_filtersSetfalseThe program usage type filters
collectionSetfalseThe collections that current Bundle is associated with
facet_result_onlybooleantrue[REQUIRED] Whether or not to return the JSON request with facet_count populated for each of the filters
common_entity_filtersSetfalseThe common entity filters
namestringfalseThe name of the Bundle
usage_typeSetfalseThe usage type of the Bundle
providerstringfalseThe name of the provider
talent_filtersSetfalseThe Talent common entity filters
classificationSetfalseThe classifications that the current Bundle is associated with
localestringfalseThe locale of the localized metadata or common entity to search by
entity_field_filtersSetfalseThe entity field filters
end_dateDatefalseThe end date filter
availability_typeAvailabilityTypetrue[REQUIRED] The availability type
save_searchbooleantrue[REQUIRED] Whether or not to Save the current Search i.e. the JSON Request
studio_codestringfalseThe studio codes of the Bundle
formatSetfalseThe formats of the Bundle
start_dateDatefalseThe start date filter
catalogSetfalseThe catalogs that the current Bundle is associated with
dynamic_attribute_filtersSetfalseThe dynamic atribute filters
uuidstringfalseThe UUID of the Bundle
genreSetfalseThe genres of the Bundle

Type PolicyDTO

JSON object description

nametyperequireddescription
offer_typestringfalseThe offer type of the Policy
is_activebooleantrue[REQUIRED] The active status of the Policy
last_modifiedDatefalse[READ_ONLY] The last modified date of the Policy
descriptionstringfalseThe description of the Policy
namestringtrue[REQUIRED] The name of the Policy
is_subscriptionbooleantrue[REQUIRED] The subscription status of the Policy
uuidstringfalse[READ_ONLY] The UUID of the Policy

Type ProductResolutionPluginDTO

JSON object description

nametyperequireddescription
plugin_classstringfalse[REQUIRED_FOR_ACTIVATION] Full class name of plugin implementation
is_activebooleantrue[REQUIRED] Shows if plugin is active
last_modifiedDatefalse[READ_ONLY] Shows date and time of last plugin modification
predefinedbooleanfalse[READ_ONLY] Shows if plugin is predefined. All new plugins will have predefined value = false
namestringtrue[REQUIRED] The name of the ProductResolutionPlugin
uuidstringfalse[READ_ONLY] The UUID of the NotificationPlugin

Type ProgramDetailsDTO

JSON object description

nametyperequireddescription
director_refsArray[DTOLocalizedReference]falseA list of directors.
rating_refsArray[DTOReference]falseThe parental ratings of the programme.
classification_associationsArray[DTOClassificationAssociation]falseA list of merged classification associations.
producer_refsArray[DTOLocalizedReference]falseA list of producers.
cast_member_refsArray[DTOLocalizedReference]falseA list of cast members.
collection_associationsArray[DTOCollectionAssociation]falseA list of merged collection associations.
advisory_refsArray[DTOReference]falseThe parental advisories of the programme.
image_infosArray[DTOImageInfo]falseA list of image information for each language.
license_windowsArray[DTOLicensingWindow]falseA list of license windows.
asset_format_refDTOReferencefalseThe value of the movie format.
aspect_ratiostringfalseThe value of the movie aspect ratio.
asset_idstringfalseThe asset id of the movie.
writer_refsArray[DTOLocalizedReference]falseA list of writers.
program_uuidstringtrue[REQUIRED] The Program uuid.
audio_typestringfalseThe value of the movie audio type: 'Stereo', 'Mono', etc.
trailer_infosArray[DTOTrailerInfo]falseThe trailers information.
offer_windowsArray[DTOOfferWindow]falseA list of windows offers.
epg_dateDatefalseThe value of the movie EPG date.
release_dateDatefalseThe release date of production of the programme.
durationstringfalseThe duration of the movie.
provider_refDTOLocalizedReferencefalseThe provider of the movie.
metadatasArray[DTOProgramMetadata]falseA list of program metadata.
availability_windowsArray[DTOAvailabilityWindow]falseA list of availability windows.
uuidstringfalse

Type ProgramOrCollectionForClassificationDTO

JSON object description

nametyperequireddescription
generation_typestringfalseThe association's generation type
classification_uuidstringfalseThe Classification Node's Classification Bundle uuid
has_associationsbooleanfalseIf the Show Collection Bundle have child Bundle (Logical Video attached to it)
catalog_uuidstringtrue[REQUIRED] UUID of Catalog to which Program/Collection belongs
order_numberintfalseThe association's order number
asset_format_refDTOReferencefalseA DTOReference object representing the Program's format
is_physical_asset_availablebooleanfalseif there is an associated PhysicalAssetVideo in the Logical Video Bundle
asset_uuidstringfalseThe Program/Collection Bundle's uuid
classification_node_uuidsArray[string]true[REQUIRED] Classification node's uuids
titlestringfalseLocalized Program/Collection name
localestringfalseLocale. Default value is system locale will be taken
end_dateDatetrue[REQUIRED] The end date of the visibility window
association_uuidstringfalseThe Classification Bundle's bundleItem that associates to a Logical Video Bundle or Collection Bundle
asset_typestringfalseThe type of the associated bundle
start_dateDatetrue[REQUIRED] The start date of the visibility window
asset_subtypestringfalseThe discriminator of the SHOW_COLLECTION bundle
uuidstringfalse
visibility_windowsArray[DTODateRange]falseOffer Windows of the Program/Collection, the Association Window and the Classification Node Schedule. It can end up with a list of start/end dates that can be greater than the total number of classification node for that classification

Type ProgramOrCollectionForCollectionDTO

JSON object description

nametyperequireddescription
generation_typestringfalseThe association's generation type
has_associationsbooleanfalseIf the Show Collection Bundle have child Bundle (Logical Video attached to it)
catalog_uuidstringtrue[REQUIRED] UUID of Catalog to which Program/Collection belongs
order_numberintfalseThe association's order number
asset_format_refDTOReferencefalseA DTOReference object representing the Program's format
is_physical_asset_availablebooleanfalseif there is an associated PhysicalAssetVideo in the Logical Video Bundle
asset_uuidstringfalseThe Program/Collection Bundle's uuid
titlestringfalseLocalized Program/Collection name
localestringfalseLocale. Default value is system locale will be taken
end_dateDatetrueThe end date of the visibility window
association_uuidstringfalseThe Classification Bundle's bundleItem that associates to a Logical Video Bundle or Collection Bundle
asset_typestringfalseThe type of the associated bundle
start_dateDatetrueThe start date of the visibility window
collection_uuidstringtrueThe Collection Bundle's uuid
asset_subtypestringfalseThe discriminator of the SHOW_COLLECTION bundle
uuidstringfalse
visibility_windowsArray[DTODateRange]falseOffer Windows of the Program/Collection, the Association Window and the Classification Node Schedule. It can end up with a list of start/end dates that can be greater than the total number of classification node for that classification

Type RestApiParameterHolder

JSON object description

nametyperequireddescription
loginedUserstringfalse
pathParamsMap[APINode,string]false
sortAPISortfalse
parentUuidstringfalse
currentUuidstringfalse
paginationAPIPaginationfalse
currentNodeAPINodefalse
searchAPISearchfalse

Type RetentionPolicyDTO

JSON object description

nametyperequireddescription
delete_date_typePolicyRuleDeleteDateTypefalseEnum with policy Rule value: LICENSE_WINDOW_START(Default value), LICENSE_WINDOW_END, BUNDLE_ACTIVATE_START, INACTIVE_BUNDLE_CREATE
is_activebooleanfalseShows if RetentionPolicy is active. Default value for POST operations: false
last_modifiedDatefalse[READ_ONLY] The last modified date of RetentionPolicy
associated_provider_refsSetfalseThe Set of references to associated Providers. Applies to all Providers if blank. See DTOReference
descriptionstringfalseThe description of RetentionPolicy
namestringfalse[REQUIRED] The name of the RetentionPolicy
is_delete_physical_assest_onlybooleanfalseShows if RetentionPolicy should delete physical assest only
days_towaitintfalseShows the number of days for RetentionPolicy to make the action. Default value for POST operations: 0
create_dateDatefalse[READ_ONLY] The creation date of RetentionPolicy
uuidstringfalse[READ_ONLY] The uuid of the RetentionPolicy

Type SaveClassificationDTO

JSON object description

nametyperequireddescription
actionstringtrue[REQUIRED]
classification_start_dateDatetrue[REQUIRED_for_CREATE,UPDATE] Start date of classification attribute
classification_uuidstringtrue[REQUIRED] The current Bundle uuid representing the classification
is_adult_ratingbooleanfalse[REQUIRED_for_CREATE,UPDATE] Shows value of ClassificationAttribute.isAdultRating
image_infosArray[DTOImageInfoSave]falseA list of images of the Classification Bundle, they all Physical Asset Images under the Images folder
asset_associationsArray[DTOAssociationSave]falseA list of objects representing program/collection associations for the classification node
classification_custom_attributesArray[DTOClassificationCustomAttributeSave]falseList of DTOClassificationCustomAttribute with action field
classification_nodesArray[DTOClassificationNodeDetailsSave]falseThe list of Classification Nodes to Create/Update/Delete
classification_idstringfalseThe current Bundle ciid
usage_typestringfalse[REQUIRED_for_CREATE,UPDATE] Enumerated value
classification_type_refDTOReferencefalseReference to ClassificationAttribute.classificationType
classification_end_dateDatetrue[REQUIRED_for_CREATE,UPDATE] End date of classification attribute
metadatasArray[DTOMetadataClassificationSave]falseA list of Metadata associated with the Classification Bundle. i.e. Classification Node's Classification that we want to Create/Update or Delete

Type SaveCollectionDTO

JSON object description

nametyperequireddescription
actionstringtrue[REQUIRED]
classification_associationsArray[DTOAssociationSave]falseList of Associations Collection to Classification
image_infosArray[DTOImageInfoSave]falseA list of Physical Asset Images for the Collection
asset_associationsArray[DTOAssociationSave]falseList of Associations child Collection/Program to Collection
licensing_windowsArray[DTOLicensingWindowSave]falseA list of Licensing Windows for the Collection
offer_windowsArray[DTOOfferWindowSave]false[REQUIRED_for_CREATE] A list of Offer Windows for the Collection
metadatasArray[DTOAssetMetadataSave]true[REQUIRED_for_CREATE] A list of Metadatas for the Collection
provider_refDTOReferencetrue[REQUIRED_for_CREATE,UPDATE] Reference to provider
availability_windowsArray[DTOAvailabilityWindowSave]falseA list of Availability Windows for the Collection
collection_type_refDTOReferencetrue[REQUIRED_for_CREATE][READ_ONLY_AFTER_CREATION] Reference to the Bundle template representing the Collection type
collection_uuidstringtrue[REQUIRED] The current Bundle uuid representing the Collection

Type SaveProgramDTO

JSON object description

nametyperequireddescription
actionstringtrue[REQUIRED]
classification_associationsArray[DTOAssociationSave]falseA list of objects representing classification associations
program_uuidstringtrue[REQUIRED] The current Bundle uuid representing the program

Type SearchConfigDataDTO

JSON object description

nametyperequireddescription
indexed_datastringfalseThe String representation of the additional search config data, if it needs to be indexed
is_defaultbooleanfalseThis is for specifying weather the search configuration is the default
last_modified_dateDatefalse[READ_ONLY] The last modified date of the SearchConfigData
typestringtrue[REQUIRED][READ_ONLY_AFTER_CREATION] The type of the SearchConfigData
datastringfalseThe String representation of the search config data
userstringtrue[REQUIRED][READ_ONLY_AFTER_CREATION] The user that the SearchConfigData belongs to
create_dateDatefalse[READ_ONLY] The create date of the SearchConfigData
uuidstringfalse[READ_ONLY] The UUID of the SearchConfigData

Type SimpleSearchDTO

JSON object description

nametyperequireddescription
producerSetfalseThe names of the producers
directorSetfalseThe names of the directors
actorSetfalseThe names of the actors
typestringfalseThe name of the Bundle classification type
sort_fieldDTOSortFieldfalseThe sort field object that defines sorting for search result
ratingSetfalseThe ratings of the Bundle
search_termstringfalseThe term for the search
collectionSetfalseThe collections that current Bundle is associated with
namestringfalseThe name of the Bundle
usage_typeSetfalseThe usage type of the Bundle
typesSetfalse[REQUIRED] The Bundle classification type list
providerstringfalseThe name of the provider
classificationSetfalseThe classifications that the current Bundle is associated with
localestringfalseThe locale of the localized metadata or common entity to search by
exclude_uuidsSetfalseThe list of uuids that should be excluded from result
end_dateDatefalseThe end date filter
studio_codestringfalseThe studio codes of the Bundle
formatSetfalseThe formats of the Bundle
start_dateDatefalseThe start date filter
catalogSetfalseThe catalogs that the current Bundle is associated with
genreSetfalseThe genres of the Bundle
uuidstringfalseThe UUID of the Bundle

Type Sorting

JSON object description

nametyperequireddescription
field_namestringfalse[REQUIRED] The name of the field to sort by
ascendingbooleanfalse[REQUIRED] The order of sorting

Type SpreadsheetIngestionDTO

JSON object description

nametyperequireddescription
encoded_datastringfalse[REQUIRED] The uploaded file data encoded to String object using Base64 encode scheme
filenamestringfalse[REQUIRED] The name of the uploaded file with extension. Only XLS and XLSX File Types are supported
uuidstringfalse
destinationstringfalse[REQUIRED] The destination for the uploaded file. Should consist of Repository Node name + relative path to the destination folder

Type StaticAttributeListDTO

JSON object description

nametyperequireddescription
static_attribute_typestringfalseThe type of the static attribute
static_attribute_listSetfalseThe list of static attributes
uuidstringfalse

Type SubscriptionCodeDTO

JSON object description

nametyperequireddescription
bundlesSetfalse[READ_ONLY] The references to Bundles
descriptionstringfalseThe description of the Subscription Code
codestringfalse[REQUIRED]The Subscription Code. Number must be unique
namestringtrue[REQUIRED]The name of the SubscriptionCode
uuidstringfalse[READ_ONLY] The UUID of the SubscriptionCode

Type UrlSignerConfigurationDTO

JSON object description

nametyperequireddescription
is_activebooleanfalse[READ_ONLY] Shows if URL Signer Configuration is active. Default value is FALSE
url_signer_settingsUrlSignerSettingsDTOfalse[REQUIRED] The URL Signer Settings for composing XML settings of the URL Signer Configuration
url_signer_refDTOReferencefalse[REQUIRED] The reference to the URL Signer of the URL Signer Configuration
last_modifiedDatefalse[READ_ONLY] The last modified date of the URL Signer Configuration
is_enabledbooleanfalseShows if URL Signer Configuration is enabled. Default value is TRUE
namestringfalse[REQUIRED] The name of the URL Signer Configuration
uuidstringfalse[READ_ONLY] The UUID of the URL Signer Configuration

Type UrlSignerDTO

JSON object description

nametyperequireddescription
descriptionstringfalse[READ_ONLY] The description of the URL Signer
namestringfalse[READ_ONLY] The name of the URL Signer
uuidstringfalse[READ_ONLY] The UUID of the URL Signer

Type UrlSignerSettingsDTO

JSON object description

nametyperequireddescription
keystringfalseThe Key of the URL Signer Settings
include_client_ipbooleanfalseShows if Client IP is included for the URL Signer Settings
key_id_ownerintfalse[REQUIRED] The Key ID Owner of the URL Signer Settings. Allowed range from 1 to 32
key_id_numberintfalse[REQUIRED] The Key ID Number of the URL Signer Settings. Allowed range from 1 to 16
expiry_delay_secondsintfalseThe Expiry Delay Seconds of the URL Signer Settings
private_keystringfalse[REQUIRED if 'url_signer_ref' references 'CDS Public Key'] The Private Key of the URL Signer Settings

Type ViewAssetADIDTO

JSON object description

nametyperequireddescription
component_uuidstringfalse[READ_ONLY] The UUID of the Asset
source_xmlstringfalse[READ_ONLY] The source XML (the ADI that is used to create the Asset)

Type XlsParserConfigDTO

JSON object description

nametyperequireddescription
is_activebooleanfalse[REQUIRED] Shows if XLS Parser Configuration is active
last_modified_dateDatefalse[READ_ONLY] The last modified date of XLS Parser Configuration
default_locale_refDTOReferencefalse[REQUIRED] The reference to Default Locale of the XLS Parser Configuration
namestringtrue[REQUIRED] The name of XLS Parser Configuration. Should be unique
xml_configurationstringfalseThe specific XML Configuration for XLS Parser
bundle_type_refDTOReferencetrue[REQUIRED] The reference to BundleTemplate
uuidstringfalse[READ_ONLY] The uuid of the XLS Parser Configuration