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/ContentProcessor/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/workflow/v1/dynamicqueue/{uuid}/action
- /api/workflow/v1/triggertype
- /api/workflow/v1/triggertype/{uuid}
- /api/workflow/v1/action/profile/activation
- /api/workflow/v1/action/profile/{uuid}/activation
- /api/workflow/v1/extension
- /api/workflow/v1/extension/{extension}
- /api/workflow/v1/extension/{uuid}
- /api/workflow/v1/action/template/activation
- /api/workflow/v1/action/template/{uuid}/activation
- /api/filehandling/v1/repository/node/{repository_node_uuid}/treenode
- /api/workflow/v1/action/profile
- /api/workflow/v1/action/profile/{uuid}
- /api/workflow/v1/action/template
- /api/workflow/v1/action/template/{uuid}
- /api/workflow/v1/dynamicqueue
- /api/workflow/v1/dynamicqueue/{uuid}
- /api/filehandling/v1/repository/node
- /api/filehandling/v1/repository/node/{uuid}
- /api/filehandling/v1/repository/node/hotfolder/activation
- /api/filehandling/v1/repository/node/hotfolder/{uuid}/activation
- /api/workflow/v1/trigger
- /api/workflow/v1/triggertype/{uuid}
- /api/workflow/v1/trigger/{uuid}
- /api/filehandling/v1/repository/node/hotfolder
- /api/filehandling/v1/repository/node/hotfolder/{uuid}
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
- ActionProfileActivationDTO
- ActionProfileDTO
- ActionTemplateActivationDTO
- ActionTemplateDTO
- Auth
- DTOReference
- DynamicQueueEntryActionDTO
- DynamicQueueEntryDTO
- EventItemDTO
- ExtensionMappingDTO
- FilesystemTreeNodeDTO
- HotfolderActivationDTO
- HotfolderDTO
- HotfolderUpdateSetting
- HttpWokflowTriggerSetting
- ProductSetting
- RepositoryNodeDTO
- ScheduleSetting
- WorkflowSetting
- WorkflowTriggerEventDTO
- WorkflowTriggerEventTypeDTO
/api/workflow/v1/dynamicqueue/{uuid}/action
- Mount point: /api/workflow/v1/dynamicqueue/{uuid}/action
The following operations are supported on this resource:
PUT
This method is used to perform Action operations with DynamicQueueEntries.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the Dynamic Queue Entry. REQUIRED for RETRY_COUNT action | path | |
search | Search term must have next structure: fieldName:value;anotherFieldName:value;... Allowable field names: method, batchSize, retryCount, statusFilter, typeFilter, deleteAfterProcess, newStatus | query |
Input Payload
element | consumeable content type(s) |
---|---|
DynamicQueueEntryActionDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
DynamicQueueEntryActionDTO | 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 | Operation is not allowed without proper action values |
500 | Request is formed correctly, but server cannot perform entity update. Unexpected error. |
/api/workflow/v1/triggertype
- Mount point: /api/workflow/v1/triggertype
The following operations are supported on this resource:
GET
This method is used to get list of available EventType 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) |
---|---|
WorkflowTriggerEventTypeDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/api/workflow/v1/triggertype/{uuid}
- Mount point: /api/workflow/v1/triggertype/{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) |
---|---|
WorkflowTriggerEventTypeDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
/api/workflow/v1/action/profile/activation
- Mount point: /api/workflow/v1/action/profile/activation
The following operations are supported on this resource:
GET
This method is used to get list of available Action Profile Activation 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) |
---|---|
ActionProfileActivationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/api/workflow/v1/action/profile/{uuid}/activation
- Mount point: /api/workflow/v1/action/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) |
---|---|
ActionProfileActivationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
DELETE
This method is used to perform deactivation of Action 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. |
PUT
This method is used to perform Activation/Deactivation of Action Profile. Note, that UUID in request string must be present. UUID in JSON body must be absent.
Activation of Action Profile runs settingsXML validation.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the Action profile. | path |
Input Payload
element | consumeable content type(s) |
---|---|
ActionProfileActivationDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
ActionProfileActivationDTO | 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/workflow/v1/extension
- Mount point: /api/workflow/v1/extension
The following operations are supported on this resource:
GET
This method is used to get list of available Extension 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) |
---|---|
ExtensionMappingDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
POST
This method is used to create new Extension Mapping. UUID must not be specified for this operation. Request body must contain all required fields.
Input Payload
element | consumeable content type(s) |
---|---|
ExtensionMappingDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
ExtensionMappingDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Create operation passed successfully. |
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 creation. Unexpected error. |
/api/workflow/v1/extension/{extension}
- Mount point: /api/workflow/v1/extension/{extension}
The following operations are supported on this resource:
GET
This method is used to get a specific instance of the DTO by given extension.
URL Parameters
name | description | type | default |
---|---|---|---|
extension | The extension of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
ExtensionMappingDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
/api/workflow/v1/extension/{uuid}
- Mount point: /api/workflow/v1/extension/{uuid}
The following operations are supported on this resource:
DELETE
This method is used to delete an Extension Mapping.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT. Extension mapping was successfully deleted. |
404 | NOT FOUND. Extension mapping with provided uuid was not found. |
PUT
This method is used to perform update or partial update of Extension Mapping. 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 the Extension Mapping. | path |
Input Payload
element | consumeable content type(s) |
---|---|
ExtensionMappingDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
ExtensionMappingDTO | 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/workflow/v1/action/template/activation
- Mount point: /api/workflow/v1/action/template/activation
The following operations are supported on this resource:
GET
This method is used to get list of available Action Template Activation 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) |
---|---|
ActionTemplateActivationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/api/workflow/v1/action/template/{uuid}/activation
- Mount point: /api/workflow/v1/action/template/{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) |
---|---|
ActionTemplateActivationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
DELETE
This method is used to perform deactivation of Action Template.
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. |
PUT
This method is used to perform Activation/Deactivation of Action Template. Note, that UUID in request string must be present. UUID in JSON body must be absent.
Activation of Action Template runs settingsXML validation.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the Action template. | path |
Input Payload
element | consumeable content type(s) |
---|---|
ActionTemplateActivationDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
ActionTemplateActivationDTO | 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/filehandling/v1/repository/node/{repository_node_uuid}/treenode
- Mount point: /api/filehandling/v1/repository/node/{repository_node_uuid}/treenode
The following operations are supported on this resource:
PUT
This method is used to expand Repository Node File System tree step by step. Note, that Repository Node UUID in request string must be present. UUID in JSON body may be absent.
This method returns direct children of the tree node for the corresponding URI path.
URL Parameters
name | description | type | default |
---|---|---|---|
repository_node_uuid | The uuid of the Repository Node. | path |
Input Payload
element | consumeable content type(s) |
---|---|
FilesystemTreeNodeDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
FilesystemTreeNodeDTO | 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/workflow/v1/action/profile
- Mount point: /api/workflow/v1/action/profile
The following operations are supported on this resource:
GET
This method is used to get list of available Action 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) |
---|---|
ActionProfileDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
POST
This method is used to create new Action Profile. UUID must not be specified for this operation. Request body must contain all required fields.
Input Payload
element | consumeable content type(s) |
---|---|
ActionProfileDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
ActionProfileDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Create operation passed successfully. |
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 creation. Unexpected error. |
/api/workflow/v1/action/profile/{uuid}
- Mount point: /api/workflow/v1/action/profile/{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) |
---|---|
ActionProfileDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
DELETE
This method is used to delete Action Profile. UUID must be specified for this operation.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT. Action Profile was successfully deleted. |
400 | Action Profile can not be removed since it is used by other Workflow Definitions. |
404 | NOT FOUND. Action Profile with provided id was not found. |
PUT
This method is used to perform update or partial update of Action 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, action_template_ref is read-only-after-creation and must not be provided.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the Action profile. | path |
Input Payload
element | consumeable content type(s) |
---|---|
ActionProfileDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
ActionProfileDTO | 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/workflow/v1/action/template
- Mount point: /api/workflow/v1/action/template
The following operations are supported on this resource:
GET
This method is used to get list of available Action 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) |
---|---|
ActionTemplateDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
POST
This method is used to create new Action Template.
Input Payload
element | consumeable content type(s) |
---|---|
ActionTemplateDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
ActionTemplateDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Create operation passed successfully. |
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 creation. Unexpected error. |
/api/workflow/v1/action/template/{uuid}
- Mount point: /api/workflow/v1/action/template/{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) |
---|---|
ActionTemplateDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
DELETE
This method is used to delete Action Template. UUID must be specified for this operation.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT. Action Template was successfully deleted. |
400 | Action Template can not be removed since it is used by other Action Profiles. |
404 | NOT FOUND. Action Template with provided id was not found. |
PUT
This method is used to perform update and partial update of the Action Template.
Note that esb_service, esb_category are read-only-after-creation, must not be present in the request body in PUT operation.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the Action template. | path |
Input Payload
element | consumeable content type(s) |
---|---|
ActionTemplateDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
ActionTemplateDTO | 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/workflow/v1/dynamicqueue
- Mount point: /api/workflow/v1/dynamicqueue
The following operations are supported on this resource:
GET
This method is used to get list of available DynamicQueueEntry 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) |
---|---|
DynamicQueueEntryDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
POST
This method is used to create new DynamicQueueEntry. UUID must not be specified for this operation. Request body must contain all required fields.
Input Payload
element | consumeable content type(s) |
---|---|
DynamicQueueEntryDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
DynamicQueueEntryDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Create operation passed successfully. |
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 creation. Unexpected error. |
/api/workflow/v1/dynamicqueue/{uuid}
- Mount point: /api/workflow/v1/dynamicqueue/{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) |
---|---|
DynamicQueueEntryDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
DELETE
This method is used to delete an DynamicQueueEntry.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT. DynamicQueueEntry was successfully deleted. |
404 | NOT FOUND. DynamicQueueEntry with provided uuid was not found. |
PUT
This method is used to perform update or partial update of DynamicQueueEntry. 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 the DynamicQueueEntry. | path |
Input Payload
element | consumeable content type(s) |
---|---|
DynamicQueueEntryDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
DynamicQueueEntryDTO | 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/filehandling/v1/repository/node
- Mount point: /api/filehandling/v1/repository/node
The following operations are supported on this resource:
GET
This method is used to get list of available Repository Node 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) |
---|---|
RepositoryNodeDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
POST
This method is used to create new Repository Node. UUID must not be specified for this operation. Request body must contain all required fields.
Input Payload
element | consumeable content type(s) |
---|---|
RepositoryNodeDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
RepositoryNodeDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Create operation passed successfully. |
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 creation. Unexpected error. |
/api/filehandling/v1/repository/node/{uuid}
- Mount point: /api/filehandling/v1/repository/node/{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) |
---|---|
RepositoryNodeDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
DELETE
This method is used for Repository Node deletion 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. Entity was deleted. |
404 | NOT FOUND. Entity with provided UUID was not found. |
PUT
This method is used to perform update and partial update of the Repository Node. 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 the Repository Node. | path |
Input Payload
element | consumeable content type(s) |
---|---|
RepositoryNodeDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
RepositoryNodeDTO | 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/filehandling/v1/repository/node/hotfolder/activation
- Mount point: /api/filehandling/v1/repository/node/hotfolder/activation
The following operations are supported on this resource:
GET
This method is used to get list of available Hotfolder Activation 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) |
---|---|
HotfolderActivationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/api/filehandling/v1/repository/node/hotfolder/{uuid}/activation
- Mount point: /api/filehandling/v1/repository/node/hotfolder/{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) |
---|---|
HotfolderActivationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
DELETE
This method is used to perform deactivation of Hotfolder.
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. |
PUT
This method is used to perform Activation/Deactivation of Hotfolder. 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 Hotfolder. | path |
Input Payload
element | consumeable content type(s) |
---|---|
HotfolderActivationDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
HotfolderActivationDTO | 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. |
/api/workflow/v1/trigger
- Mount point: /api/workflow/v1/trigger
The following operations are supported on this resource:
GET
This method is used to get list of available Workflow Trigger Event 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) |
---|---|
WorkflowTriggerEventDTO | application/json |
Response Codes
code | reason |
---|
POST
This method is used to create new Workflow Trigger Event. UUID must not be specified for this operation. Request body must contain all required fields.
Input Payload
element | consumeable content type(s) |
---|---|
WorkflowTriggerEventDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
WorkflowTriggerEventDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Create operation passed successfully. |
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/workflow/v1/triggertype/{uuid}
- Mount point: /api/workflow/v1/triggertype/{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) |
---|---|
WorkflowTriggerEventDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
/api/workflow/v1/trigger/{uuid}
- Mount point: /api/workflow/v1/trigger/{uuid}
The following operations are supported on this resource:
DELETE
This method is used to delete WorkflowTriggerEvent 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. Entity was deleted. |
404 | NOT FOUND. Entity with provided UUID was not found. |
PUT
This method is used to update WorkflowTriggerEvent. 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 Workflow Trigger Event. | path |
Input Payload
element | consumeable content type(s) |
---|---|
WorkflowTriggerEventDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
WorkflowTriggerEventDTO | 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/filehandling/v1/repository/node/hotfolder
- Mount point: /api/filehandling/v1/repository/node/hotfolder
The following operations are supported on this resource:
GET
This method is used to get list of available Hotfolder 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) |
---|---|
HotfolderDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
POST
This method is used to create new Hotfolder. UUID must not be specified for this operation. Request body must contain all required fields.
Input Payload
element | consumeable content type(s) |
---|---|
HotfolderDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
HotfolderDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Create operation passed successfully. |
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 creation. Unexpected error. |
/api/filehandling/v1/repository/node/hotfolder/{uuid}
- Mount point: /api/filehandling/v1/repository/node/hotfolder/{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) |
---|---|
HotfolderDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
DELETE
This method is used to delete the Hotfolder 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. Entity was deleted. |
404 | NOT FOUND. Entity with provided UUID was not found. |
PUT
This method is used to perform update or partial update of the Hotfolder. 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 the Hot folder. | path |
Input Payload
element | consumeable content type(s) |
---|---|
HotfolderDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
HotfolderDTO | 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. |
Type ActionProfileActivationDTO
JSON object description
name | type | required | description |
---|---|---|---|
is_active | boolean | true | [REQUIRED] Shows if Action Profile is active |
uuid | string | false | [READ_ONLY] The UUID of the Action Profile |
Type ActionProfileDTO
JSON object description
name | type | required | description |
---|---|---|---|
is_active | boolean | false | [READ_ONLY] Shows if Action Profile is active |
settings_xml | string | false | The specific XML settings for Action Profile. More details are described in offline REST API documentation |
last_modified_date | Date | false | [READ_ONLY] The last modified date of Action Profile |
description | string | false | The description of Action Profile |
name | string | true | [REQUIRED] The name of Action Profile. Unique |
modified_by | string | false | [READ_ONLY] The user login who did last modification of the Action Profile |
action_template_ref | DTOReference | true | [REQUIRED][READ_ONLY_AFTER_CREATION] The reference to Action Template DTO, as Action Template is part of Action Profile |
uuid | string | false | [READ ONLY] The UUID of the Action Profile |
Type ActionTemplateActivationDTO
JSON object description
name | type | required | description |
---|---|---|---|
is_active | boolean | true | [REQUIRED] Shows if Action Template is active |
uuid | string | false | [READ_ONLY] The UUID of the Action Template |
Type ActionTemplateDTO
JSON object description
name | type | required | description |
---|---|---|---|
is_active | boolean | false | [READ_ONLY] Shows if the Action Template is active |
esb_category | string | true | [REQUIRED][READ_ONLY_AFTER_CREATION] The name of the ESB Category associated with the ESB Service |
esb_service | string | true | [REQUIRED][READ_ONLY_AFTER_CREATION] The name of the ESB Service |
description | string | false | The description of Action Template |
name | string | true | [REQUIRED] The name of the Action Template |
configuration_xml | string | false | Action Template's XML configuration string. String depends on Template type and may be empty for some types. More details are described in offline REST API documetation |
uuid | string | false | [READ_ONLY] The UUID of the Action Template |
Type Auth
JSON object description
name | type | required | description |
---|---|---|---|
user_name | string | false | The username that has credentials for access to this node |
domain | string | false | The node's domain |
password | string | false | The password to access to this node |
private_key | string | false | The private key for this node |
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 DynamicQueueEntryActionDTO
JSON object description
name | type | required | description |
---|---|---|---|
action | string | false | [REQUIRED] Action |
entry_dtos | Array[DynamicQueueEntryDTO] | false | list of suitable DynamicQueueEntryDTO objects, may include single item or even be empty depending on action |
uuid | string | false |
Type DynamicQueueEntryDTO
JSON object description
name | type | required | description |
---|---|---|---|
lock_date | Date | false | [READ_ONLY] The Date when the Queue Entry was Locked |
indexed_data | string | false | The indexed data which can be used easily for locating a set of entities if required |
sort_integer | int | false | The Sort Integer is inserted by custom plugin. We can decide to sort by this integer |
last_modified_date | Date | false | [READ_ONLY] The Last modified date of the current entry |
type | string | false | [REQUIRED] The identifier to depict which Queue |
data | string | false | The Data of the queue entry. We can store anything such as JSON or XML. Encoded in Base64 string |
retry_count | int | false | [READ_ONLY] Number of times entry tried to be processed |
content_id | string | false | [REQUIRED] The identifier of the Queue Entry within the same type |
priority | int | false | [REQUIRED] Min = 1, Max = 10. The priority of the entry |
status | string | false | The Status of the current entry. Default value is 'NEW' |
create_date | Date | false | [READ_ONLY] The Date the Queue Entry is Created |
uuid | string | false | [READ_ONLY] The UUID of the Dynamic Queue Entry |
Type EventItemDTO
JSON object description
name | type | required | description |
---|---|---|---|
value | string | false | [READ_ONLY] The value which will be used for processing |
user_text | string | false | [READ_ONLY] The Text which will be shown user for select |
Type ExtensionMappingDTO
JSON object description
name | type | required | description |
---|---|---|---|
mime_type | string | true | [REQUIRED] The mime type for extension |
extension | string | true | [REQUIRED] The extension of Extension Mapping. Unique |
physical_asset_type | string | true | [REQUIRED] The physical asset type for extension |
uuid | string | false | [READ_ONLY] The uuid of the ExtensionMapping |
Type FilesystemTreeNodeDTO
JSON object description
name | type | required | description |
---|---|---|---|
full_path | string | false | [READ_ONLY] The full path to a File System folder |
child_nodes | Set | false | [READ_ONLY] The child nodes of the current one |
repository_node_uuid | string | false | [READ_ONLY] The uuid of the Repository Node |
path | string | false | The URI path to a File System folder that we want to expand. In order to expand a root folder leave this field empty |
Type HotfolderActivationDTO
JSON object description
name | type | required | description |
---|---|---|---|
is_active | boolean | true | [REQUIRED] Activation Status of Hotfolder |
uuid | string | false | [READ_ONLY]. The UUID of the Hotfolder |
Type HotfolderDTO
JSON object description
name | type | required | description |
---|---|---|---|
process_subfolders | boolean | false | Process subfolders in hotfolder |
is_active | boolean | false | [READ-ONLY] If the Hotfolder is active |
last_modified_date | Date | false | [READ_ONLY] The last modified date of Hotfolder |
last_scan_date | Date | false | The hotfolder last scan date |
description | string | false | The description of the Hotfolder |
scanner_filter_filename | string | false | The filename that should be excluded for scanner to process |
name | string | true | [REQUIRED] The name of the Hotfolder |
priority | int | false | Priority of workflow execution order. min=1, max=10. If omitted in JSON, default value will be set from Admin Config |
repository_node_ref | DTOReference | true | [REQUIRED] The reference on Repository Node object |
exclude_filename | string | false | The filename that should be excluded to trigger workflow instance |
root_path | string | false | [READ_ONLY_AFTER_CREATION] The relative path, should start from '/' and point to existing path of chosen Node. If omitted, default value '/' is set |
uuid | string | false | [READ_ONLY] The uuid of the Hotfolder |
Type HotfolderUpdateSetting
JSON object description
name | type | required | description |
---|---|---|---|
updatable | boolean | true | [REQUIRED] Shows that update operation is supported for generation of event |
hotfolder_ref | DTOReference | true | [REQUIRED] Reference to Hotfolder which updating is used for event |
update_path_type | string | false | Type of path update. It is mandatory if updatable=true |
Type HttpWokflowTriggerSetting
JSON object description
name | type | required | description |
---|---|---|---|
trigger_option_name | string | true | [REQUIRED] The option name of workflow trigger. Trigger option name should be value that is provided by WorkflowTriggerEventTypeDTO.event_type_options. Perform GET operation for WorkflowTriggerEventTypeDTO to get allowable value |
trigger_option_value | string | true | [REQUIRED] The workflow trigger option value |
Type ProductSetting
JSON object description
name | type | required | description |
---|---|---|---|
option | string | true | [REQUIRED] Option for Product event. Option should be one of values which are provided by WorkflowTriggerEventTypeDTO.event_type_options. Perform GET operation for WorkflowTriggerEventTypeDTO and put into 'option' one of values. Value should correspond event_type |
Type RepositoryNodeDTO
JSON object description
name | type | required | description |
---|---|---|---|
url | string | false | [REQUIRED] The filesystem URL |
description | string | false | The description of the Repository Node |
name | string | true | [REQIURED] The name of the Repository Node |
is_read_only | boolean | false | Determines whether repository node should be read-only or not. Dafault value is 'false' |
auth | Auth | false | Credentials, required to connect by given URL |
uuid | string | false | [READ_ONLY] The uuid of the Repository Node |
Type ScheduleSetting
JSON object description
name | type | required | description |
---|---|---|---|
interval_type | string | true | [REQUIRED] Shows what interval type is used for generation of event. Interval_type should be one of values which are provided by WorkflowTriggerEventTypeDTO.event_type_options. Perform GET operation for WorkflowTriggerEventTypeDTO and put into 'interval_type' one of values. Value should correspond event_type |
cron_expression | string | true | [REQUIRED] Contains plain cron expression for raising event |
Type WorkflowSetting
JSON object description
name | type | required | description |
---|---|---|---|
workflow_ref | DTOReference | true | [REQUIRED] Reference to workflow from which it depends on |
Type WorkflowTriggerEventDTO
JSON object description
name | type | required | description |
---|---|---|---|
is_active | boolean | false | [READ_ONLY] Shows if Workflow Trigger Event Type is active |
hotfolder_update_setting | HotfolderUpdateSetting | false | [REQUIRED if eventType='HotFolderNewContent'] Settings for HotFolder eventType. Must be absent for another eventtypes |
workflow_definition_ref | DTOReference | false | [READ_ONLY_AFTER_CREATION] WorkflowDefinition to which event belongs |
product_setting | ProductSetting | false | [REQUIRED if eventType='ProductUpdate'|'ProductCreate'] Settings for product eventType. Must be absent for another eventtypes |
workflow_setting | WorkflowSetting | false | [REQUIRED if eventType='Workflow'] Settings for workflow eventType. Must be absent for another eventtypes |
http_workflow_trigger_setting | HttpWokflowTriggerSetting | false | [REQUIRED if eventType='HTTPWokflowTrigger'] Settings for http workflow trigger eventType. Must be absent for another eventtypes |
event_type | DTOReference | false | [REQUIRED][READ_ONLY_AFTER_CREATION] Workflow Event Type which is base for Event |
schedule_setting | ScheduleSetting | false | [REQUIRED if eventType='ScheduledInterval'] Settings for Schedule eventType. Must be absent for another eventtypes |
uuid | string | false | [READ_ONLY] The UUID of the Workflow Trigger Event |
Type WorkflowTriggerEventTypeDTO
JSON object description
name | type | required | description |
---|---|---|---|
is_active | boolean | false | [READ_ONLY] Shows if Workflow Trigger Event Type is active |
data_class | string | false | [READ_ONLY] The data class of Workflow Trigger Event Type |
description | string | false | [READ_ONLY] The description of Workflow Trigger Event Type |
name | string | false | [READ_ONLY] The name of the Workflow Trigger Event Type |
event_type_options | Array[EventItemDTO] | false | [READ_ONLY] The list of allowed values for setting for this EventType |
uuid | string | false | [READ_ONLY] The UUID of the Workflow Trigger Event Type |