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:
- /api/cms/v1/classification/association
- /api/cms/v1/bind/profile/{uuid}/activation
- /api/cms/v1/classification/collection/association
- /api/cms/v1/bind/profile/{uuid}/updaterules
- /api/cms/v1/classification/dataforassociation
- /api/cms/v1/bundle/template/{uuid}
- /api/cms/v1/bundle/template/
- /api/entitlement/v1/bundle/template/{uuid}
- /api/cms/v1/bundle/template
- /api/cms/v1/audit/{uuid}/details/
- /api/cms/v1/classification/delete
- /api/cms/v1/audit/{uuid}/history/
- /api/cms/v1/customattributetype/{uuid}
- /api/cms/v1/customattributetype
- /api/cms/v1/audit/{uuid}
- /api/cms/v1/audit
- /api/cms/v1/content/component/{uuid}
- /api/cms/v1/content/component
- /api/cms/v1/content/bundlesearch
- /api/cms/v1/content/bundle/{bundleUuid}/bundleitem/{uuid}
- /api/cms/v1/content/bundle/bundleitem
- /api/cms/v1/content/bundle/bundleitem/{uuid}
- /api/cms/v1/content/bundle/{bundleUuid}/bundleitem
- /api/cms/v1/bundle/template/{uuid}/publishing
- /api/cms/v1/classification/detail
- /api/cms/v1/bind/profile/{profileuuid}/componentassociation/{uuid}
- /api/cms/v1/bind/profile/{profileuuid}/componentassociation
- /api/cms/v1/bind/profile/componentassociation/{uuid}
- /api/cms/v1/catalog/hierarchy/{uuid}
- /api/cms/v1/catalog/hierarchy/
- /api/cms/v1/type/component/{uuid}
- /api/cms/v1/type/component
- /api/cms/v1/content/bundle/warning/{uuid}
- /api/cms/v1/content/bundle/{bundleUuid}/warning/{uuid}
- /api/cms/v1/content/bundle/{bundleUuid}/warning
- /api/cms/v1/classification/dataforclassificationassociation
- /api/cms/v1/retentionpolicy/{uuid}
- /api/cms/v1/retentionpolicy
- /api/cms/v1/classification/simplesearch
- /api/cms/v1/content/commonentitysearch
- /api/cms/v1/classification/citreepublish/
- /api/cms/v1/conversation/{uuid}
- /api/cms/v1/conversation
- /api/cms/v1/bind/profileplugin/{uuid}
- /api/cms/v1/bind/profileplugin
- /api/cms/v1/bind/profile/{uuid}/componentcreatesassociation
- /api/entitlement/v1/productresolutionplugin/{uuid}
- /api/entitlement/v1/productresolutionplugin
- /api/pt/v1/charconversion/{uuid}
- /api/pt/v1/charconversion
- /api/cms/v1/content/bundlecleanup
- /api/cms/v1/classification/program/save/
- /api/cms/v1/originmapping/{uuid}
- /api/cms/v1/originmapping
- /api/cms/v1/conversation/{conversationUuid}/details/{uuid}
- /api/cms/v1/conversation/details
- /api/cms/v1/conversation/details/{uuid}
- /api/cms/v1/conversation/{conversationUuid}/details
- /api/cms/v1/type/folder/{uuid}
- /api/cms/v1/type/folder
- /api/cms/v1/classification/staticattributes/{staticAttributeDiscriminator}
- /api/cms/v1/classification/staticattributes
- /api/cms/v1/content/componentcleanup
- /api/entitlement/v1/currency/{uuid}
- /api/entitlement/v1/currency
- /api/cms/v1/bind/profile/{profileuuid}/childbundleassociation/{uuid}
- /api/cms/v1/bind/profile/{profileuuid}/childbundleassociation
- /api/cms/v1/bind/profile/childbundleassociation/{uuid}
- /api/pt/v1/spreadsheetingestion
- /api/cms/v1/conversation/{uuid}/retry
- /api/cms/v1/advancedsearch/entityfieldinfo/{uuid}
- /api/cms/v1/advancedsearch/entityfieldinfo
- /api/entitlement/v1/notifications/entitychange/queue/available_plugins
- /api/cms/v1/content/commonentity/{uuid}
- /api/cms/v1/content/commonentity
- /api/pt/v1/imageprofile/availableformats
- /api/cms/v1/advancedsearch/performsearch
- /api/pt/v1/metadatasourceplugin/{uuid}
- /api/pt/v1/metadatasourceplugin
- /api/pt/v1/metadatasourceplugin/{uuid}/activation
- /api/cms/v1/content/commonentity/category/{uuid}
- /api/cms/v1/content/commonentity/category/
- /api/entitlement/v1/notificationplugin/{uuid}
- /api/entitlement/v1/notificationplugin
- /api/cms/v1/bundle/urlsignerconfig/{uuid}
- /api/cms/v1/bundle/urlsignerconfig
- /api/cms/v1/content/bundle/{uuid}/productize
- /api/cms/v1/justintimepolicy/{uuid}
- /api/cms/v1/justintimepolicy
- /api/entitlement/v1/entitychangeplugin/{uuid}/availableclasses
- /api/cms/v1/feedtype/{uuid}
- /api/cms/v1/feedtype
- /api/pt/v1/metadatasourceplugin/availablefields
- /api/cms/v1/bundlexslt/{uuid}
- /api/cms/v1/bundlexslt
- /api/cms/v1/content/bundlexslt/{uuid}
- /api/cms/v1/classification/dataforcreateclassification
- /api/pt/v1/imageprofile/{uuid}
- /api/pt/v1/imageprofile
- /api/cms/v1/feedtype/{uuid}/activation
- /api/cms/v1/classification/cipublishinstance/{uuid}
- /api/cms/v1/classification/cipublishinstance/
- /api/cms/v1/bundle/urlsignerconfig/{uuid}/activation
- /api/entitlement/v1/entities
- /api/cms/v1/content/commonentity/type/{uuid}
- /api/cms/v1/content/commonentity/type
- /api/cms/v1/content/bundle/{uuid}/activation
- /api/cms/v1/classification/collection/staticattributes/{staticAttributeDiscriminator}
- /api/cms/v1/classification/collection/staticattributes
- /api/cms/v1/bundle/template/typeitem/{uuid}
- /api/cms/v1/bundle/template/typeitem/
- /api/entitlement/v1/notifications/notification/queue/available_plugins
- /api/cms/v1/content/assetadi/{uuid}
- /api/cms/v1/advancedsearch/searchconfigdata/{uuid}
- /api/cms/v1/advancedsearch/searchconfigdata
- /api/cms/v1/classification/collection/save/
- /api/cms/v1/bind/profile/{profileuuid}/chainingrules
- /api/cms/v1/classification/collection/details
- /api/cms/v1/bundle/template/{uuid}/fulltree
- /api/cms/v1/classification/hierarchy/
- /api/cms/v1/bundle/template/{uuid}/copyandedit
- /api/entitlement/v1/entitychangeplugin/{uuid}/activation
- /api/entitlement/v1/productization/policy/{uuid}
- /api/entitlement/v1/productization/policy
- /api/cms/v1/bind/request/queue/available_plugins
- /api/cms/v1/content/componentsearch
- /api/cms/v1/conversation/type/{uuid}
- /api/cms/v1/conversation/type
- /api/pt/v1/xlsparserconfig/{uuid}
- /api/pt/v1/xlsparserconfig
- /api/entitlement/v1/subscription/{uuid}
- /api/entitlement/v1/subscription
- /api/cms/v1/feed/{uuid}
- /api/cms/v1/feed
- /api/pt/v1/imagerepositorynodeconfig/{uuid}
- /api/pt/v1/imagerepositorynodeconfig
- /api/pt/v1/metadatasourceplugin/{uuid}/availableclasses
- /api/cms/v1/locale/{uuid}
- /api/cms/v1/locale
- /api/cms/v1/classification/program/details
- /api/cms/v1/bind/profile/{uuid}
- /api/cms/v1/bind/profile
- /api/cms/v1/classification/findbyid
- /api/cms/v1/content/bundle/bundleitem/{itemUuid}/childrenlist
- /api/cms/v1/content/bundle/{bundleUuid}/bundleitem/{itemUuid}/childrenlist
- /api/cms/v1/bundle/template/{uuid}/activation
- /api/cms/v1/customattributetype/{uuid}/publishing
- /api/cms/v1/customattributetype/publishing
- /api/cms/v1/content/bundle/{uuid}
- /api/cms/v1/content/bundle
- /api/cms/v1/classification/entity/summary
- /api/cms/v1/bind/profile/{uuid}/bundleassociation
- /api/cms/v1/audit/{uuid1}/compare/{uuid2}
- /api/cms/v1/advancedsearch/filterdata/{type}
- /api/cms/v1/advancedsearch/filterdata
- /api/entitlement/v1/entitychangeplugin/{uuid}
- /api/entitlement/v1/entitychangeplugin/
- /api/entitlement/v1/entitychangeplugin
- /api/cms/v1/classification/save/
- /api/cms/v1/bundle/urlsigner/{uuid}
- /api/cms/v1/bundle/urlsigner
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
- APINode
- APIPagination
- APIReference
- APIResource
- APISearch
- APISort
- ActivationDTO
- AuditTrailAdditionalInfo
- AuditTrailCompareDTO
- AuditTrailDTO
- AuditTrailDetailsDTO
- AuditTrailDetailsInfo
- AvailableEntityChangePluginClassDTO
- AvailableFieldsForMappingDTO
- AvailableMetadataSourcePluginClassDTO
- BindProfileBundleAssociationDTO
- BindProfileChainingDTO
- BindProfileChildBundleAssociationDTO
- BindProfileComponentAssociationDTO
- BindProfileComponentCreateAssociationDTO
- BindProfileDTO
- BindProfilePluginDTO
- BindProfileUpdateRuleDTO
- BundleCleanupDTO
- BundleDTO
- BundleFolderTypeDTO
- BundleItemDTO
- BundleMetadataSearchDTO
- BundleProductizeDTO
- BundleSearchDTO
- BundleTemplateDTO
- BundleTemplateFullTreeDTO
- BundleTemplatePublishDTO
- BundleTypeItemDTO
- BundleWarningDTO
- BundleXsltDTO
- CIPublishInstanceDTO
- CITreePublishDTO
- CatalogDTO
- CategoryDTO
- CharConversionMappingDTO
- ClassificationDetailsDTO
- ClassificationNodeDTO
- ClassificationSummaryDTO
- CollectionDetailsDTO
- CommonEntityDTO
- CommonEntityExtraInfoDTO
- CommonEntitySearchDTO
- CommonEntityTypeDTO
- CommonListStringDTO
- CommonRuleDTO
- ComponentCleanupDTO
- ComponentDTO
- ComponentSearchDTO
- ComponentTypeDTO
- ConversationDTO
- ConversationDetailsDTO
- ConversationRetryDTO
- ConversationTypeDTO
- CurrencyDTO
- CustomAttributeTypeDTO
- CustomAttributeTypePublishingDTO
- DTOAssetAssociation
- DTOAssetMetadata
- DTOAssetMetadataSave
- DTOAssociationMetadata
- DTOAssociationSave
- DTOAvailabilityWindow
- DTOAvailabilityWindowSave
- DTOClassificationAssociation
- DTOClassificationCustomAttribute
- DTOClassificationCustomAttributeSave
- DTOClassificationNodeDetails
- DTOClassificationNodeDetailsSave
- DTOClassificationNodeDetailsWithSiblings
- DTOClassificationNodeWithChildren
- DTOClassificationPath
- DTOCollectionAssociation
- DTODateRange
- DTOImageInfo
- DTOImageInfoSave
- DTOLicensingWindow
- DTOLicensingWindowSave
- DTOLocalizedReference
- DTOMetadata
- DTOMetadataClassification
- DTOMetadataClassificationNode
- DTOMetadataClassificationSave
- DTOOfferWindow
- DTOOfferWindowSave
- DTOProgramMetadata
- DTOReference
- DTOResourceBundle
- DTOResourceLabel
- DTOSortField
- DTOTrailerInfo
- DataForAssociationDTO
- DataForClassificationAssociationDTO
- DataForClassificationDTO
- DeleteClassificationDTO
- EntityChangePluginDTO
- EntityDTO
- EntityFieldInfoDTO
- FeedDTO
- FeedTypeDTO
- FilterDataDTO
- FolderTypeCdnMappingDTO
- ImageProfileAvailableFormatDTO
- ImageProfileDTO
- JustInTimePolicyDTO
- LocaleDTO
- MetadataSourcePluginDTO
- NotificationPluginDTO
- OriginMappingDTO
- Pagination
- PerformSearchDTO
- PolicyDTO
- ProductResolutionPluginDTO
- ProgramDetailsDTO
- ProgramOrCollectionForClassificationDTO
- ProgramOrCollectionForCollectionDTO
- RestApiParameterHolder
- RetentionPolicyDTO
- SaveClassificationDTO
- SaveCollectionDTO
- SaveProgramDTO
- SearchConfigDataDTO
- SimpleSearchDTO
- Sorting
- SpreadsheetIngestionDTO
- StaticAttributeListDTO
- SubscriptionCodeDTO
- UrlSignerConfigurationDTO
- UrlSignerDTO
- UrlSignerSettingsDTO
- ViewAssetADIDTO
- XlsParserConfigDTO
/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 |
---|---|---|---|
pagination | Pagination | query |
Input Payload
element | consumeable content type(s) |
---|---|
ProgramOrCollectionForClassificationDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
ProgramOrCollectionForClassificationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
500 | Request is formed correctly, but server cannot create entity. 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:
GET
This method is used to get a specific instance of the DTO by given UUID.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
ActivationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
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 |
---|---|---|---|
uuid | The uuid of the Action profile. | path |
Input Payload
element | consumeable content type(s) |
---|---|
ActivationDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
ActivationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or entity didn't pass field validation. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body. |
500 | Request 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 |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT. deactivation was successful |
404 | NOT FOUND. Entity with provided UUID was not found. |
/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 |
---|---|---|---|
pagination | Pagination | query |
Input Payload
element | consumeable content type(s) |
---|---|
ProgramOrCollectionForCollectionDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
ProgramOrCollectionForCollectionDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/api/cms/v1/bind/profile/{uuid}/updaterules
- Mount point: /api/cms/v1/bind/profile/{uuid}/updaterules
The following operations are supported on this resource:
GET
This method is used to get a BindProfileUpdate rules.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the BindProfile. | path |
Output Payload
element | produceable content type(s) |
---|---|
BindProfileUpdateRuleDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | BindProfile NOT FOUND |
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 |
---|---|---|---|
uuid | The uuid of BindProfile. | path |
Input Payload
element | consumeable content type(s) |
---|---|
BindProfileUpdateRuleDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
BindProfileUpdateRuleDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | BindProfile with passed UUID is not found in DB. |
405 | Request path has no BindProfile UUID or Request body has UUID of rule. |
500 | Request is formed correctly, but server cannot perform entity update. Unexpected 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) |
---|---|
DataForAssociationDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
DataForAssociationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Not Found |
500 | Request 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:
GET
This method is used to get a Bundle Template by given UUID.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
BundleTemplateDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
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 |
---|---|---|---|
uuid | The uuid of BundleTemplate. | path |
Input Payload
element | consumeable content type(s) |
---|---|
BundleTemplateDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
BundleTemplateDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body. |
500 | Request is formed correctly, but server cannot perform entity update. Unexpected error. |
/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) |
---|---|
BundleTemplateDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
BundleTemplateDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is present in request path. |
500 | Request is formed correctly, but server cannot create entity. Unexpected error. |
/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 |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT |
404 | NOT 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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
BundleTemplateDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/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 |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
AuditTrailDetailsDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT 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) |
---|---|
DeleteClassificationDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
200 | OK |
400 | Bad Request |
404 | Not Found |
500 | Internal Server Error |
/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 |
---|---|---|---|
uuid | The uuid of the object. | path | |
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
AuditTrailDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/api/cms/v1/customattributetype/{uuid}
- Mount point: /api/cms/v1/customattributetype/{uuid}
The following operations are supported on this resource:
GET
This method is used to get a specific instance of the CustomAttributeType DTO by given UUID.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
CustomAttributeTypeDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
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 |
---|---|---|---|
uuid | The uuid of CustomAttributeType. | path |
Input Payload
element | consumeable content type(s) |
---|---|
CustomAttributeTypeDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
CustomAttributeTypeDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body. |
500 | Request 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 |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT. Custom Attribute Type was successfully deleted. |
404 | NOT FOUND. CustomAttributeType with provided uuid was not 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) |
---|---|
CustomAttributeTypeDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
CustomAttributeTypeDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is present in request path. |
500 | Request 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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
CustomAttributeTypeDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/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 |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
AuditTrailDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT 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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
AuditTrailDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/api/cms/v1/content/component/{uuid}
- Mount point: /api/cms/v1/content/component/{uuid}
The following operations are supported on this resource:
GET
This method is used to get a specific instance of the Component DTO by given UUID.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
ComponentDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
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 |
---|---|---|---|
uuid | The uuid of Component. | path |
Input Payload
element | consumeable content type(s) |
---|---|
ComponentDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
ComponentDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body. |
500 | Request 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 |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT |
404 | NOT FOUND |
/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) |
---|---|
ComponentDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
ComponentDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is present in request path. |
500 | Request 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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
ComponentDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/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) |
---|---|
BundleSearchDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
BundleSearchDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is present in request path. |
500 | Request is formed correctly, but server cannot create entity. Unexpected error. |
/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 |
---|---|---|---|
bundleUuid | UUID of bundle | path | |
uuid | UUID bundle item | path |
Output Payload
element | produceable content type(s) |
---|---|
BundleItemDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
/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) |
---|---|
BundleItemDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
BundleItemDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is present in request path. |
500 | Request 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 |
---|---|---|---|
uuid | UUID bundle item | path |
Input Payload
element | consumeable content type(s) |
---|---|
BundleItemDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
BundleItemDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved or BundleItem is not found |
500 | Request 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 |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT |
404 | NOT 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 |
---|---|---|---|
bundleUuid | UUID bundle | path | |
search | Search | query |
Output Payload
element | produceable content type(s) |
---|---|
BundleItemDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/api/cms/v1/bundle/template/{uuid}/publishing
- Mount point: /api/cms/v1/bundle/template/{uuid}/publishing
The following operations are supported on this resource:
GET
This method is used to get the publishing status of the bundle template
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
BundleTemplatePublishDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
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 |
---|---|---|---|
uuid | The uuid of Bundle Template | path |
Input Payload
element | consumeable content type(s) |
---|---|
BundleTemplatePublishDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
BundleTemplatePublishDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body. |
500 | Request is formed correctly, but server cannot perform entity update. Unexpected error. |
/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) |
---|---|
ClassificationDetailsDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
ClassificationDetailsDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/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:
GET
This method is used to get a ComponentAssociation rule by uuid and by BindProfile uuid.
URL Parameters
name | description | type | default |
---|---|---|---|
profileuuid | The uuid of the BindProfile. | path | |
uuid | The uuid of the ComponentAssociation. | path | |
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
BindProfileComponentAssociationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | BindProfile or ComponentAssociation NOT FOUND |
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 |
---|---|---|---|
profileuuid | The uuid of the BindProfile. | path | |
uuid | The uuid of the ComponentAssociation. | path |
Input Payload
element | consumeable content type(s) |
---|---|
BindProfileComponentAssociationDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
BindProfileComponentAssociationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body. |
500 | Request is formed correctly, but server cannot perform entity update. Unexpected error. |
/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 |
---|---|---|---|
profileuuid | The uuid of the BindProfile. | path |
Input Payload
element | consumeable content type(s) |
---|---|
BindProfileComponentAssociationDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
BindProfileComponentAssociationDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is present in request path. |
500 | Request 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 |
---|---|---|---|
profileuuid | The uuid of the BindProfile. | path |
Output Payload
element | produceable content type(s) |
---|---|
BindProfileComponentAssociationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/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 |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT |
404 | NOT FOUND |
/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 |
---|---|---|---|
uuid | The uuid of the Catalog | path |
Output Payload
element | produceable content type(s) |
---|---|
CatalogDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT 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 |
---|---|
200 | OK |
/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 |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
ComponentTypeDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT 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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
ComponentTypeDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/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 |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT |
404 | NOT 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 |
---|---|---|---|
uuid | path | ||
bundleUuid | path |
Output Payload
element | produceable content type(s) |
---|---|
BundleWarningDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT 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 |
---|---|---|---|
bundleUuid | path | ||
search | query | ||
sort | query | ||
pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
BundleWarningDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/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) |
---|---|
DataForClassificationAssociationDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
DataForClassificationAssociationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
400 | Bad Request |
404 | Not Found |
500 | Internal Server error |
/api/cms/v1/retentionpolicy/{uuid}
- Mount point: /api/cms/v1/retentionpolicy/{uuid}
The following operations are supported on this resource:
GET
This method is used to get a specific instance of the DTO by given uuid
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
RetentionPolicyDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
PUT
This method is used to perform update or partial update of RetentionPolicy.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the RetentionPolicy. | path |
Input Payload
element | consumeable content type(s) |
---|---|
RetentionPolicyDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
RetentionPolicyDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or entity didn't pass field validation. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body. |
500 | Request 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 |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT. RetentionPolicy was successfully deleted. |
404 | NOT FOUND. RetentionPolicy with provided id was not found. |
/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) |
---|---|
RetentionPolicyDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
RetentionPolicyDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is present in request path. |
500 | Request 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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
RetentionPolicyDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Input Payload
element | consumeable content type(s) |
---|---|
SimpleSearchDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
SimpleSearchDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
400 | Bad Request |
500 | Internal Server 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) |
---|---|
CommonEntitySearchDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
CommonEntitySearchDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is present in request path. |
500 | Request is formed correctly, but server cannot perform operation. Unexpected error. |
/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) |
---|---|
CITreePublishDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
CITreePublishDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
400 | Bad Request |
500 | Internal Server error |
/api/cms/v1/conversation/{uuid}
- Mount point: /api/cms/v1/conversation/{uuid}
The following operations are supported on this resource:
GET
This method is used to get a specific instance of the Conversation DTO by given UUID.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the conversation. | path |
Output Payload
element | produceable content type(s) |
---|---|
ConversationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
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 |
---|---|---|---|
uuid | The uuid of Conversation. | path |
Input Payload
element | consumeable content type(s) |
---|---|
ConversationDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
ConversationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body. |
500 | Request 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 |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT |
404 | NOT 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) |
---|---|
ConversationDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
ConversationDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is present in request path. |
500 | Request 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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
ConversationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/api/cms/v1/bind/profileplugin/{uuid}
- Mount point: /api/cms/v1/bind/profileplugin/{uuid}
The following operations are supported on this resource:
GET
This method is used to get a BindProfilePlugin by given UUID.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
BindProfilePluginDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
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 |
---|---|---|---|
uuid | The uuid of BindprofilePlugin. | path |
Input Payload
element | consumeable content type(s) |
---|---|
BindProfilePluginDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
BindProfilePluginDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body. |
500 | Request is formed correctly, but server cannot perform entity update. Unexpected error. |
/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) |
---|---|
BindProfilePluginDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
BindProfilePluginDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is present in request path. |
500 | Request 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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
BindProfilePluginDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/api/cms/v1/bind/profile/{uuid}/componentcreatesassociation
- Mount point: /api/cms/v1/bind/profile/{uuid}/componentcreatesassociation
The following operations are supported on this resource:
GET
This method is used to get a BindProfileComponentCreateAssociation rules.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the BindProfile. | path |
Output Payload
element | produceable content type(s) |
---|---|
BindProfileComponentCreateAssociationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | BindProfile NOT FOUND |
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 |
---|---|---|---|
uuid | The uuid of BindProfile. | path |
Input Payload
element | consumeable content type(s) |
---|---|
BindProfileComponentCreateAssociationDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
BindProfileComponentCreateAssociationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | BindProfile with passed UUID is not found in DB. |
405 | Request path has no BindProfile UUID or Request body has UUID of rule. |
500 | Request is formed correctly, but server cannot perform entity update. Unexpected error. |
/api/entitlement/v1/productresolutionplugin/{uuid}
- Mount point: /api/entitlement/v1/productresolutionplugin/{uuid}
The following operations are supported on this resource:
GET
This method is used to get a ProductResolutionPlugin by given UUID.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
ProductResolutionPluginDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
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 |
---|---|---|---|
uuid | The uuid of ProductResolutionPlugin. | path |
Input Payload
element | consumeable content type(s) |
---|---|
ProductResolutionPluginDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
ProductResolutionPluginDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body. |
500 | Request 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 |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT |
404 | NOT 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) |
---|---|
ProductResolutionPluginDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
ProductResolutionPluginDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is present in request path. |
500 | Request 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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
ProductResolutionPluginDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/api/pt/v1/charconversion/{uuid}
- Mount point: /api/pt/v1/charconversion/{uuid}
The following operations are supported on this resource:
GET
This method is used to get a specific Character Conversion Mapping DTO by given uuid.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
CharConversionMappingDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
PUT
This method is used to update Character Conversion Mapping.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of BundleTemplate. | path |
Input Payload
element | consumeable content type(s) |
---|---|
CharConversionMappingDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
CharConversionMappingDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID, or (Request body has UUID and it's different from UUID in path). |
500 | Request 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 |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT |
404 | NOT FOUND |
/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) |
---|---|
CharConversionMappingDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
CharConversionMappingDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is presented in request path. |
500 | Request 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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
CharConversionMappingDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
BundleCleanupDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
400 | Invalid query parameters |
/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) |
---|---|
SaveProgramDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
SaveProgramDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
400 | Bad Request |
500 | Internal Server error |
/api/cms/v1/originmapping/{uuid}
- Mount point: /api/cms/v1/originmapping/{uuid}
The following operations are supported on this resource:
GET
This method is used to get a specific instance of the OriginMapping DTO by given UUID.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
OriginMappingDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
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 |
---|---|---|---|
uuid | The uuid of OriginMapping. | path |
Input Payload
element | consumeable content type(s) |
---|---|
OriginMappingDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
OriginMappingDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body. |
500 | Request 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 |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT |
404 | NOT 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) |
---|---|
OriginMappingDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
OriginMappingDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is present in request path. |
500 | Request 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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
OriginMappingDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/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 |
---|---|---|---|
uuid | The uuid of the conversation details. | path | |
conversationUuid | The conversation uuid of the conversation. | path |
Output Payload
element | produceable content type(s) |
---|---|
ConversationDetailsDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
/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) |
---|---|
ConversationDetailsDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
ConversationDetailsDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is present in request path. |
500 | Request 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 |
---|---|---|---|
uuid | The uuid of Conversation. | path |
Input Payload
element | consumeable content type(s) |
---|---|
ConversationDetailsDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
ConversationDetailsDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body. |
500 | Request 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 |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT |
404 | NOT 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 |
---|---|---|---|
conversationUuid | The conversation uuid of the conversation. | path | |
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
ConversationDetailsDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/api/cms/v1/type/folder/{uuid}
- Mount point: /api/cms/v1/type/folder/{uuid}
The following operations are supported on this resource:
GET
This method is used to get a specific Bundle Folder Type DTO by given UUID.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
BundleFolderTypeDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
PUT
This method is used to update Bundle Folder Type.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of BundleTemplate. | path |
Input Payload
element | consumeable content type(s) |
---|---|
BundleFolderTypeDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
BundleFolderTypeDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body. |
500 | Request is formed correctly, but server cannot perform entity update. Unexpected error. |
/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) |
---|---|
BundleFolderTypeDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
BundleFolderTypeDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is present in request path. |
500 | Request 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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
BundleFolderTypeDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/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 |
---|---|---|---|
staticAttributeDiscriminator | The 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 |
---|---|
200 | OK |
404 | NOT 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 |
---|---|---|---|
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
StaticAttributeListDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
ComponentCleanupDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
400 | Invalid query parameters |
/api/entitlement/v1/currency/{uuid}
- Mount point: /api/entitlement/v1/currency/{uuid}
The following operations are supported on this resource:
GET
This method is used to get a specific instance of the DTO by given UUID.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
CurrencyDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
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 |
---|---|---|---|
uuid | The uuid of Currency. | path |
Input Payload
element | consumeable content type(s) |
---|---|
CurrencyDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
CurrencyDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body. |
500 | Request 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 |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT |
404 | NOT FOUND |
/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) |
---|---|
CurrencyDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
CurrencyDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is present in request path. |
500 | Request 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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
CurrencyDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/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:
GET
This method is used to get a ChildBundleAssociation rule by uuid and by BindProfile uuid.
URL Parameters
name | description | type | default |
---|---|---|---|
profileuuid | The uuid of the BindProfile. | path | |
uuid | The uuid of the ChildBundleAssociation. | path |
Output Payload
element | produceable content type(s) |
---|---|
BindProfileChildBundleAssociationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | BindProfile or ChildBundleAssociation NOT FOUND |
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 |
---|---|---|---|
profileuuid | The uuid of the BindProfile. | path | |
uuid | The uuid of the ChildBundleAssociation. | path |
Input Payload
element | consumeable content type(s) |
---|---|
BindProfileChildBundleAssociationDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
BindProfileChildBundleAssociationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body. |
500 | Request is formed correctly, but server cannot perform entity update. Unexpected error. |
/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 |
---|---|---|---|
profileuuid | The uuid of the BindProfile. | path |
Input Payload
element | consumeable content type(s) |
---|---|
BindProfileChildBundleAssociationDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
BindProfileChildBundleAssociationDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is present in request path. |
500 | Request 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 |
---|---|---|---|
profileuuid | The uuid of the BindProfile. | path | |
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
BindProfileChildBundleAssociationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/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 |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT |
404 | NOT 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) |
---|---|
SpreadsheetIngestionDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
SpreadsheetIngestionDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is present in request path. |
500 | Request is formed correctly, but server cannot create entity. Unexpected 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 |
---|---|---|---|
uuid | The uuid of Conversation. | path |
Input Payload
element | consumeable content type(s) |
---|---|
ConversationRetryDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
ConversationRetryDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body. |
500 | Request is formed correctly, but server cannot perform entity update. 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 |
---|---|---|---|
uuid | The uuid of the EntityFieldInfo. | path |
Output Payload
element | produceable content type(s) |
---|---|
EntityFieldInfoDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT 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 |
---|---|---|---|
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
EntityFieldInfoDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/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 |
---|---|
200 | OK |
/api/cms/v1/content/commonentity/{uuid}
- Mount point: /api/cms/v1/content/commonentity/{uuid}
The following operations are supported on this resource:
GET
This method is used to get a specific instance of the CommonEntity DTO by given UUID.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
CommonEntityDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
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 |
---|---|---|---|
uuid | The uuid of CommonEntity. | path |
Input Payload
element | consumeable content type(s) |
---|---|
CommonEntityDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
CommonEntityDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body. |
500 | Request 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 |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT. Common Entity was successfully deleted. |
404 | NOT FOUND. CommonEntity with provided uuid was not found. |
/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) |
---|---|
CommonEntityDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
CommonEntityDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is present in request path. |
500 | Request 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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
CommonEntityDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
ImageProfileAvailableFormatDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Input Payload
element | consumeable content type(s) |
---|---|
PerformSearchDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
PerformSearchDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
400 | Bad Request |
500 | Internal Server error |
/api/pt/v1/metadatasourceplugin/{uuid}
- Mount point: /api/pt/v1/metadatasourceplugin/{uuid}
The following operations are supported on this resource:
GET
This method is used to get a specific MetadataSourcePlugin by given UUID.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the plugin. | path |
Output Payload
element | produceable content type(s) |
---|---|
MetadataSourcePluginDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
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 |
---|---|---|---|
uuid | The uuid of MetadataSourcePlugin. | path |
Input Payload
element | consumeable content type(s) |
---|---|
MetadataSourcePluginDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
MetadataSourcePluginDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body. |
500 | Request 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 |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT |
404 | NOT FOUND |
/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) |
---|---|
MetadataSourcePluginDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
MetadataSourcePluginDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is present in request path. |
500 | Request 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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
MetadataSourcePluginDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/api/pt/v1/metadatasourceplugin/{uuid}/activation
- Mount point: /api/pt/v1/metadatasourceplugin/{uuid}/activation
The following operations are supported on this resource:
GET
This method is used to get a activation status of MetadataSourcePlugin by given UUID.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the plugin. | path |
Output Payload
element | produceable content type(s) |
---|---|
ActivationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
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 |
---|---|---|---|
uuid | The uuid of MetadataSourcePlugin. | path |
Output Payload
element | produceable content type(s) |
---|---|
ActivationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body. |
500 | Request 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 |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT |
404 | NOT FOUND |
/api/cms/v1/content/commonentity/category/{uuid}
- Mount point: /api/cms/v1/content/commonentity/category/{uuid}
The following operations are supported on this resource:
GET
This method is used to get a specific instance of the DTO given the uuid
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
CategoryDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
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 |
---|---|---|---|
uuid | The uuid of the Category. | path |
Input Payload
element | consumeable content type(s) |
---|---|
CategoryDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
CategoryDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | error in JSON request, or entity didn't pass field validation |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body. |
500 | Request 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 |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT. Category was successfully deleted. |
404 | NOT FOUND. Category with provided id was not 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) |
---|---|
CategoryDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
CategoryDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is present in request path. |
500 | Request 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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
CategoryDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/api/entitlement/v1/notificationplugin/{uuid}
- Mount point: /api/entitlement/v1/notificationplugin/{uuid}
The following operations are supported on this resource:
GET
This method is used to get a NotificationPlugin by given UUID.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
NotificationPluginDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
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 |
---|---|---|---|
uuid | The uuid of NotificationPlugin. | path |
Input Payload
element | consumeable content type(s) |
---|---|
NotificationPluginDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
NotificationPluginDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body. |
500 | Request 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 |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT |
404 | NOT FOUND |
/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) |
---|---|
NotificationPluginDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
NotificationPluginDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is present in request path. |
500 | Request 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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
NotificationPluginDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/api/cms/v1/bundle/urlsignerconfig/{uuid}
- Mount point: /api/cms/v1/bundle/urlsignerconfig/{uuid}
The following operations are supported on this resource:
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 |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
UrlSignerConfigurationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
PUT
This method is used to update URL Signer Configuration.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the object. | path |
Input Payload
element | consumeable content type(s) |
---|---|
UrlSignerConfigurationDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
UrlSignerConfigurationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID, or (Request body has UUID and it's different from UUID in path). |
500 | Request 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 |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT |
404 | NOT 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) |
---|---|
UrlSignerConfigurationDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
UrlSignerConfigurationDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is presented in request path. |
500 | Request 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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
UrlSignerConfigurationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/api/cms/v1/content/bundle/{uuid}/productize
- Mount point: /api/cms/v1/content/bundle/{uuid}/productize
The following operations are supported on this resource:
GET
This method is used to get list of created products with Bundle by given UUID.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
BundleProductizeDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
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 |
---|---|---|---|
uuid | The uuid of Bundle. | path |
Input Payload
element | consumeable content type(s) |
---|---|
BundleProductizeDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
BundleProductizeDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body. |
500 | Request is formed correctly, but server cannot perform entity update. Unexpected error. |
/api/cms/v1/justintimepolicy/{uuid}
- Mount point: /api/cms/v1/justintimepolicy/{uuid}
The following operations are supported on this resource:
GET
This method is used to get a specific instance of the DTO by given uuid
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
JustInTimePolicyDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
PUT
This method is used to update JustInTimePolicy.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the JustInTimePolicy. | path |
Input Payload
element | consumeable content type(s) |
---|---|
JustInTimePolicyDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
JustInTimePolicyDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or entity didn't pass field validation. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body. |
500 | Request 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 |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT. JustInTimePolicy was successfully deleted. |
404 | NOT FOUND. JustInTimePolicy with provided id was not found. |
/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) |
---|---|
JustInTimePolicyDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
JustInTimePolicyDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is present in request path. |
500 | Request 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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
JustInTimePolicyDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/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 |
---|---|---|---|
uuid | The uuid of the EntityChangePlugin. | path |
Output Payload
element | produceable content type(s) |
---|---|
AvailableEntityChangePluginClassDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
/api/cms/v1/feedtype/{uuid}
- Mount point: /api/cms/v1/feedtype/{uuid}
The following operations are supported on this resource:
GET
This method is used to get a specific FeedType DTO by given UUID.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
FeedTypeDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
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 |
---|---|---|---|
uuid | The uuid of the Feed Type. | path |
Input Payload
element | consumeable content type(s) |
---|---|
FeedTypeDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
FeedTypeDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body. |
500 | Request 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 |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT |
404 | NOT 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) |
---|---|
FeedTypeDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
FeedTypeDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is present in request path. |
500 | Request 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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
FeedTypeDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/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 |
---|---|
200 | OK |
/api/cms/v1/bundlexslt/{uuid}
- Mount point: /api/cms/v1/bundlexslt/{uuid}
The following operations are supported on this resource:
GET
This method is used to get a specific instance of Bundle Xslt by given UUID.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the Bundle Xslt to return. | path |
Output Payload
element | produceable content type(s) |
---|---|
BundleXsltDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
PUT
This method is used to perform update and partial update of the Bundle Xslt.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the Bundle Xslt. | path |
Input Payload
element | consumeable content type(s) |
---|---|
BundleXsltDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
BundleXsltDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
400 | NOT FOUND |
/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) |
---|---|
BundleXsltDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
BundleXsltDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is present in request path. |
500 | Request 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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
BundleXsltDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/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 |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | No Content |
404 | NOT FOUND |
/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) |
---|---|
DataForClassificationDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
DataForClassificationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
400 | Bad Request |
404 | Not Found |
500 | Internal Server error |
/api/pt/v1/imageprofile/{uuid}
- Mount point: /api/pt/v1/imageprofile/{uuid}
The following operations are supported on this resource:
GET
This method is used to get a specific ImageProfile by given UUID.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the image profile. | path |
Output Payload
element | produceable content type(s) |
---|---|
ImageProfileDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
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 |
---|---|---|---|
uuid | The uuid of image profile. | path |
Input Payload
element | consumeable content type(s) |
---|---|
ImageProfileDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
ImageProfileDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body. |
500 | Request 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 |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT |
404 | NOT FOUND |
/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) |
---|---|
ImageProfileDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
ImageProfileDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is present in request path. |
500 | Request 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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
ImageProfileDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/api/cms/v1/feedtype/{uuid}/activation
- Mount point: /api/cms/v1/feedtype/{uuid}/activation
The following operations are supported on this resource:
GET
This method is used to get a activation status of FeedType by given UUID.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the FeedType. | path |
Output Payload
element | produceable content type(s) |
---|---|
ActivationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
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 |
---|---|---|---|
uuid | The uuid of FeedType. | path |
Input Payload
element | consumeable content type(s) |
---|---|
ActivationDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
ActivationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body. |
500 | Request 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 |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT |
404 | NOT FOUND |
/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 |
---|---|---|---|
uuid | The uuid of the Publish Instance | path |
Output Payload
element | produceable content type(s) |
---|---|
CIPublishInstanceDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT 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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
CIPublishInstanceDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/api/cms/v1/bundle/urlsignerconfig/{uuid}/activation
- Mount point: /api/cms/v1/bundle/urlsignerconfig/{uuid}/activation
The following operations are supported on this resource:
GET
This method is used to get the activation status of the URL Signer Configuration
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
ActivationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
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 |
---|---|---|---|
uuid | The uuid of the object | path |
Input Payload
element | consumeable content type(s) |
---|---|
ActivationDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
ActivationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body. |
500 | Request 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 |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT |
404 | NOT FOUND |
/api/entitlement/v1/entities
- Mount point: /api/entitlement/v1/entities
The following operations are supported on this resource:
/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 |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
CommonEntityTypeDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT 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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
CommonEntityTypeDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
500 | Internal server error |
/api/cms/v1/content/bundle/{uuid}/activation
- Mount point: /api/cms/v1/content/bundle/{uuid}/activation
The following operations are supported on this resource:
GET
This method is used to get an activation status of Bundle by given UUID.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
ActivationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
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 |
---|---|---|---|
uuid | The uuid of Bundle. | path |
Input Payload
element | consumeable content type(s) |
---|---|
ActivationDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
ActivationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body. |
500 | Request 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 |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT |
404 | NOT 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 |
---|---|---|---|
staticAttributeDiscriminator | The 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 |
---|---|
200 | OK |
400 | Request 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 |
---|---|---|---|
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
StaticAttributeListDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/api/cms/v1/bundle/template/typeitem/{uuid}
- Mount point: /api/cms/v1/bundle/template/typeitem/{uuid}
The following operations are supported on this resource:
GET
This method is used to get a BundleTypeItem by given UUID.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
BundleTypeItemDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
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 |
---|---|---|---|
uuid | The uuid of BundleTypeItem. | path |
Input Payload
element | consumeable content type(s) |
---|---|
BundleTypeItemDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
BundleTypeItemDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body. |
500 | Request 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 |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT |
404 | 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) |
---|---|
BundleTypeItemDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
BundleTypeItemDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is present in request path. |
500 | Request 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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
BundleTypeItemDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/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 |
---|---|
200 | OK |
/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 |
---|---|---|---|
uuid | The uuid of the Asset. | path |
Output Payload
element | produceable content type(s) |
---|---|
ViewAssetADIDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
/api/cms/v1/advancedsearch/searchconfigdata/{uuid}
- Mount point: /api/cms/v1/advancedsearch/searchconfigdata/{uuid}
The following operations are supported on this resource:
GET
This method is used to get a specific instance of the SearchConfigData DTO by given UUID.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the SearchConfigData. | path |
Output Payload
element | produceable content type(s) |
---|---|
SearchConfigDataDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
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 |
---|---|---|---|
uuid | The uuid of SearchConfigData. | path |
Input Payload
element | consumeable content type(s) |
---|---|
SearchConfigDataDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
SearchConfigDataDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body. |
500 | Request 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 |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT |
404 | NOT FOUND |
/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) |
---|---|
SearchConfigDataDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
SearchConfigDataDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is present in request path. |
500 | Request 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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
SearchConfigDataDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/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) |
---|---|
SaveCollectionDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
SaveCollectionDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
400 | Bad Request |
500 | Internal 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:
GET
This method is used to get all chaining rules for BindProfile by BindProfile uuid.
URL Parameters
name | description | type | default |
---|---|---|---|
profileuuid | The uuid of the BindProfile. | path |
Output Payload
element | produceable content type(s) |
---|---|
BindProfileChainingDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | BindProfile NOT FOUND |
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 |
---|---|---|---|
profileuuid | The uuid of the BindProfile. | path |
Input Payload
element | consumeable content type(s) |
---|---|
BindProfileChainingDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
BindProfileChainingDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | UUID from request is not found in DB. |
500 | Request 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 |
---|---|---|---|
profileuuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT |
404 | NOT 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) |
---|---|
CollectionDetailsDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
CollectionDetailsDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Not Found |
500 | Request is formed correctly, but server cannot create entity. Unexpected error. |
/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 |
---|---|---|---|
uuid | The uuid of the Bundle Template. | path |
Output Payload
element | produceable content type(s) |
---|---|
BundleTemplateFullTreeDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
/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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Input Payload
element | consumeable content type(s) |
---|---|
ClassificationNodeDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
ClassificationNodeDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/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 |
---|---|---|---|
uuid | The uuid of the source BundleTemplate. | path |
Input Payload
element | consumeable content type(s) |
---|---|
BundleTemplateDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
BundleTemplateDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body. |
500 | Request is formed correctly, but server cannot perform entity update. Unexpected error. |
/api/entitlement/v1/entitychangeplugin/{uuid}/activation
- Mount point: /api/entitlement/v1/entitychangeplugin/{uuid}/activation
The following operations are supported on this resource:
GET
This method is used to get a activation status of EntityChangePlugin by given UUID.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the plugin. | path |
Output Payload
element | produceable content type(s) |
---|---|
ActivationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
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 |
---|---|---|---|
uuid | The uuid of plugin. | path |
Input Payload
element | consumeable content type(s) |
---|---|
ActivationDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
ActivationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body. |
500 | Request 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 |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT |
404 | NOT FOUND |
/api/entitlement/v1/productization/policy/{uuid}
- Mount point: /api/entitlement/v1/productization/policy/{uuid}
The following operations are supported on this resource:
/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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
PolicyDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/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 |
---|---|
200 | OK |
/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) |
---|---|
ComponentSearchDTO | application/json |
RestApiParameterHolder | application/json |
Output Payload
element | produceable content type(s) |
---|---|
ComponentSearchDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is present in request path. |
500 | Request is formed correctly, but server cannot perform operation. Unexpected error. |
/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 |
---|---|---|---|
uuid | The uuid of the conversation. | path |
Output Payload
element | produceable content type(s) |
---|---|
ConversationTypeDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT 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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
ConversationTypeDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/api/pt/v1/xlsparserconfig/{uuid}
- Mount point: /api/pt/v1/xlsparserconfig/{uuid}
The following operations are supported on this resource:
GET
This method is used to get a specific XLS Parser Configuration DTO by given uuid.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
XlsParserConfigDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
PUT
This method is used to update XLS Parser Configuration.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the object. | path |
Input Payload
element | consumeable content type(s) |
---|---|
XlsParserConfigDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
XlsParserConfigDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID, or (Request body has UUID and it's different from UUID in path). |
500 | Request 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 |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT |
404 | NOT 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) |
---|---|
XlsParserConfigDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
XlsParserConfigDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is presented in request path. |
500 | Request 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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
XlsParserConfigDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/api/entitlement/v1/subscription/{uuid}
- Mount point: /api/entitlement/v1/subscription/{uuid}
The following operations are supported on this resource:
GET
This method is used to get a specific instance of the Subscription Code DTO by given UUID.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
SubscriptionCodeDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
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 |
---|---|---|---|
uuid | The uuid of Subscription Code. | path |
Input Payload
element | consumeable content type(s) |
---|---|
SubscriptionCodeDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
SubscriptionCodeDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body. |
500 | Request 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 |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT |
404 | NOT 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) |
---|---|
SubscriptionCodeDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
SubscriptionCodeDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is present in request path. |
500 | Request 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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
SubscriptionCodeDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/api/cms/v1/feed/{uuid}
- Mount point: /api/cms/v1/feed/{uuid}
The following operations are supported on this resource:
GET
This method is used to get a specific Feed DTO by given UUID.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
FeedDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
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 |
---|---|---|---|
uuid | The uuid of the Feed. | path |
Input Payload
element | consumeable content type(s) |
---|---|
FeedDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
FeedDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body. |
500 | Request is formed correctly, but server cannot perform entity update. Unexpected error. |
/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) |
---|---|
FeedDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
FeedDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is present in request path. |
500 | Request 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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
FeedDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/api/pt/v1/imagerepositorynodeconfig/{uuid}
- Mount point: /api/pt/v1/imagerepositorynodeconfig/{uuid}
The following operations are supported on this resource:
GET
This method is used to get a specific Folder Type CDN Mapping DTO by given uuid.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
FolderTypeCdnMappingDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
PUT
This method is used to update Folder Type CDN Mapping.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of Folder Type CDN Mapping. | path |
Input Payload
element | consumeable content type(s) |
---|---|
FolderTypeCdnMappingDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
FolderTypeCdnMappingDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID, or (Request body has UUID and it's different from UUID in path). |
500 | Request 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 |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT |
404 | NOT 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) |
---|---|
FolderTypeCdnMappingDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
FolderTypeCdnMappingDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is presented in request path. |
500 | Request 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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
FolderTypeCdnMappingDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/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 |
---|---|---|---|
uuid | The uuid of the plugin. | path | |
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
AvailableMetadataSourcePluginClassDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/api/cms/v1/locale/{uuid}
- Mount point: /api/cms/v1/locale/{uuid}
The following operations are supported on this resource:
/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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
LocaleDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/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) |
---|---|
ProgramDetailsDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
ProgramDetailsDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
400 | Bad Request |
404 | Not Found |
500 | Internal Server error |
/api/cms/v1/bind/profile/{uuid}
- Mount point: /api/cms/v1/bind/profile/{uuid}
The following operations are supported on this resource:
GET
This method is used to get a BindProfile by given UUID.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
BindProfileDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
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 |
---|---|---|---|
uuid | The uuid of BindprofilePlugin. | path |
Input Payload
element | consumeable content type(s) |
---|---|
BindProfileDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
BindProfileDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body. |
500 | Request is formed correctly, but server cannot perform entity update. Unexpected error. |
/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) |
---|---|
BindProfileDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
BindProfileDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is present in request path. |
500 | Request 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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
BindProfileDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Input Payload
element | consumeable content type(s) |
---|---|
BundleMetadataSearchDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
BundleMetadataSearchDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
400 | Bad Request |
500 | Internal Server error |
/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 |
---|---|---|---|
itemUuid | UUID of parent bundle item | path | |
search | Search | query | |
sort | Search | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
BundleItemDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/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 |
---|---|---|---|
bundleUuid | UUID of Bundle to which item belongs | path | |
itemUuid | UUID of parent bundle item | path | |
search | Search | query | |
sort | Search | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
BundleItemDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/api/cms/v1/bundle/template/{uuid}/activation
- Mount point: /api/cms/v1/bundle/template/{uuid}/activation
The following operations are supported on this resource:
GET
This method is used to get the activation status of the bundle template
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
ActivationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
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 |
---|---|---|---|
uuid | The uuid of BundleTemplate | path |
Input Payload
element | consumeable content type(s) |
---|---|
ActivationDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
ActivationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body. |
500 | Request 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 |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT |
404 | NOT FOUND |
/api/cms/v1/customattributetype/{uuid}/publishing
- Mount point: /api/cms/v1/customattributetype/{uuid}/publishing
The following operations are supported on this resource:
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 |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
CustomAttributeTypePublishingDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
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 |
---|---|---|---|
uuid | The uuid of the Custom Attribute Type. | path |
Input Payload
element | consumeable content type(s) |
---|---|
CustomAttributeTypePublishingDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
CustomAttributeTypePublishingDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or entity didn't pass field validation. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body. |
500 | Request is formed correctly, but server cannot perform entity update, or cannot find ESB service. Unexpected error. |
/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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
CustomAttributeTypePublishingDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/api/cms/v1/content/bundle/{uuid}
- Mount point: /api/cms/v1/content/bundle/{uuid}
The following operations are supported on this resource:
GET
This method is used to get a specific instance of the Bundle DTO by given UUID.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
BundleDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
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 |
---|---|---|---|
uuid | The uuid of Bundle. | path |
Input Payload
element | consumeable content type(s) |
---|---|
BundleDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
BundleDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body. |
500 | Request 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 |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT |
404 | NOT 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) |
---|---|
BundleDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
BundleDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is present in request path. |
500 | Request 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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
BundleDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/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) |
---|---|
ClassificationSummaryDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
ClassificationSummaryDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
400 | Request body has missing field or field with invalid values |
/api/cms/v1/bind/profile/{uuid}/bundleassociation
- Mount point: /api/cms/v1/bind/profile/{uuid}/bundleassociation
The following operations are supported on this resource:
GET
This method is used to get a BindProfileBundleAssociation rule and BindProfileBindID rule.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the BindProfile. | path |
Output Payload
element | produceable content type(s) |
---|---|
BindProfileBundleAssociationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | BindProfile NOT FOUND or BundleAssociation rule is not set up |
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 |
---|---|---|---|
uuid | The uuid of BindProfile. | path |
Input Payload
element | consumeable content type(s) |
---|---|
BindProfileBundleAssociationDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
BindProfileBundleAssociationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | BindProfile with passed UUID is not found in DB. |
405 | Request path has no BindProfile UUID |
500 | Request is formed correctly, but server cannot perform entity update. Unexpected error. |
/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 |
---|---|---|---|
uuid1 | The uuid of the AuditTrail be compared to. | path | |
uuid2 | The uuid of the AuditTrail be compared with. | path |
Output Payload
element | produceable content type(s) |
---|---|
AuditTrailCompareDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT 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 |
---|---|---|---|
type | The type of the FilterData. | path |
Output Payload
element | produceable content type(s) |
---|---|
FilterDataDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT 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 |
---|---|---|---|
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
FilterDataDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/api/entitlement/v1/entitychangeplugin/{uuid}
- Mount point: /api/entitlement/v1/entitychangeplugin/{uuid}
The following operations are supported on this resource:
GET
This method is used to get a EntityChangePlugin by given UUID.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
EntityChangePluginDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
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 |
---|---|---|---|
uuid | The uuid of EntityChangePlugin. | path |
Input Payload
element | consumeable content type(s) |
---|---|
EntityChangePluginDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
EntityChangePluginDTO | application/json |
Response Codes
code | reason |
---|---|
200 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | UUID from request is not found in DB. |
405 | Request path has no UUID or it doesn't match the one from request body. |
500 | Request 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 |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT |
404 | NOT FOUND |
/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) |
---|---|
EntityChangePluginDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
EntityChangePluginDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is present in request path. |
500 | Request is formed correctly, but server cannot create entity. Unexpected error. |
/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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
EntityChangePluginDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/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) |
---|---|
SaveClassificationDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
SaveClassificationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
400 | Bad Request |
500 | Internal Server error |
/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 |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
UrlSignerDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT 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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
UrlSignerDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
Type APINode
JSON object description
name | type | required | description |
---|---|---|---|
pathPatternGroupName | string | false | |
dTOClass | string | false | |
resourceHandlers | Array[APIResource] | false | |
module | ByCode | false | |
pathPattern | string | false | |
requestHandlerClassName | string | false | |
parent | APINode | false | |
version | string | false |
Type APIPagination
JSON object description
name | type | required | description |
---|---|---|---|
pageNumber | int | false | |
pageSize | int | false |
Type APIReference
JSON object description
name | type | required | description |
---|---|---|---|
href | string | false | The url that references the other DTO |
name | string | false | The name of the referenced DTO |
uuid | string | false | [REQUIRED] The uuid of the referenced DTO |
Type APIResource
JSON object description
name | type | required | description |
---|---|---|---|
pathPattern | string | false | |
requestHandlerClassName | string | false |
Type APISearch
JSON object description
name | type | required | description |
---|---|---|---|
searchTerm | string | false |
Type APISort
JSON object description
name | type | required | description |
---|---|---|---|
fieldName | string | false | |
ascending | boolean | false |
Type ActivationDTO
JSON object description
name | type | required | description |
---|---|---|---|
is_active | boolean | false | [REQUIRED] Shows entity active (true) or not (false) |
Type AuditTrailAdditionalInfo
JSON object description
name | type | required | description |
---|---|---|---|
webservice_name | string | false | Name of web service that produced Audit Trail |
plugin | string | false | Name of plugin |
method_params | string | false | Params of audited method |
job_name | string | false | Name of job that produced Audit Trail |
method_name | string | false | Name of audited method |
Type AuditTrailCompareDTO
JSON object description
name | type | required | description |
---|---|---|---|
audit_trail_details_2 | AuditTrailDetailsDTO | false | Second Audit Trail Details data |
audit_trail_details_1 | AuditTrailDetailsDTO | false | First Audit Trail Details data |
uuid | string | false | [READ_ONLY] Relative composed UUID1+UUID2 of Audit Trails |
Type AuditTrailDTO
JSON object description
name | type | required | description |
---|---|---|---|
entity_discriminator | string | false | The Entity Discriminator of the Audit Trail |
operation | string | true | Audited (CREATE, UPDATE, DELETE) operation |
contains_audit_data | boolean | false | Audit Data presence flag. The Audit Data should be retrieved as a sub resource |
last_modified_date | Date | true | The Last Modified Date of the Audit Trail |
additional_info | AuditTrailAdditionalInfo | false | The Additional Info of the Audit Trail |
entity_restriction_key | string | false | The entity restriction key |
account | string | false | The account of user who performed the operation |
entity_id | string | true | The Entity ID of the Audit Trail |
source | string | false | The source (WEB_SERVICE, UI) of the Audit Trail |
entity_external_id | string | false | The Entity External ID of the Audit Trail |
entity_name | string | false | The Entity Name of the Audit Trail |
uuid | string | false | [READ_ONLY] The UUID of the Audit Trail |
Type AuditTrailDetailsDTO
JSON object description
name | type | required | description |
---|---|---|---|
operation | string | false | [READ_ONLY] Audited (CREATE, UPDATE, DELETE) operation; OCM_AUDIT_TRAIL -> OPERATION |
last_modified_date | Date | false | [READ_ONLY] The Last Modified Date of the Audit Trail |
entity_uuid | string | false | [READ_ONLY] Audited Entity uuid: OCM_AUDIT_TRAIL ->ENTITY_ID |
account | string | false | [READ_ONLY] The account of user who performed the operation; OCM_AUDIT_TRAIL -> ACCOUNT |
general_details | AuditTrailDetailsInfo | false | Details Info of the Audit Trail. OCM_AUDIT_TRAIL -> AUDIT_DATA |
uuid | string | false | [READ_ONLY] The UUID of the Audit Trail |
Type AuditTrailDetailsInfo
JSON object description
name | type | required | description |
---|---|---|---|
locale_pk | string | false | Locale PK |
discriminator | string | false | Audited entity type discriminator |
common_entity_pk | string | false | Common Entity Pk |
component_pk | string | false | Component Pk |
subscription_code_pk | string | false | Subscription Code Pk |
bundle_item_pk | string | false | |
custom_attribute_pk | string | false | Custom Attribute Pk |
additionalInfo | Map[string,string] | false |
Type AvailableEntityChangePluginClassDTO
JSON object description
name | type | required | description |
---|---|---|---|
class_names | Set | false | [READ_ONLY] The list of allowed class names |
Type AvailableFieldsForMappingDTO
JSON object description
name | type | required | description |
---|---|---|---|
available_fields | Set | false | [READ_ONLY] List of fields which are allowed for mapping |
Type AvailableMetadataSourcePluginClassDTO
JSON object description
name | type | required | description |
---|---|---|---|
class_name | string | false | [READ_ONLY] The class name |
settings | Set | false | [READ_ONLY] The list of specific settings` keys |
Type BindProfileBundleAssociationDTO
JSON object description
name | type | required | description |
---|---|---|---|
bind_id_rule | CommonRuleDTO | false | Bind 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_rule | CommonRuleDTO | true | [REQUIRED] Bundle association rule |
uuid | string | false |
Type BindProfileChainingDTO
JSON object description
name | type | required | description |
---|---|---|---|
bind_profile_to_chain_to_ref | DTOReference | false | Reference to Parent BindProfile which will be chained. Must have one of allowed values or null |
available_bind_profile_to_chain_refs | Set | false | [READ ONLY] List of BindProfile reference which can be used for chaining for main Bundle |
sub_bundle_chain_rules | Set | false | List of rules for chaining for child bundles |
uuid | string | false |
Type BindProfileChildBundleAssociationDTO
JSON object description
name | type | required | description |
---|---|---|---|
child_bundle_association_rule | CommonRuleDTO | true | [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_references | Set | false | [REQUIRED] [READ_ONLY_AFTER_CREATION] List of bundletypeItems references which points place of tree to which component belongs |
uuid | string | false | [READ_ONLY] The UUID of the BindProfileChildBundleAssociation |
Type BindProfileComponentAssociationDTO
JSON object description
name | type | required | description |
---|---|---|---|
is_delete_allowed | boolean | false | [READ_ONLY] Shows that associated components can be deleted. If false field delete_obsolete_component will be ignored |
rules | Set | true | List of rules for association |
component_type_ref | DTOReference | false | [READ_ONLY] Points component type with which rule is associated |
bundle_type_item_references | Set | false | [REQUIRED, READ_ONLY after creation] List of bundletypeItems references which points place of tree to which component belongs |
delete_obsolete_component | boolean | false | [REQUIRED if is_delete_allowed=true] Shows that associated components will be deleted |
uuid | string | false | [READ_ONLY] The UUID of the BindProfileComponentAssociation |
Type BindProfileComponentCreateAssociationDTO
JSON object description
name | type | required | description |
---|---|---|---|
component_associate_rule | string | false | Rule describing how to identify an existing component in a system, when processing a create new bundle |
allow_component_create_association | boolean | false | Boolean flag indicating, that Components supports association instead of creation new Component |
uuid | string | false |
Type BindProfileDTO
JSON object description
name | type | required | description |
---|---|---|---|
is_active | boolean | false | [READ_ONLY] Shows if BindProfile is active |
component_association_rule_refs | Set | false | [READ_ONLY] References to component association rules of BindProfile |
allow_component_plugin_updates | boolean | false | [READ_ONLY] Shows if its Allowed component updates using plugin |
allow_bundle_updates | boolean | false | [READ_ONLY] Shows if bind profile supports bundle updates |
last_modified | Date | false | [READ_ONLY] The date of the last modification |
chaining_rules_ref | DTOReference | false | [READ_ONLY] BindProfileChaining rule (BindChainRule) of BindProfile |
create_association_rules_ref | DTOReference | false | [READ_ONLY] Allow component association on create new bundle rule (ComponentCreateAssociationRule) of BindProfile |
allow_component_create_association | boolean | false | [READ_ONLY] Shows if its Allowed component association on create new bundle |
auto_publish | boolean | false | Shows if Bundle should be activated when minimum rules are met. Default value: false if ommited |
update_rule_ref | DTOReference | false | [READ_ONLY] Reference to update rules of BindProfile |
description | string | false | The description of the BindProfile |
name | string | true | [REQUIRED] The name of the BindProfile |
bundle_template_ref | DTOReference | true | [REQUIRED] [READ_ONLY_AFTER_CREATION] The reference to BundleTemplate of the BindProfile |
wait_to_advance_workflow | boolean | false | Shows if wait fo advance workflow |
bundle_association_rule_ref | DTOReference | false | [READ_ONLY] Reference to BundleAssociation and BindID rules of BindProfile |
child_bundle_association_rule_refs | Set | false | [READ_ONLY] References to component association rules of BindProfile |
uuid | string | false | [READ_ONLY] The UUID of the BindProfile |
Type BindProfilePluginDTO
JSON object description
name | type | required | description |
---|---|---|---|
plugin_class | string | false | [REQUIRED_FOR_ACTIVATION] Full class name of plugin implementation |
is_active | boolean | true | [REQUIRED] Shows if plugin is active |
name | string | true | [REQUIRED] The name of the BindProfilePlugin |
configuration | string | false | Configuration of plugin |
uuid | string | false | [READ_ONLY] The UUID of the BindProfilePlugin |
Type BindProfileUpdateRuleDTO
JSON object description
name | type | required | description |
---|---|---|---|
bind_profile_plugin_ref | DTOReference | false | Reference to bindProfilePlugin |
allow_bundle_update | boolean | false | Boolean flag indicating, that Bundle suppors update instead of creation new Bundle |
component_update_rule | string | false | Rule 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_plugin | boolean | false | Boolean flag indicating, that we allow component update with using plugin. In this case reference to plugin is required |
allow_association | boolean | false | Boolean flag indicating, that it is allowed to associate existing component with Bundle. Default value is false |
bundle_update_rule | CommonRuleDTO | false | Rule describing how to update bundle. [required] if allow_bundle_update = true |
uuid | string | false |
Type BundleCleanupDTO
JSON object description
name | type | required | description |
---|---|---|---|
is_active | boolean | false | Shows if Bundle is active |
bundle_ref | DTOReference | false | Reference to the corresponding Bundle |
last_modified | Date | false | Shows the last midified date |
bundle_type_ref | DTOReference | false | Reference to the corresponding BundleType |
alt_code | string | false | Shows alternative code of the Bundle |
uuid | string | false |
Type BundleDTO
JSON object description
name | type | required | description |
---|---|---|---|
custom_attributes | Set | false | The references to Bundle custom attributes |
is_active | boolean | true | [READ-ONLY]The active status of the Bundle |
ciid | string | false | [READ_ONLY] The ciid of the Bundle |
bind_id | string | false | [READ_ONLY] The bind id of the Bundle |
version_number | int | false | [READ_ONLY] The version number of the Bundle |
shop_id | string | false | The shop id of the Bundle |
source_asset_id | string | false | [READ_ONLY] The source asset id of the Bundle |
last_modified | Date | false | [READ_ONLY] The last modified date of the Bundle |
auto_publish_check_required | boolean | false | [READ_ONLY] The auto publish check required for Bundle |
subscription_code_refs | Set | false | The reference to Bundle subscription codes |
auto_snapshot_allowed | boolean | false | The autosnapshot allowed for Bundle |
bundle_items_api_ref | APIReference | false | [READ_ONLY] The API reference to Bundle's Bundle Items |
component_source_xml_ref | DTOReference | false | [READ ONLY] The reference to Bundle source xml. Not implemented yet. Please do not use it |
is_publishable | boolean | false | The publishable status of the Bundle. Default value is false if ommited on creation |
asset_id | string | false | [READ_ONLY] The asset id of the Bundle |
name | string | true | [REQUIRED] The name of the Bundle |
product_refs | Set | false | [READ_ONLY] The references to products created using Bundle |
complete | boolean | false | [READ_ONLY] The complate status of the Bundle |
external_id | string | false | The external id of the Bundle |
last_status_change_date | Date | false | [READ_ONLY] The last status change date of the Bundle |
repository_ingest_file_path | string | false | [READ_ONLY] The repository ingest file path of the Bundle |
restriction_key | string | false | [READ_ONLY_AFTER_CREATION] The restriction key of the Bundle |
alt_code | string | false | The alt code of the Bundle |
bundle_classification | string | false | [READ_ONLY] The classification of the Bundle |
bundle_type_ref | DTOReference | true | [REQUIRED][READ_ONLY_AFTER_CREATION] The reference to Bundle type |
provider_ref | DTOReference | false | The references to Bundle provider |
create_date | Date | false | [READ_ONLY] The create date of the Bundle |
uuid | string | false | [READ_ONLY] The UUID of the Bundle |
Type BundleFolderTypeDTO
JSON object description
name | type | required | description |
---|---|---|---|
resource_labels | Set | false | The resource labels of the Bundle Folder Type for different locale |
name | string | false | The name of the Bundle Folder Type |
resource_key | string | false | The resource key of the Bundle Folder Type |
uuid | string | false | The uuid of the Bundle Folder Type |
Type BundleItemDTO
JSON object description
name | type | required | description |
---|---|---|---|
component_ref | DTOReference | true | [REQUIRED] [READ_ONLY_AFTER_CREATION] The reference to Component |
generation_type | string | false | [READ_ONLY] The generation type of the Bundle item |
parent_bundle_item_ref | DTOReference | true | [REQUIRED] [READ_ONLY_AFTER_CREATION] The reference to parent Bundle item |
sub_order_number | int | false | The sub order number of the Bundle item |
order_number | int | false | The order number of the Bundle item |
bundle_ref | DTOReference | true | [REQUIRED] [READ_ONLY_AFTER_CREATION] The reference to Bundle |
bundle_type_item_ref | DTOReference | false | [READ_ONLY] The reference to Bundle type item |
bundle_item_resource_type | BundleItemResourceTypeEnum | false | [READ_ONLY] The resource type of the Bundle item |
name | string | false | [READ_ONLY] The name of the Bundle item |
child_bundle_items_api_ref | APIReference | false | The API reference to children Bundle Items |
end_date | Date | false | The end date of the BundleItem |
start_date | Date | false | The start date of the BundleItem |
uuid | string | false | [READ_ONLY] The UUID of the Bundle item |
Type BundleMetadataSearchDTO
JSON object description
name | type | required | description |
---|---|---|---|
producer | Set | false | The names of the producers |
director | Set | false | The names of the directors |
type | string | false | The name of the Bundle classification type |
actor | Set | false | The names of the actors |
sort_field | DTOSortField | false | The sort field object that defines sorting for search result |
rating | Set | false | The ratings of the Bundle |
collection | Set | false | The collections that current Bundle is associated with |
name | string | false | The name of the Bundle |
usage_type | Set | false | The usage type of the Bundle |
provider | string | false | The name of the provider |
classification | Set | false | The classifications that the current Bundle is associated with |
uuids | Set | false | [REQUIRED] The list of Bundle uuids to search metadata |
locale | string | false | The locale of the localized metadata or common entity to search by |
end_date | Date | false | The end date filter |
studio_code | string | false | The studio codes of the Bundle |
format | Set | false | The formats of the Bundle |
start_date | Date | false | The start date filter |
catalog | Set | false | The catalogs that the current Bundle is associated with |
genre | Set | false | The genres of the Bundle |
uuid | string | false | The UUID of the Bundle |
Type BundleProductizeDTO
JSON object description
name | type | required | description |
---|---|---|---|
policy_refs | Set | true | [REQUIRED] The references to product policies |
product_refs | Set | false | The references on products related to bundle with given uuid |
uuid | string | false | [READ_ONLY] The UUID of the Bundle |
Type BundleSearchDTO
JSON object description
name | type | required | description |
---|---|---|---|
sorting | Sorting | false | The Sorting object, contains sorting info for Bundle Search |
is_active | boolean | false | The active status of the Bundle |
to_last_modified | string | false | The ending last modified date of the Bundle |
from_last_modified | string | false | The starting last modified date of the Bundle |
search_term | string | false | The term for the Bundle search |
common_entity_discriminator | string | false | The common entity discriminator for the Bundle search |
pagination | Pagination | false | The Pagination object, contains pagination info for Bundle Search |
custom_attribute_type_name | string | false | The custom attribute type name for the Bundle search |
bundle_type_uuid_list | Set | false | The Bundle Type UUIDs of the Bundle |
bundle_dto_list | Set | false | [READ_ONLY] The list of found Bundle objects |
filter_type | string | false | The filter type for the Bundle search. Default value is BUNDLE |
Type BundleTemplateDTO
JSON object description
name | type | required | description |
---|---|---|---|
is_active | boolean | false | [READ_ONLY] The activation status of the Bundle Template |
is_published | boolean | false | [READ_ONLY] The published status of the Bundle Template |
last_modified_date | Date | false | [READ_ONLY] The last modified status of the Bundle Template |
bundle_type_item_ref | Set | false | [READ_ONLY] The bundle folders associated with the Bundle Template |
resource_labels | Set | false | The resource labels of the Bundle Template for different locale |
description | string | false | The description of the Bundle Template |
name | string | false | [REQUIRED] [READ_ONLY if 'is_published'==TRUE] The name of the Bundle Template |
child_bundle_type_item | Set | false | [READ_ONLY] The root bundle folders associated with the Bundle Template |
bundle_classification | string | false | [READ_ONLY] The bundle classification of the Bundle Template |
resource_key | string | true | [REQUIRED] [READ_ONLY_AFTER_CREATION] The resource key of the Bundle Template |
uuid | string | false | [READ_ONLY] The uuid of the Bundle Template |
Type BundleTemplateFullTreeDTO
JSON object description
name | type | required | description |
---|---|---|---|
is_active | boolean | false | [READ_ONLY] The activation status of the Bundle Template |
is_published | boolean | false | [READ_ONLY] The published status of the Bundle Template |
last_modified_date | Date | false | [READ_ONLY] The last modified status of the Bundle Template |
child_bundle_type_items | Set | false | [READ_ONLY] The root bundle items which belong to the Bundle Template |
resource_labels | Set | false | The resource labels of the Bundle Template for different locale |
description | string | false | The description of the Bundle Template |
name | string | false | [REQUIRED] [READ_ONLY if 'is_published'==TRUE] The name of the Bundle Template |
bundle_classification | string | false | [READ_ONLY] The bundle classification of the Bundle Template |
resource_key | string | true | [REQUIRED] [READ_ONLY_AFTER_CREATION] The resource key of the Bundle Template |
uuid | string | false | [READ_ONLY] The uuid of the Bundle Template |
Type BundleTemplatePublishDTO
JSON object description
name | type | required | description |
---|---|---|---|
is_published | boolean | true | [REQUIRED] The publish status of the Bundle Template Resource |
uuid | string | false | The UUID of the Bundle Template Publish Resource |
Type BundleTypeItemDTO
JSON object description
name | type | required | description |
---|---|---|---|
max_occurence | int | true | [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_occurence | int | true | [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_ref | DTOReference | false | The Parent Bundle Type Item (Bundle Folder) |
discriminator | string | false | [READ_ONLY] The discriminator of the current bundle type item. Allowed values: 'BUNDLE_TYPE', 'BUNDLE_FOLDER_TYPE' or 'COMPONENT_TYPE' |
child_bundle_type_items_ref | Set | false | [READ_ONLY] The child bundle type items (bundle folders) |
add_schedule | boolean | true | [REQUIRED] Determines if add schedules to the components |
type_ref | DTOReference | true | [REQUIRED] [READ_ONLY_AFTER_CREATION] The type of the current bundle type item |
bundle_template_ref | DTOReference | false | [REQUIRED] [READ_ONLY_AFTER_CREATION] The Bundle Template which the bundle type item (bundle folder) belongs to |
uuid | string | false | [READ_ONLY] The uuid of the Bundle Type Item |
Type BundleWarningDTO
JSON object description
name | type | required | description |
---|---|---|---|
message_date | Date | false | [READ_ONLY] The message date of the BundleWarning |
bundle_ref | DTOReference | false | [READ_ONLY] The reference to associated Bundle |
validation_message | string | false | [READ_ONLY] The validation message of the BundleWarning |
event_type | string | false | [READ_ONLY] The event type of the BundleWarning |
create_date | Date | false | [READ_ONLY] The create date of the BundleWarning |
uuid | string | false | [READ_ONLY] The UUID of the BundleWarning |
Type BundleXsltDTO
JSON object description
name | type | required | description |
---|---|---|---|
custom_xslt_code | string | false | The source code of the XSLT |
is_active | boolean | true | [REQUIRED] The active status of the Bundle Xslt |
last_modified | Date | false | [READ_ONLY] The last modified date of the Bundle Xslt |
description | string | false | The description of the Bundle Xslt |
name | string | true | [REQUIRED] The name of the Bundle Xslt |
is_previewable | boolean | false | The previewable status of the Bundle Xslt |
xslt_id | string | true | [REQUIRED] The Identifier of the Bundle XSLT |
uuid | string | false | [READ_ONLY] The UUID of the Bundle Xslt |
Type CIPublishInstanceDTO
JSON object description
name | type | required | description |
---|---|---|---|
last_modified_date | Date | false | [READ_ONLY] The last modified date of the Publish Instance |
type | string | false | [READ_ONLY] The type of the Publish Instance |
total_count | int | false | [READ_ONLY] Shows the number of Tree Instances inside current Publish Instance |
status_message | string | false | [READ_ONLY] The status message of the Publish Instance |
overall_status | string | false | [READ_ONLY] The status enum of the Publish Instance |
completed_count | int | false | [READ_ONLY] Shows the number of completed Tree Instances inside current Publish Instance |
tree_instances | Set | false | [READ_ONLY] Collection of the CI Classification Tree Instances related to current Publish Instance |
create_date | Date | false | [READ_ONLY] The create date of the Publish Instance |
uuid | string | false | [READ_ONLY] The UUID of the CI Classification Publish Instance |
Type CITreePublishDTO
JSON object description
name | type | required | description |
---|---|---|---|
publish_method | string | false | [REQUIRED] The CI publish method |
node_uuids | Array[string] | false | The classification node uuids of the trees to publish. Only if NODE_UUID is used as the publish_method |
uuid | string | false |
Type CatalogDTO
JSON object description
name | type | required | description |
---|---|---|---|
is_default | boolean | false | [READ_ONLY] Is the current catalog, the default catalog? |
parent_catalog_ref | DTOReference | false | [READ_ONLY] The reference to parent catalog |
name | Set | false | [READ_ONLY] CatalogMetadata inside the catalog bundle |
uuid | string | false | [READ_ONLY] The UUID of the Catalog |
Type CategoryDTO
JSON object description
name | type | required | description |
---|---|---|---|
last_modified_date | Date | false | [READ_ONLY] The date of the last modification of Category |
order_number | int | false | The order number of Category. Number must be unique between Categories with the same inheritance level |
parent_category_ref | DTOReference | false | The reference to parent Category. See DTOReference |
locale_ref | DTOReference | false | [DEPRECATED] Use resource_key and resource_label instead. The reference to Category's Locale. See DTOReference |
resource_label | DTOResourceLabel | false | [REQUIRED][LOCALE_READ_ONLY_AFTER_CREATION] The resource label of the Category with Locale |
extra_infos | Array[CommonEntityExtraInfoDTO] | false | List of additional information entity DTOs defined for the common entity. |
name | string | false | [REQUIRED] The name of the Category |
external_id | string | false | The external id of Category |
child_category_refs | Set | false | [READ_ONLY]The Set of references to child Categories. See DTOReference |
resource_key | string | false | [REQUIRED][READ_ONLY_AFTER_CREATION] The resource key of the Category |
create_date | Date | false | [READ_ONLY] The date of creation of Category |
uuid | string | false | [READ_ONLY] The uuid of the Category |
Type CharConversionMappingDTO
JSON object description
name | type | required | description |
---|---|---|---|
last_modified_date | Date | false | [READ_ONLY] The last modified date of the Character Conversion Mapping |
description | string | false | The description of the Character Conversion Mapping |
to_char | string | false | The single ASCII character to convert to |
from_char | string | true | [REQUIRED] The single non-ASCII character to convert from. |
uuid | string | false | [READ_ONLY] The uuid of the Character Conversion Mapping |
Type ClassificationDetailsDTO
JSON object description
name | type | required | description |
---|---|---|---|
classification_start_date | Date | false | ClassificationAttribute.startDate. This is from ClassificationNode's associated Classification's Component called Classification Attribute |
classification_node_uuid | string | false | Bundle.uuid of BundleType ClassificationNode |
classification_uuid | string | false | Bundle.uuid of Bundle Type ClassificationNode's associated child Bundle Classification |
catalog_uuid | string | true | [REQUIRED] The Catalog uuid |
image_infos | Array[DTOImageInfo] | false | A list of images of the Classification Bundle, they all Physical Asset Images under the Images folder. |
asset_associations | Array[DTOAssetAssociation] | false | A list of objects representing program assetAssociations for the classification node. |
is_adult_rating | boolean | false | ClassificationAttribute.isAdultRating |
classification_custom_attributes | Array[DTOClassificationCustomAttribute] | false | A list of classification custom attributes. |
classification_nodes | Array[DTOClassificationNodeDetailsWithSiblings] | false | A list of Classification Nodes that shares the same Classification |
classification_id | string | false | Bundle.ciid of classification |
usage_type | string | false | ClassificationAttribute.usageType |
classification_node_uuids | Array[string] | true | [REQUIRED] List of UUIDs of Classification Nodes |
classification_type_ref | DTOReference | false | ClassificationAttribute.type. This is a common entity representing the type of the classification. |
classification_end_date | Date | false | ClassificationAttribute.endDate. This is from ClassificationNode's associated Classification's Component called Classification Attribute |
metadatas | Array[DTOMetadataClassification] | false | A list of Metadata associated with the Logical Video or Collection Bundle |
uuid | string | false |
Type ClassificationNodeDTO
JSON object description
name | type | required | description |
---|---|---|---|
classification_node_uuid | string | false | The current Bundle uuid representing the classification node |
classification_uuid | string | false | The Classification Bundle uuid that is associated with the current classification node uuid |
has_associations | boolean | false | |
catalog_uuid | string | true | [REQUIRED] Specifies which classification hierarchy to fetch |
sub_order_number | int | false | |
order_number | int | false | |
name | string | false | MetadataClassification.name with the specified locale in the json request |
parent_classification_node_uuid | string | false | If 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_ref | DTOReference | false | This is a common entity representing the type of the classification. |
locale | string | true | [REQUIRED] The locale of the metadata. I.e. the name |
end_date | Date | true | [REQUIRED] The end date of the window of time which at least some part of classification node exists |
path | string | false | |
start_date | Date | true | [REQUIRED] The start date of the window of time which at least some part of classification node exists |
parent_classification_node_ref | DTOReference | false | The Reference Object Representing the parent classification node |
Type ClassificationSummaryDTO
JSON object description
name | type | required | description |
---|---|---|---|
date | Date | false | |
entity_ids | Set | true | [REQUIRED] The collection of Bundle uuid's to summarise |
image_info | Set | false | |
last_availability_start_date | Date | false | |
is_hiatus_available | boolean | false | |
first_availability_start_date | Date | false | |
entity_type | string | false | |
title | string | false | |
locale | string | true | [REQUIRED] The locale of Classification |
episode_number | string | false | |
asset_type | Set | false | |
is_trailer_present | boolean | false | |
provider_ref | DTOReference | false | |
episode_title | string | false | |
uuid | string | false |
Type CollectionDetailsDTO
JSON object description
name | type | required | description |
---|---|---|---|
classification_associations | Array[DTOClassificationAssociation] | false | A list of merged classification associations |
generation_type | string | false | The association's generation type |
image_infos | Array[DTOImageInfo] | false | A list of image information attached to the current collection |
asset_associations | Array[DTOAssetAssociation] | false | A list of merged collection/program associations |
license_windows | Array[DTOLicensingWindow] | false | A list of licensing windows |
offer_windows | Array[DTOOfferWindow] | false | A list of offer windows |
provider_ref | DTOLocalizedReference | false | The provider of the collection |
metadatas | Array[DTOAssetMetadata] | false | A list of collection metadatas |
availability_windows | Array[DTOAvailabilityWindow] | false | A list of availability windows |
collection_uuid | string | true | [REQUIRED] The Collection uuid |
collection_type_ref | DTOReference | false | The type of the collection, i.e. OPEN_SERIES, SHOW_COLLECTION etc. |
Type CommonEntityDTO
JSON object description
name | type | required | description |
---|---|---|---|
custom_attributes | Set | false | The custom attributes of the Common Entity |
type | string | false | [REQUIRED] Type of common entity object |
last_modified | Date | false | [READ_ONLY] Last modification date of the common entity |
locales_ref | Set | false | [DEPRECATED] Use resource_key and resource_labels instead. |
resource_labels | Set | false | The resource labels of the Common Entity for different locale |
extra_infos | Array[CommonEntityExtraInfoDTO] | false | List of additional information entity DTOs defined for the common entity. |
apply_to_all_locales | boolean | false | |
external_id | string | false | The external id of the common entity |
resource_key | string | false | [READ_ONLY_AFTER_CREATION] The resource key of the Common Entity |
create_date | Date | false | [READ_ONLY] Creation date of the common entity |
uuid | string | false | [READ_ONLY] The UUID of the common entity |
Type CommonEntityExtraInfoDTO
JSON object description
name | type | required | description |
---|---|---|---|
content | string | false | [REQUIRED] A content of the additional information entity |
uuid | string | false | [READ_ONLY] The UUID of the additional information entity |
Type CommonEntitySearchDTO
JSON object description
name | type | required | description |
---|---|---|---|
sorting | Sorting | false | The Sorting object, contains sorting info for Common Entity search |
discriminator | string | false | Common Entity discriminator |
search_term | string | false | Common Entity Search Term |
commonEntityResultDtos | Set | false | |
pagination | Pagination | false | The Pagination object, contains pagination info for Common Entity search |
Type CommonEntityTypeDTO
JSON object description
name | type | required | description |
---|---|---|---|
discriminator | string | false | The discriminator of the common entity type |
name | string | false | The name of the CommonEntity Type |
uuid | string | false | The uuid of the CommonEntity Type |
Type CommonListStringDTO
JSON object description
name | type | required | description |
---|---|---|---|
description | string | false | [READ_ONLY] Descpiption of list |
list | Array[string] | false | [READ_ONLY] String list |
uuid | string | false |
Type CommonRuleDTO
JSON object description
name | type | required | description |
---|---|---|---|
right_hand_side | string | false | Type of searching bundlePosition |
position | int | false | Position. Shows value of position where matching pattern will be used. Must be >= 0. Required for position type = {NTH,NTHLAST} |
delim | string | false | Delimiter 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_type | string | false | Position type. Shows position where matching pattern will be used |
rule_type | string | false | Type of rule. Point to object for which matching will be used |
Type ComponentCleanupDTO
JSON object description
name | type | required | description |
---|---|---|---|
component_ref | DTOReference | false | Reference to the corresponding Component |
last_modified | Date | false | Last modified date of the Component |
discriminator | string | false | Shows discriminator of the Component |
component_binding_status | ComponentBindingStatus | false | Shows Component binding status: BOUND, UNBOUND, BIND_QUEUE, null means all |
alt_code | string | false | Shows alternative code of the Component |
uuid | string | false |
Type ComponentDTO
JSON object description
name | type | required | description |
---|---|---|---|
custom_attributes | Set | false | The custom attributes of the Component |
ciid | string | false | The ciid of the Component |
generation_type | string | false | [READ_ONLY] he generation type of component. It can be either SYSTEM or USER |
version_number | int | false | [READ_ONLY] The version of the Component |
source_asset_id | string | false | The source asset id of the Component |
last_modified | Date | false | [READ_ONLY] The last modified date of the Component |
external_version | string | false | The external version of the Component |
component_type | string | false | [READ_ONLY_AFTER_CREATION] Type of the component |
component_source_xml_ref | DTOReference | false | The reference to Component source xml |
asset_id | string | false | [READ_ONLY_AFTER_CREATION] The asset id of the Component |
name | string | true | [REQUIRED] The name of the Component |
external_id | string | false | The external id of the Component |
restriction_key | string | false | [READ_ONLY_AFTER_CREATION] The restriction key of the Component |
repository_ingest_file_path | string | false | The repository ingest file path of the Component |
alt_code | string | false | The alt code of the Component |
create_date | Date | false | [READ_ONLY] The created date of the Component |
uuid | string | false | [READ_ONLY] The uuid of the Component |
Type ComponentSearchDTO
JSON object description
name | type | required | description |
---|---|---|---|
sorting | Sorting | false | The Sorting object, contains sorting info for Component search |
search_term | string | false | The term for the Component seacrh |
pagination | Pagination | false | The Pagination object, contains pagination info for Component search |
component_dto_list | Set | false | [READ_ONLY] The list of found Component objects |
component_type_uuid | string | false | The UUID of the Component's Component Type |
Type ComponentTypeDTO
JSON object description
name | type | required | description |
---|---|---|---|
discriminator | string | false | The component discriminator of the component type |
name | string | false | The name of the Component Type |
uuid | string | false | The uuid of the Component Type |
Type ConversationDTO
JSON object description
name | type | required | description |
---|---|---|---|
action | string | false | [REQUIRED] The action type of the Conversation |
conversation_type_ref | DTOReference | false | [REQUIRED][READ_ONLY_AFTER_CREATION] The Conversation Type of the Conversation |
bundle_ref | DTOReference | false | [REQUIRED][READ_ONLY_AFTER_CREATION] The reference to Bundle |
transaction_date | Date | false | [REQUIRED] The transaction date of the Conversation |
transaction_details_refs | Set | false | [READ_ONLY] The references to Conversation details |
conversation_id | string | false | [READ_ONLY] The conversation id of the Conversation |
is_bundle_active | boolean | false | [REQUIRED] The active status of Bundle |
transaction_type | string | false | [READ_ONLY] The ConversationType name of the Conversation |
status | string | false | [REQUIRED] The status of the Conversation |
version | int | false | [REQUIRED] The version of the Conversation |
uuid | string | false | [READ_ONLY] The UUID of the Conversation |
Type ConversationDetailsDTO
JSON object description
name | type | required | description |
---|---|---|---|
level_type | string | false | The level type of the Conversation details |
message_date | Date | false | [REQUIRED] The message date of the Conversation details |
status_code | string | false | [REQUIRED] The status code of the Conversation details |
short_message | string | false | The short message of the Conversation details |
detailed_message | string | false | [REQUIRED] The detailed message of the Conversation details |
message_type | string | false | [REQUIRED] The message type of the Conversation details |
conversation_ref | DTOReference | false | [REQUIRED][READ_ONLY_AFTER_CREATION] The reference to Conversation |
uuid | string | false | [READ_ONLY] The UUID of the Conversation details |
Type ConversationRetryDTO
JSON object description
name | type | required | description |
---|---|---|---|
perform_retry | boolean | true | [REQUIRED] The retry flag of the Conversation |
uuid | string | false | [READ_ONLY] The UUID of the Conversation |
Type ConversationTypeDTO
JSON object description
name | type | required | description |
---|---|---|---|
entity_change_plugin_ref | DTOReference | false | [READ_ONLY] Reference to Entity Change Plugin of ConversationType |
name | string | false | [READ_ONLY] The UUID of the ConversationType |
uuid | string | false | [READ_ONLY] The UUID of the ConversationType |
Type CurrencyDTO
JSON object description
name | type | required | description |
---|---|---|---|
is_active | boolean | true | [REQUIRED] Shows if Currency is active |
is_default | boolean | false | Shows if Currency is a default one |
iso_locale | string | true | [REQUIRED] The ISO code for locale |
last_modified | Date | false | [READ_ONLY] Date+Time when Currency was modified |
name | string | true | [REQUIRED] The name of Currency |
iso_currency_code | string | true | [REQUIRED] The ISO code for currency (3 chars) |
uuid | string | false | [READ_ONLY] The UUID of the Currency |
Type CustomAttributeTypeDTO
JSON object description
name | type | required | description |
---|---|---|---|
is_required | boolean | false | Shows if attribute is required. Default value is false |
entry_mode | string | true | [REQUIRED] The Entry Mode of the Custom Attribute. Requried on Publish |
default_value | string | false | The Default Value of the Custom Attribute |
is_published | boolean | false | [READ_ONLY] Whether the Custom Attribute is Published and ready to use by the associated Components |
type | string | true | [REQUIRED] The Type of the Custom Attribute. Requried on Publish |
common_entity_type_refs | Set | false | The Common Entity Type to associate to, must specify at least one. Required on Publish when target == CustomAttributeTarget.COMMON_ENTITY |
last_modified | Date | false | [READ_ONLY] The last modified date of the Custom Attribute |
target | string | false | [REQUIRED] ['COMPONENT' or 'COMMON_ENTITY'] Whether the Custom Attribute associated to Components or Common Entities |
resource_labels | Set | false | The Resource Labels (language, label) pair corresponding to the resource key |
identifier | string | false | Identifier for CustomAttributeType |
description | string | false | The description of the Custom Attribute Type |
name | string | true | [REQUIRED] The name of the Custom Attribute Type |
list_item_resource_bundles | Set | false | Required 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_key | string | true | [REQUIRED] The resource key of the resource labels |
component_type_refs | Set | false | The Component Type to associate to, must specify at least one. Required on Publish when target == CustomAttributeTarget.COMPONENT |
uuid | string | false | [READ_ONLY] The UUID of the Custom Attribute Type |
Type CustomAttributeTypePublishingDTO
JSON object description
name | type | required | description |
---|---|---|---|
is_published | boolean | false | [REQUIRED] The Publish Status of the Custom Attribute Type |
uuid | string | false | [READ_ONLY] The UUID of the Custom Attribute Type |
Type DTOAssetAssociation
JSON object description
name | type | required | description |
---|---|---|---|
generation_type | string | false | The association's bundleItem.generationType |
merged_offer_visibility_windows | Array[DTODateRange] | false | The merged offer visibility windows. |
asset_uuid | string | false | The uuid of the Logical Video Bundle or Collections Bundle |
association_uuid | string | false | The Classification Bundle's bundleItem that associates to a Logical Video Bundle or OpenSeries (Collection) Bundle |
asset_type | string | false | The type of the associated bundle |
order_num | int | false | The association's bundleitem.orderNumber |
metadatas | Array[DTOMetadata] | false | The metadatas attached to the asset from association |
visibility_windows | Array[DTODateRange] | false | Offer 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_subtype | string | false | The discriminator of the COLLECTION bundle. i.e. OPEN_SERIES or SHOW_COLLECTION |
Type DTOAssetMetadata
JSON object description
name | type | required | description |
---|---|---|---|
summary | string | false | The summary of asset's Metadata |
name | string | true | [REQUIRED] The name of Metadata |
locale | string | true | [REQUIRED] The locale of Metadata |
genre_ref | DTOReference | false | The Genre common entity of asset's Metadata |
uuid | string | false | The uuid of asset's Metadata |
Type DTOAssetMetadataSave
JSON object description
name | type | required | description |
---|---|---|---|
action | string | true | [REQUIRED] |
summary | string | false | The summary of asset's Metadata |
name | string | true | [REQUIRED] The name of Metadata |
locale | string | true | [REQUIRED] The locale of Metadata |
genre_ref | DTOReference | false | The Genre common entity of asset's Metadata |
uuid | string | false | The uuid of asset's Metadata |
Type DTOAssociationMetadata
JSON object description
name | type | required | description |
---|---|---|---|
name | string | true | [REQUIRED] The name of Metadata |
locale | string | true | [REQUIRED] The locale of Metadata |
uuid | string | false | The identifier of the association metadata. |
Type DTOAssociationSave
JSON object description
name | type | required | description |
---|---|---|---|
action | string | true | [REQUIRED] |
generation_type | string | false | Generation type, default value is USER |
association_start_date | Date | true | [REQUIRED_for_CREATE,UPDATE] Start date of association |
target_uuid | string | false | [REQUIRED_for_CREATE,UPDATE] The Target uuid for association (can be uuid of Classification, Node or Collection) |
association_uuid | string | false | [REQUIRED_for_CREATE,UPDATE] The Target Bundle's bundleItem uuid that associates to a child Bundle |
association_end_date | Date | true | [REQUIRED_for_CREATE,UPDATE] End date of association |
order_num | int | false | The association's bundleitem.orderNumber |
Type DTOAvailabilityWindow
JSON object description
name | type | required | description |
---|---|---|---|
offer_type_ref | DTOReference | false | The offer type of the Availability Window. Eg: IPPR, FREE, etc |
usage_type | string | false | The usage type of the Availability Window |
end_date | Date | false | The end date of the Availability Window |
start_date | Date | false | The start date of the Availability Window |
uuid | string | false | The identifier of the Availability Window |
Type DTOAvailabilityWindowSave
JSON object description
name | type | required | description |
---|---|---|---|
action | string | true | [REQUIRED] |
offer_type_ref | DTOReference | false | The offer type of the Availability Window. Eg: IPPR, FREE, etc |
usage_type | string | false | The usage type of the Availability Window |
end_date | Date | false | The end date of the Availability Window |
start_date | Date | false | The start date of the Availability Window |
uuid | string | false | The identifier of the Availability Window |
Type DTOClassificationAssociation
JSON object description
name | type | required | description |
---|---|---|---|
generation_type | string | false | The association's generation type. |
classification_uuid | string | false | The identifier of the classification. |
classification_type_ref | DTOReference | false | This is a common entity representing the type of the classification. |
association_uuid | string | false | The association's UUID. |
order_num | int | false | The association's order number. |
merged_classification_node_schedule | Array[DTODateRange] | false | A list of merged classification node schedules. |
metadatas | Array[DTOClassificationPath] | false | A list of classification path for all languages. |
visibility_windows | Array[DTODateRange] | false | The association's visibility windows. |
Type DTOClassificationCustomAttribute
JSON object description
name | type | required | description |
---|---|---|---|
value | string | false | Custom Attribute value |
name | string | false | Custom Attribute name |
uuid | string | false | Custom Attribute UUID |
Type DTOClassificationCustomAttributeSave
JSON object description
name | type | required | description |
---|---|---|---|
action | string | true | [REQUIRED] |
value | string | false | Custom Attribute value |
name | string | false | Custom Attribute name |
uuid | string | false | Custom Attribute UUID |
Type DTOClassificationNodeDetails
JSON object description
name | type | required | description |
---|---|---|---|
classification_node_end_date | Date | false | End date for classification node, mapped from ClassificationNode.ClassificationNodeAttribute.endDate |
classification_uuid | string | false | The Classification Bundle uuid that is associated with the current classification node uuid |
classification_node_uuid | string | false | ClassificationNode UUID |
catalog_uuid | string | false | The catalog to which classification belongs |
sub_order_number | int | false | Additional order number of classification node, used when order numbers are the same, mapped from bundleItem.subOrderNumber |
order_number | int | false | Order number, mapped from BundleItem.orderNumber |
classification_type_ref | DTOReference | false | The reference to the classification type common entity of node's classification |
classification_node_start_date | Date | false | Start date for classification node, mapped from ClassificationNode.ClassificationNodeAttribute.startDate |
metadatas | Array[DTOMetadataClassificationNode] | false | List of classification node metadatas |
Type DTOClassificationNodeDetailsSave
JSON object description
name | type | required | description |
---|---|---|---|
action | string | true | [REQUIRED] |
classification_node_end_date | Date | false | End date for classification node, mapped from ClassificationNode.ClassificationNodeAttribute.endDate |
classification_uuid | string | false | The Classification Bundle uuid that is associated with the current classification node uuid |
classification_node_uuid | string | false | ClassificationNode UUID |
catalog_uuid | string | true | [REQUIRED] The catalog to which classification belongs |
sub_order_number | int | false | Additional order number of classification node, used when order numbers are the same, mapped from bundleItem.subOrderNumber |
order_number | int | false | Order number, mapped from BundleItem.orderNumber |
parent_classification_node_uuid | string | true | [REQUIRED] The parent of the classification node to point to |
classification_type_ref | DTOReference | false | The reference to the classification type common entity of node's classification |
classification_node_start_date | Date | false | Start date for classification node, mapped from ClassificationNode.ClassificationNodeAttribute.startDate |
metadatas | Array[DTOMetadataClassificationNode] | false | List of classification node metadatas |
Type DTOClassificationNodeDetailsWithSiblings
JSON object description
name | type | required | description |
---|---|---|---|
classification_node_end_date | Date | false | End date for classification node, mapped from ClassificationNode.ClassificationNodeAttribute.endDate |
classification_uuid | string | false | The Classification Bundle uuid that is associated with the current classification node uuid |
classification_node_uuid | string | false | ClassificationNode UUID |
catalog_uuid | string | false | The catalog to which classification belongs |
sub_order_number | int | false | Additional order number of classification node, used when order numbers are the same, mapped from bundleItem.subOrderNumber |
order_number | int | false | Order number, mapped from BundleItem.orderNumber |
parent_classification_node | DTOClassificationNodeDetails | false | Parent Classification Node Details |
sibling_nodes | Array[DTOClassificationNodeDetails] | false | List of Classification Node Details |
classification_type_ref | DTOReference | false | The reference to the classification type common entity of node's classification |
classification_node_start_date | Date | false | Start date for classification node, mapped from ClassificationNode.ClassificationNodeAttribute.startDate |
metadatas | Array[DTOMetadataClassificationNode] | false | List of classification node metadatas |
Type DTOClassificationNodeWithChildren
JSON object description
name | type | required | description |
---|---|---|---|
classification_node_end_date | Date | false | End date for classification node, mapped from ClassificationNode.ClassificationNodeAttribute.endDate |
classification_node_uuid | string | false | ClassificationNode UUID |
sub_order_number | int | false | Additional order number of classification node, used when order numbers are the same, mapped from bundleItem.subOrderNumber |
order_number | int | false | Order number, mapped from BundleItem.orderNumber |
child_classification_nodes | Array[DTOClassificationNodeDetails] | false | End date for classification node, mapped from ClassificationNode.ClassificationNodeAttribute.endDate |
classification_node_start_date | Date | false | Start date for classification node, mapped from ClassificationNode.ClassificationNodeAttribute.startDate |
metadatas | Array[DTOMetadataClassificationNode] | false | List of classification node metadatas |
Type DTOClassificationPath
JSON object description
name | type | required | description |
---|---|---|---|
classification_node_path | string | false | The classification path. |
locale | string | false | The locale of the language. |
uuid | string | false | The identifier. |
Type DTOCollectionAssociation
JSON object description
name | type | required | description |
---|---|---|---|
generation_type | string | false | The association's generation type. |
association_uuid | string | false | The association's UUID. |
order_num | int | false | The association's order number. |
metadatas | Array[DTOAssociationMetadata] | false | A list of collection name for all languages. |
visibility_windows | Array[DTODateRange] | false | The association's visibility windows. |
merged_collection_offer_schedule | Array[DTODateRange] | false | A list of merged collection offer schedules. |
collection_uuid | string | false | The identifier of the collection. |
Type DTODateRange
JSON object description
name | type | required | description |
---|---|---|---|
end_date | Date | false | |
start_date | Date | false |
Type DTOImageInfo
JSON object description
name | type | required | description |
---|---|---|---|
image_type_ref | DTOReference | false | The first ImageType common entity of Physical Asset Image |
file_size | long | false | The file size in bytes of Physical Asset Image |
access_url | string | false | The asset URL of Physical Asset Image, mapped from PhysicalAssetImage.cdnURL field |
physical_asset_image_uuid | string | false | The uuid of the Physical Asset Image Object |
name | string | false | The name of the Physical Asset Image Object |
locale | string | false | The locale field of Physical Asset Image |
height | int | false | The height in pixels of Physical Asset Image |
end_date | Date | false | The end date of the Bundle containing Physical Asset Image |
width | int | false | The width in pixels of Physical Asset Image |
start_date | Date | false | The start date of the Bundle containing Physical Asset Image |
Type DTOImageInfoSave
JSON object description
name | type | required | description |
---|---|---|---|
action | string | true | [REQUIRED] |
image_type_ref | DTOReference | false | The first ImageType common entity of Physical Asset Image |
file_size | long | false | The file size in bytes of Physical Asset Image |
access_url | string | false | The asset URL of Physical Asset Image, mapped from PhysicalAssetImage.cdnURL field |
physical_asset_image_uuid | string | false | The uuid of the Physical Asset Image Object |
name | string | false | The name of the Physical Asset Image Object |
height | int | false | The height in pixels of Physical Asset Image |
locale | string | false | The locale field of Physical Asset Image |
end_date | Date | false | The end date of the Bundle containing Physical Asset Image |
association_uuid | string | false | The UUID of image association to target |
width | int | false | The width in pixels of Physical Asset Image |
start_date | Date | false | The start date of the Bundle containing Physical Asset Image |
Type DTOLicensingWindow
JSON object description
name | type | required | description |
---|---|---|---|
end_date | Date | false | The end date of the Licensing Window |
start_date | Date | false | The start date of the Licensing Window |
uuid | string | false | The identifier of the Licensing Window |
Type DTOLicensingWindowSave
JSON object description
name | type | required | description |
---|---|---|---|
action | string | true | [REQUIRED] |
end_date | Date | false | The end date of the Licensing Window |
start_date | Date | false | The start date of the Licensing Window |
uuid | string | false | The identifier of the Licensing Window |
Type DTOLocalizedReference
JSON object description
name | type | required | description |
---|---|---|---|
href | string | false | The url that references the other DTO |
name | string | false | The name of the referenced DTO |
resource_bundle | DTOResourceBundle | false | Resource bundle for localization. |
uuid | string | false | [REQUIRED] The uuid of the referenced DTO |
Type DTOMetadata
JSON object description
name | type | required | description |
---|---|---|---|
name | string | true | [REQUIRED] The name of Metadata |
locale | string | true | [REQUIRED] The locale of Metadata |
Type DTOMetadataClassification
JSON object description
name | type | required | description |
---|---|---|---|
toggle_label | string | false | The toggle label of Metadata Classification |
short_name | string | false | The short title of Metadata Classification |
provider_branding | string | false | The provider branding of Metadata Classification |
synopsis | string | false | The long summary of Metadata Classification |
long_name | string | false | The long title of Metadata Classification |
name | string | true | [REQUIRED] The name of Metadata |
locale | string | true | [REQUIRED] The locale of Metadata |
soft_name | string | false | The soft name of Metadata Classification |
medium_name | string | false | The medium title of Metadata Classification |
uuid | string | false | The uuid of Metadata Classification |
Type DTOMetadataClassificationNode
JSON object description
name | type | required | description |
---|---|---|---|
locale | string | false | Locale field of Classification Node Metadata |
path | string | false | Path to this classification node from the root node |
Type DTOMetadataClassificationSave
JSON object description
name | type | required | description |
---|---|---|---|
action | string | true | [REQUIRED] |
toggle_label | string | false | The toggle label of Metadata Classification |
short_name | string | false | The short title of Metadata Classification |
provider_branding | string | false | The provider branding of Metadata Classification |
synopsis | string | false | The long summary of Metadata Classification |
long_name | string | false | The long title of Metadata Classification |
name | string | true | [REQUIRED] The name of Metadata |
locale | string | true | [REQUIRED] The locale of Metadata |
soft_name | string | false | The soft name of Metadata Classification |
medium_name | string | false | The medium title of Metadata Classification |
uuid | string | false | The uuid of Metadata Classification |
Type DTOOfferWindow
JSON object description
name | type | required | description |
---|---|---|---|
generation_type | string | false | The value indicating if it is a 'SYSTEM' generated or 'USER' generated |
catalog_uuid | string | false | The identifier of the catalog |
planner_retention | int | false | The planner retention of the OfferWindow |
offer_type_ref | DTOReference | false | The offer type of the Offer Window. Eg: IPPR, FREE, etc |
usage_type | string | false | The usage type of the Offer Window |
expiry_date | Date | false | The expiry date of the Offer Window |
end_date | Date | false | [READ_ONLY] The end date of the Offer Window, which calculated dynamically by offerType offerEndCalculator. |
start_date | Date | false | The start date of the Offer Window |
uuid | string | false | The identifier of the Offer Window |
Type DTOOfferWindowSave
JSON object description
name | type | required | description |
---|---|---|---|
action | string | true | [REQUIRED] |
generation_type | string | false | The value indicating if it is a 'SYSTEM' generated or 'USER' generated |
catalog_uuid | string | false | The identifier of the catalog |
planner_retention | int | false | The planner retention of the OfferWindow |
offer_type_ref | DTOReference | false | The offer type of the Offer Window. Eg: IPPR, FREE, etc |
usage_type | string | false | The usage type of the Offer Window |
expiry_date | Date | false | The expiry date of the Offer Window |
end_date | Date | false | [READ_ONLY] The end date of the Offer Window, which calculated dynamically by offerType offerEndCalculator. |
start_date | Date | false | The start date of the Offer Window |
uuid | string | false | The identifier of the Offer Window |
Type DTOProgramMetadata
JSON object description
name | type | required | description |
---|---|---|---|
studio_code_ref | DTOReference | false | The value of the studio code. |
summary | string | false | The value of the summary. |
title | string | false | The name of the programme. |
marketing_message | string | false | The value of the marketing message. |
locale | string | false | The locale of the language. |
episode_number | int | false | The value of the episode number. |
genre_ref | DTOReference | false | The value of the genre/sub genre. |
episode_title | string | false | The name of the episode. |
uuid | string | false | The identifier of the program metadata. |
Type DTOReference
JSON object description
name | type | required | description |
---|---|---|---|
href | string | false | The url that references the other DTO |
name | string | false | The name of the referenced DTO |
uuid | string | false | [REQUIRED] The uuid of the referenced DTO |
Type DTOResourceBundle
JSON object description
name | type | required | description |
---|---|---|---|
resource_labels | Set | false | The Resource Labels (language, label) pair corresponding to the resource key |
resource_key | string | true | [REQUIRED] The resource key of the resource labels |
Type DTOResourceLabel
JSON object description
name | type | required | description |
---|---|---|---|
label | string | false | The resource label corresponding to the language |
language | string | false | The language of the resource label |
Type DTOSortField
JSON object description
name | type | required | description |
---|---|---|---|
field_name | string | true | [REQUIRED] The name of the sort field. |
order | SortOrder | true | [REQUIRED] The sort order. Possible values: ['ASC', 'DESC'] |
Type DTOTrailerInfo
JSON object description
name | type | required | description |
---|---|---|---|
file_size | long | false | The file size of the trailer. |
access_url | string | false | The url of the location of the image. |
name | string | false | The file name of the trailer. |
physical_asset_video_uuid | string | false | The identifier of the trailer. |
duration | string | false | The duration of the trailer. |
Type DataForAssociationDTO
JSON object description
name | type | required | description |
---|---|---|---|
offer_visibility_windows | Array[DTOOfferWindow] | false | The list of offer windows |
asset_uuids | Array[string] | true | [REQUIRED] Bundle UUIDs of PROGRAM or COLLECTION |
type | string | false | The type of the asset |
asset_uuid | string | false | Bundle UUID of PROGRAM or COLLECTION |
metadatas | Array[DTOMetadata] | false | The metadatas attached to the asset |
Type DataForClassificationAssociationDTO
JSON object description
name | type | required | description |
---|---|---|---|
classification_uuid | string | false | The current Bundle uuid representing the Classification |
usage_type | string | false | ClassificationAttribute.usageType. Usage type of the Classification Bundle |
classification_type_ref | DTOReference | false | ClassificationAttribute.type. This is a common entity representing the type of the Classification |
classification_uuids | Array[string] | true | [REQUIRED] List of UUIDs of Classifications |
merged_classification_nodes | Array[DTODateRange] | false | The list of classification node that belong to the current classification and merge them by start/end if they overlap |
metadatas | Array[DTOMetadataClassification] | false | A list of object representing the metadatas of the of the current Classification, in all of the locales |
Type DataForClassificationDTO
JSON object description
name | type | required | description |
---|---|---|---|
classification_node_uuid | string | true | [REQUIRED] ClassificationNode UUID |
classification_uuid | string | false | The Classification Bundle uuid that is associated with the current classification node uuid |
classification_nodes | Array[DTOClassificationNodeWithChildren] | false | The list of the classification nodes with the same classification, path and catalog as the requested node. |
classification_type_ref | DTOReference | false | Reference to ClassificationAttribute.classificationType |
Type DeleteClassificationDTO
JSON object description
name | type | required | description |
---|---|---|---|
classification_node_uuid | string | true | [REQUIRED] UUID of Classification Node that should be deleted |
catalog_uuid | string | true | [REQUIRED] The Catalog uuid |
uuid | string | false |
Type EntityChangePluginDTO
JSON object description
name | type | required | description |
---|---|---|---|
process_all_entities | boolean | false | True - 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_class | string | true | [REQUIRED] Full class name of plugin implementation |
plugin_type | string | true | [REQUIRED] Type of plugin |
is_active | boolean | false | [READ_ONLY] Shows if EntityChangePlugin is active. |
entity_to_process | Set | false | List of types of entities which should be processed by plugin |
process_all_plugins | boolean | false | True - 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 |
name | string | true | [REQUIRED] The name of the EntityChangePlugin |
last_run | long | false | [READ_ONLY] The POSIX time that this plugin was last processed successfully |
interval | long | true | [REQUIRED] Interval for start plugin in milliseconds. Default value is 60 000 ms |
plugin_to_process | Set | false | List of none CORE plugins which should be called by plugin for processing of entity |
uuid | string | false | [READ_ONLY] The UUID of the EntityChangePlugin |
Type EntityDTO
JSON object description
name | type | required | description |
---|---|---|---|
class_name | string | false | Full class name of Entity |
name | string | false | The name of Entity |
Type EntityFieldInfoDTO
JSON object description
name | type | required | description |
---|---|---|---|
field_name | string | false | [READ_ONLY] The name of the field |
discriminator | string | false | [READ_ONLY] The specific discriminator of the field |
field_name_resource_bundle | DTOResourceBundle | false | [READ_ONLY] The DTOResourceBundle that is used to represent the name of the field in different locale |
entity_type | string | false | [READ_ONLY] The entity type of the field |
field_id | string | false | [READ_ONLY] The id of the field that is generated |
localization_method | string | false | [READ_ONLY] The localization method of the field or null for custom attributes |
field_description_resource_bundle | DTOResourceBundle | false | [READ_ONLY] The DTOResourceBundle that is used to represent the description of the field in different locale |
field_type | string | false | [READ_ONLY] The type of the field (e.g. STRING, DATE, INTEGER) |
uuid | string | false | [READ_ONLY] The UUID of the field |
Type FeedDTO
JSON object description
name | type | required | description |
---|---|---|---|
is_active | boolean | true | [REQUIRED] Shows if Feed is active |
last_modified | Date | false | [READ_ONLY] Date+Time when Feed was modified |
description | string | false | The description ofthe Feed |
name | string | true | [REQUIRED] The name of the Feed |
bundle_type_refs | Set | false | [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_feed | boolean | false | Defines type of Feed. True - product, False - bundle |
feed_type_ref | DTOReference | true | [REQUIRED] Reference to FeedType which defines a type of Feed |
use_all_bundle_type | boolean | true | [REQUIRED] Shows if Feed will process all bundletypes |
uuid | string | false | [READ_ONLY] The UUID of the Feed |
Type FeedTypeDTO
JSON object description
name | type | required | description |
---|---|---|---|
is_active | boolean | false | [READ_ONLY] The activation status of the Feed Type |
is_product | boolean | false | [READ_ONLY_AFTER_CREATION] Shows if FeedType is Product (true) or Bundle (false) |
last_modified_date | Date | false | [READ_ONLY] The last modified date of the Feed Type |
description | string | false | The Description of the Feed Type |
xslt_byte | string | false | The XSLT source code for the Feed Type |
entity_change_plugin_ref | DTOReference | true | [REQUIRED] The reference to the Feed Entity Change Plugin it applies to |
name | string | true | [REQUIRED] The name of the Feed Type |
uuid | string | false | [READ_ONLY] The uuid of the Feed Type DTO |
Type FilterDataDTO
JSON object description
name | type | required | description |
---|---|---|---|
filter_type | string | false | [READ_ONLY] The type of the filter |
filter_instances | Set | false | [READ_ONLY] The list of filter instances |
uuid | string | false |
Type FolderTypeCdnMappingDTO
JSON object description
name | type | required | description |
---|---|---|---|
image_type_ref | DTOReference | false | image type which is linked to image cdn mapping |
description | string | false | The description of the Folder Type CDN Mapping |
destination | string | false | The 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 |
uuid | string | false | [READ_ONLY] The uuid of the Folder Type CDN Mapping |
Type ImageProfileAvailableFormatDTO
JSON object description
name | type | required | description |
---|---|---|---|
format_name | string | false | [READ_ONLY] The file format name |
color_depth | Array[int] | false | [READ_ONLY] The list of allowed color depth values for file format name |
Type ImageProfileDTO
JSON object description
name | type | required | description |
---|---|---|---|
is_active | boolean | false | [REQUIRED] Shows that image profile is active (true) or not (false) |
image_type_ref | DTOReference | false | image type which is linked to image profile |
letter_boxing_background_color | int | false | [REQUIRED if letter_boxing=true and file format is not PNG] The background color for image |
related_thumbnail | boolean | false | [ACTUAL for image_type=ARTWORK only] Determines that thumbnail will be created (true) or not (false) for ARTWORK image |
letter_boxing | boolean | false | [REQUIRED] Shows that letterBoxing is used for image transformation |
target_device_refs | Set | false | List device targets which is linked to image profile |
last_modified | Date | false | [READ_ONLY] The date of the last modification |
selected_file_format | string | false | [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_depth | int | false | [REQUIRED] The selected color depth for image. Must be one from available file format values for selected image file format |
related_thumbnail_height | int | false | [REQUIRED if related_thumbnail=true] The height of thumbnail image. Must be > 0 and <=9999 |
related_thumbnail_width | int | false | [REQUIRED if related_thumbnail=true] The width of thumbnail image. Must be > 0 and <=9999 |
description | string | false | The description of Image Profile |
name | string | false | [REQUIRED] The name of Image Profile |
renaming_options | string | false | The 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). |
height | int | false | [REQUIRED] The height of image. Must be > 0 and <=9999 |
width | int | false | [REQUIRED] The width of image. Must be > 0 and <=9999 |
transparent | boolean | false | [ACTUAL for PNG file format only] Shows that image background must be transparent |
uuid | string | false | [READ_ONLY] The uuid of Image Profile |
Type JustInTimePolicyDTO
JSON object description
name | type | required | description |
---|---|---|---|
is_active | boolean | false | Shows if JustInTimePolicy is active. Default value for POST operations: false. |
hours_before_offer_start | int | false | Shows 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_modified | Date | false | [READ_ONLY] The last modified date of JustInTimePolicy |
description | string | false | The description of JustInTimePolicy |
entity_change_plugin_ref | DTOReference | false | The reference to entityChangePlugin. [REQUIRED] for active policy. |
name | string | false | [REQUIRED] The name of the JustInTimePolicy |
create_date | Date | false | [READ_ONLY] The creation date of JustInTimePolicy |
uuid | string | false | [READ_ONLY] The uuid of the JustInTimePolicy |
Type LocaleDTO
JSON object description
name | type | required | description |
---|---|---|---|
localeCode | string | false | Concatenation of language and country |
country | string | false | The country code of the Locale |
isDefault | boolean | false | is the localeCode the default locale? |
languageName | string | false | Language Display Name |
language | string | false | The language code of the Locale |
uuid | string | false | The uuid of the Locale |
Type MetadataSourcePluginDTO
JSON object description
name | type | required | description |
---|---|---|---|
plugin_class | string | false | The full name of implementation class of MetadataSourcePlugin |
is_active | boolean | false | [READ_ONLY] Shows that plugin is active (true) or not (false) |
field_mapping_schema | string | false | [READ_ONLY] The xsd which describes scheme of allowed mapping rules |
plugin_specific_values | Set | false | List of plugin`s specific settings |
name | string | false | [REQUIRED, UNIQUE] The name of MetadataSourcePlugin |
field_mapping_xml | string | false | The mapping XML which describes rules how to map input data to inner model data |
selected_field_map | Set | false | List of fields which will be mapped to locales by plugin |
uuid | string | false | [READ_ONLY] The uuid of MetadataSourcePlugin |
Type NotificationPluginDTO
JSON object description
name | type | required | description |
---|---|---|---|
plugin_class | string | false | Full class name of plugin implementation |
is_active | boolean | true | [REQUIRED] Shows if plugin is active |
is_default | boolean | false | [READ_ONLY] Shows if plugin is predefined (default). All new plugins will have dafult value = false |
name | string | true | [REQUIRED] The name of the NotificationPlugin |
uuid | string | false | [READ_ONLY] The UUID of the NotificationPlugin |
Type OriginMappingDTO
JSON object description
name | type | required | description |
---|---|---|---|
url_signer_config_ref | DTOReference | false | The reference to UrlSignerConfiguration |
public_url | string | true | [REQUIRED] The public url of the OriginMapping |
name | string | true | [REQUIRED] The name of the OriginMapping |
origin_base_url | string | true | [REQUIRED] The origin base url of the OriginMapping |
uuid | string | false | [READ_ONLY] The UUID of the OriginMapping |
Type Pagination
JSON object description
name | type | required | description |
---|---|---|---|
first_page_url | string | false | |
page_size | int | false | [REQUIRED] The size of page |
total_pages | int | false | |
total_count | long | false | |
last_page_url | string | false | |
page_number | int | false | [REQUIRED] The number of page |
next_page_url | string | false | |
previous_page_url | string | false |
Type PerformSearchDTO
JSON object description
name | type | required | description |
---|---|---|---|
search_type | SearchType | true | [REQUIRED] The type of search (searching by availability or offers) |
producer | Set | false | The names of the producers |
director | Set | false | The names of the directors |
type | string | false | The name of the Bundle classification type |
actor | Set | false | The names of the actors |
sort_field | DTOSortField | false | The sort field object that defines sorting for search result |
rating | Set | false | The ratings of the Bundle |
exclude_bundle_type | Set | false | The list of bundle types (bundle templates), that should be excluded |
search_term | string | false | The term for the search |
classification_filters | Set | false | The classification filters |
classification_usage_type_filters | Set | false | The classification usage type filters |
program_usage_type_filters | Set | false | The program usage type filters |
collection | Set | false | The collections that current Bundle is associated with |
facet_result_only | boolean | true | [REQUIRED] Whether or not to return the JSON request with facet_count populated for each of the filters |
common_entity_filters | Set | false | The common entity filters |
name | string | false | The name of the Bundle |
usage_type | Set | false | The usage type of the Bundle |
provider | string | false | The name of the provider |
talent_filters | Set | false | The Talent common entity filters |
classification | Set | false | The classifications that the current Bundle is associated with |
locale | string | false | The locale of the localized metadata or common entity to search by |
entity_field_filters | Set | false | The entity field filters |
end_date | Date | false | The end date filter |
availability_type | AvailabilityType | true | [REQUIRED] The availability type |
save_search | boolean | true | [REQUIRED] Whether or not to Save the current Search i.e. the JSON Request |
studio_code | string | false | The studio codes of the Bundle |
format | Set | false | The formats of the Bundle |
start_date | Date | false | The start date filter |
catalog | Set | false | The catalogs that the current Bundle is associated with |
dynamic_attribute_filters | Set | false | The dynamic atribute filters |
uuid | string | false | The UUID of the Bundle |
genre | Set | false | The genres of the Bundle |
Type PolicyDTO
JSON object description
name | type | required | description |
---|---|---|---|
offer_type | string | false | The offer type of the Policy |
is_active | boolean | true | [REQUIRED] The active status of the Policy |
last_modified | Date | false | [READ_ONLY] The last modified date of the Policy |
description | string | false | The description of the Policy |
name | string | true | [REQUIRED] The name of the Policy |
is_subscription | boolean | true | [REQUIRED] The subscription status of the Policy |
uuid | string | false | [READ_ONLY] The UUID of the Policy |
Type ProductResolutionPluginDTO
JSON object description
name | type | required | description |
---|---|---|---|
plugin_class | string | false | [REQUIRED_FOR_ACTIVATION] Full class name of plugin implementation |
is_active | boolean | true | [REQUIRED] Shows if plugin is active |
last_modified | Date | false | [READ_ONLY] Shows date and time of last plugin modification |
predefined | boolean | false | [READ_ONLY] Shows if plugin is predefined. All new plugins will have predefined value = false |
name | string | true | [REQUIRED] The name of the ProductResolutionPlugin |
uuid | string | false | [READ_ONLY] The UUID of the NotificationPlugin |
Type ProgramDetailsDTO
JSON object description
name | type | required | description |
---|---|---|---|
director_refs | Array[DTOLocalizedReference] | false | A list of directors. |
rating_refs | Array[DTOReference] | false | The parental ratings of the programme. |
classification_associations | Array[DTOClassificationAssociation] | false | A list of merged classification associations. |
producer_refs | Array[DTOLocalizedReference] | false | A list of producers. |
collection_associations | Array[DTOCollectionAssociation] | false | A list of merged collection associations. |
cast_member_refs | Array[DTOLocalizedReference] | false | A list of cast members. |
advisory_refs | Array[DTOReference] | false | The parental advisories of the programme. |
image_infos | Array[DTOImageInfo] | false | A list of image information for each language. |
license_windows | Array[DTOLicensingWindow] | false | A list of license windows. |
asset_format_ref | DTOReference | false | The value of the movie format. |
aspect_ratio | string | false | The value of the movie aspect ratio. |
asset_id | string | false | The asset id of the movie. |
audio_type | string | false | The value of the movie audio type: 'Stereo', 'Mono', etc. |
program_uuid | string | true | [REQUIRED] The Program uuid. |
writer_refs | Array[DTOLocalizedReference] | false | A list of writers. |
trailer_infos | Array[DTOTrailerInfo] | false | The trailers information. |
offer_windows | Array[DTOOfferWindow] | false | A list of windows offers. |
epg_date | Date | false | The value of the movie EPG date. |
duration | string | false | The duration of the movie. |
provider_ref | DTOLocalizedReference | false | The provider of the movie. |
release_date | Date | false | The release date of production of the programme. |
metadatas | Array[DTOProgramMetadata] | false | A list of program metadata. |
availability_windows | Array[DTOAvailabilityWindow] | false | A list of availability windows. |
uuid | string | false |
Type ProgramOrCollectionForClassificationDTO
JSON object description
name | type | required | description |
---|---|---|---|
generation_type | string | false | The association's generation type |
classification_uuid | string | false | The Classification Node's Classification Bundle uuid |
catalog_uuid | string | true | [REQUIRED] UUID of Catalog to which Program/Collection belongs |
has_associations | boolean | false | If the Open Series or Show Collection Bundle have child Bundle (Logical Video attached to it) |
order_number | int | false | The association's order number |
asset_format_ref | DTOReference | false | A DTOReference object representing the Program's format |
is_physical_asset_available | boolean | false | if there is an associated PhysicalAssetVideo in the Logical Video Bundle |
asset_uuid | string | false | The Program/Collection Bundle's uuid |
classification_node_uuids | Array[string] | true | [REQUIRED] Classification node's uuids |
title | string | false | Localized Program/Collection name |
locale | string | false | Locale. Default value is system locale will be taken |
end_date | Date | true | [REQUIRED] The end date of the visibility window |
association_uuid | string | false | The Classification Bundle's bundleItem that associates to a Logical Video Bundle or OpenSeries (Collection) Bundle |
asset_type | string | false | The type of the associated bundle |
start_date | Date | true | [REQUIRED] The start date of the visibility window |
asset_subtype | string | false | The discriminator of the COLLECTION bundle. i.e. OPEN_SERIES or SHOW_COLLECTION |
uuid | string | false | |
visibility_windows | Array[DTODateRange] | false | Offer 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
name | type | required | description |
---|---|---|---|
generation_type | string | false | The association's generation type |
catalog_uuid | string | true | [REQUIRED] UUID of Catalog to which Program/Collection belongs |
has_associations | boolean | false | If the Open Series or Show Collection Bundle have child Bundle (Logical Video attached to it) |
order_number | int | false | The association's order number |
asset_format_ref | DTOReference | false | A DTOReference object representing the Program's format |
is_physical_asset_available | boolean | false | if there is an associated PhysicalAssetVideo in the Logical Video Bundle |
asset_uuid | string | false | The Program/Collection Bundle's uuid |
title | string | false | Localized Program/Collection name |
locale | string | false | Locale. Default value is system locale will be taken |
end_date | Date | true | The end date of the visibility window |
association_uuid | string | false | The Classification Bundle's bundleItem that associates to a Logical Video Bundle or OpenSeries (Collection) Bundle |
asset_type | string | false | The type of the associated bundle |
start_date | Date | true | The start date of the visibility window |
asset_subtype | string | false | The discriminator of the COLLECTION bundle. i.e. OPEN_SERIES or SHOW_COLLECTION |
collection_uuid | string | true | The Collection Bundle's uuid |
uuid | string | false | |
visibility_windows | Array[DTODateRange] | false | Offer 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
name | type | required | description |
---|---|---|---|
loginedUser | string | false | |
pathParams | Map[APINode,string] | false | |
sort | APISort | false | |
parentUuid | string | false | |
currentUuid | string | false | |
pagination | APIPagination | false | |
currentNode | APINode | false | |
search | APISearch | false |
Type RetentionPolicyDTO
JSON object description
name | type | required | description |
---|---|---|---|
delete_date_type | PolicyRuleDeleteDateType | false | Enum with policy Rule value: LICENSE_WINDOW_START(Default value), LICENSE_WINDOW_END, BUNDLE_ACTIVATE_START, INACTIVE_BUNDLE_CREATE |
is_active | boolean | false | Shows if RetentionPolicy is active. Default value for POST operations: false |
last_modified | Date | false | [READ_ONLY] The last modified date of RetentionPolicy |
associated_provider_refs | Set | false | The Set of references to associated Providers. Applies to all Providers if blank. See DTOReference |
description | string | false | The description of RetentionPolicy |
name | string | false | [REQUIRED] The name of the RetentionPolicy |
is_delete_physical_assest_only | boolean | false | Shows if RetentionPolicy should delete physical assest only |
days_towait | int | false | Shows the number of days for RetentionPolicy to make the action. Default value for POST operations: 0 |
create_date | Date | false | [READ_ONLY] The creation date of RetentionPolicy |
uuid | string | false | [READ_ONLY] The uuid of the RetentionPolicy |
Type SaveClassificationDTO
JSON object description
name | type | required | description |
---|---|---|---|
action | string | true | [REQUIRED] |
classification_start_date | Date | true | [REQUIRED_for_CREATE,UPDATE] Start date of classification attribute |
classification_uuid | string | true | [REQUIRED] The current Bundle uuid representing the classification |
is_adult_rating | boolean | false | [REQUIRED_for_CREATE,UPDATE] Shows value of ClassificationAttribute.isAdultRating |
image_infos | Array[DTOImageInfoSave] | false | A list of images of the Classification Bundle, they all Physical Asset Images under the Images folder |
asset_associations | Array[DTOAssociationSave] | false | A list of objects representing program/collection associations for the classification node |
classification_custom_attributes | Array[DTOClassificationCustomAttributeSave] | false | List of DTOClassificationCustomAttribute with action field |
classification_nodes | Array[DTOClassificationNodeDetailsSave] | false | The list of Classification Nodes to Create/Update/Delete |
classification_id | string | false | The current Bundle ciid |
usage_type | string | false | [REQUIRED_for_CREATE,UPDATE] Enumerated value |
classification_type_ref | DTOReference | false | Reference to ClassificationAttribute.classificationType |
classification_end_date | Date | true | [REQUIRED_for_CREATE,UPDATE] End date of classification attribute |
metadatas | Array[DTOMetadataClassificationSave] | false | A 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
name | type | required | description |
---|---|---|---|
action | string | true | [REQUIRED] |
classification_associations | Array[DTOAssociationSave] | false | List of Associations Collection to Classification |
image_infos | Array[DTOImageInfoSave] | false | A list of Physical Asset Images for the Collection |
asset_associations | Array[DTOAssociationSave] | false | List of Associations child Collection/Program to Collection |
licensing_windows | Array[DTOLicensingWindowSave] | false | A list of Licensing Windows for the Collection |
offer_windows | Array[DTOOfferWindowSave] | false | [REQUIRED_for_CREATE] A list of Offer Windows for the Collection |
metadatas | Array[DTOAssetMetadataSave] | true | [REQUIRED_for_CREATE] A list of Metadatas for the Collection |
provider_ref | DTOReference | true | [REQUIRED_for_CREATE,UPDATE] Reference to provider |
availability_windows | Array[DTOAvailabilityWindowSave] | false | A list of Availability Windows for the Collection |
collection_type_ref | DTOReference | true | [REQUIRED_for_CREATE][READ_ONLY_AFTER_CREATION] Reference to the Bundle template representing the Collection type |
collection_uuid | string | true | [REQUIRED] The current Bundle uuid representing the Collection |
Type SaveProgramDTO
JSON object description
name | type | required | description |
---|---|---|---|
action | string | true | [REQUIRED] |
classification_associations | Array[DTOAssociationSave] | false | A list of objects representing classification associations |
program_uuid | string | true | [REQUIRED] The current Bundle uuid representing the program |
Type SearchConfigDataDTO
JSON object description
name | type | required | description |
---|---|---|---|
indexed_data | string | false | The String representation of the additional search config data, if it needs to be indexed |
is_default | boolean | false | This is for specifying weather the search configuration is the default |
last_modified_date | Date | false | [READ_ONLY] The last modified date of the SearchConfigData |
type | string | true | [REQUIRED][READ_ONLY_AFTER_CREATION] The type of the SearchConfigData |
data | string | false | The String representation of the search config data |
user | string | true | [REQUIRED][READ_ONLY_AFTER_CREATION] The user that the SearchConfigData belongs to |
create_date | Date | false | [READ_ONLY] The create date of the SearchConfigData |
uuid | string | false | [READ_ONLY] The UUID of the SearchConfigData |
Type SimpleSearchDTO
JSON object description
name | type | required | description |
---|---|---|---|
producer | Set | false | The names of the producers |
director | Set | false | The names of the directors |
type | string | false | The name of the Bundle classification type |
actor | Set | false | The names of the actors |
sort_field | DTOSortField | false | The sort field object that defines sorting for search result |
rating | Set | false | The ratings of the Bundle |
search_term | string | false | The term for the search |
collection | Set | false | The collections that current Bundle is associated with |
name | string | false | The name of the Bundle |
usage_type | Set | false | The usage type of the Bundle |
types | Set | false | [REQUIRED] The Bundle classification type list |
provider | string | false | The name of the provider |
classification | Set | false | The classifications that the current Bundle is associated with |
locale | string | false | The locale of the localized metadata or common entity to search by |
exclude_uuids | Set | false | The list of uuids that should be excluded from result |
end_date | Date | false | The end date filter |
studio_code | string | false | The studio codes of the Bundle |
format | Set | false | The formats of the Bundle |
start_date | Date | false | The start date filter |
catalog | Set | false | The catalogs that the current Bundle is associated with |
genre | Set | false | The genres of the Bundle |
uuid | string | false | The UUID of the Bundle |
Type Sorting
JSON object description
name | type | required | description |
---|---|---|---|
field_name | string | false | [REQUIRED] The name of the field to sort by |
ascending | boolean | false | [REQUIRED] The order of sorting |
Type SpreadsheetIngestionDTO
JSON object description
name | type | required | description |
---|---|---|---|
encoded_data | string | false | [REQUIRED] The uploaded file data encoded to String object using Base64 encode scheme |
filename | string | false | [REQUIRED] The name of the uploaded file with extension. Only XLS and XLSX File Types are supported |
uuid | string | false | |
destination | string | false | [REQUIRED] The destination for the uploaded file. Should consist of Repository Node name + relative path to the destination folder |
Type StaticAttributeListDTO
JSON object description
name | type | required | description |
---|---|---|---|
static_attribute_type | string | false | The type of the static attribute |
static_attribute_list | Set | false | The list of static attributes |
uuid | string | false |
Type SubscriptionCodeDTO
JSON object description
name | type | required | description |
---|---|---|---|
bundles | Set | false | [READ_ONLY] The references to Bundles |
description | string | false | The description of the Subscription Code |
code | string | false | [REQUIRED]The Subscription Code. Number must be unique |
name | string | true | [REQUIRED]The name of the SubscriptionCode |
uuid | string | false | [READ_ONLY] The UUID of the SubscriptionCode |
Type UrlSignerConfigurationDTO
JSON object description
name | type | required | description |
---|---|---|---|
is_active | boolean | false | [READ_ONLY] Shows if URL Signer Configuration is active. Default value is FALSE |
url_signer_settings | UrlSignerSettingsDTO | false | [REQUIRED] The URL Signer Settings for composing XML settings of the URL Signer Configuration |
url_signer_ref | DTOReference | false | [REQUIRED] The reference to the URL Signer of the URL Signer Configuration |
last_modified | Date | false | [READ_ONLY] The last modified date of the URL Signer Configuration |
is_enabled | boolean | false | Shows if URL Signer Configuration is enabled. Default value is TRUE |
name | string | false | [REQUIRED] The name of the URL Signer Configuration |
uuid | string | false | [READ_ONLY] The UUID of the URL Signer Configuration |
Type UrlSignerDTO
JSON object description
name | type | required | description |
---|---|---|---|
description | string | false | [READ_ONLY] The description of the URL Signer |
name | string | false | [READ_ONLY] The name of the URL Signer |
uuid | string | false | [READ_ONLY] The UUID of the URL Signer |
Type UrlSignerSettingsDTO
JSON object description
name | type | required | description |
---|---|---|---|
key | string | false | The Key of the URL Signer Settings |
include_client_ip | boolean | false | Shows if Client IP is included for the URL Signer Settings |
key_id_owner | int | false | [REQUIRED] The Key ID Owner of the URL Signer Settings. Allowed range from 1 to 32 |
key_id_number | int | false | [REQUIRED] The Key ID Number of the URL Signer Settings. Allowed range from 1 to 16 |
expiry_delay_seconds | int | false | The Expiry Delay Seconds of the URL Signer Settings |
private_key | string | false | [REQUIRED if 'url_signer_ref' references 'CDS Public Key'] The Private Key of the URL Signer Settings |
Type ViewAssetADIDTO
JSON object description
name | type | required | description |
---|---|---|---|
component_uuid | string | false | [READ_ONLY] The UUID of the Asset |
source_xml | string | false | [READ_ONLY] The source XML (the ADI that is used to create the Asset) |
Type XlsParserConfigDTO
JSON object description
name | type | required | description |
---|---|---|---|
is_active | boolean | false | [REQUIRED] Shows if XLS Parser Configuration is active |
last_modified_date | Date | false | [READ_ONLY] The last modified date of XLS Parser Configuration |
default_locale_ref | DTOReference | false | [REQUIRED] The reference to Default Locale of the XLS Parser Configuration |
name | string | true | [REQUIRED] The name of XLS Parser Configuration. Should be unique |
xml_configuration | string | false | The specific XML Configuration for XLS Parser |
bundle_type_ref | DTOReference | true | [REQUIRED] The reference to BundleTemplate |
uuid | string | false | [READ_ONLY] The uuid of the XLS Parser Configuration |