REST Endpoints

JSON Data Types

Searching parameters

Introduction


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

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

/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
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
ActionProfileDTO application/json

Response Codes

code reason
200OK

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)
ActionProfileDTOapplication/json

Output Payload

element produceable content type(s)
ActionProfileDTO application/json

Response Codes

code reason
201Create operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is present in request path.
500Request is formed correctly, but server cannot perform entity 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
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
ActionProfileDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

DELETE

This method is used to delete Action Profile. UUID must be specified for this operation.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT. Action Profile was successfully deleted.
400Action Profile can not be removed since it is used by other Workflow Definitions.
404NOT 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
uuidThe uuid of the Action profile.path

Input Payload

element consumeable content type(s)
ActionProfileDTOapplication/json

Output Payload

element produceable content type(s)
ActionProfileDTO application/json

Response Codes

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

/api/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
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
WorkflowTriggerEventTypeDTO application/json

Response Codes

code reason
200OK

/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
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
WorkflowTriggerEventTypeDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/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
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
RepositoryNodeDTO application/json

Response Codes

code reason
200OK

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)
RepositoryNodeDTOapplication/json

Output Payload

element produceable content type(s)
RepositoryNodeDTO application/json

Response Codes

code reason
201Create operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is present in request path.
500Request is formed correctly, but server cannot perform entity 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
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
RepositoryNodeDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

DELETE

This method is used for Repository Node deletion by given UUID.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT. Entity was deleted.
404NOT 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
uuidThe uuid of the Repository Node.path

Input Payload

element consumeable content type(s)
RepositoryNodeDTOapplication/json

Output Payload

element produceable content type(s)
RepositoryNodeDTO application/json

Response Codes

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

/api/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
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
DynamicQueueEntryDTO application/json

Response Codes

code reason
200OK

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)
DynamicQueueEntryDTOapplication/json

Output Payload

element produceable content type(s)
DynamicQueueEntryDTO application/json

Response Codes

code reason
201Create operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is present in request path.
500Request is formed correctly, but server cannot perform entity 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
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
DynamicQueueEntryDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

DELETE

This method is used to delete an DynamicQueueEntry.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT. DynamicQueueEntry was successfully deleted.
404NOT 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
uuidThe uuid of the DynamicQueueEntry.path

Input Payload

element consumeable content type(s)
DynamicQueueEntryDTOapplication/json

Output Payload

element produceable content type(s)
DynamicQueueEntryDTO application/json

Response Codes

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

/api/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
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
ActionProfileActivationDTO application/json

Response Codes

code reason
200OK

/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
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
ActionProfileActivationDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

DELETE

This method is used to perform deactivation of Action Profile.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

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

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
uuidThe uuid of the Action profile.path

Input Payload

element consumeable content type(s)
ActionProfileActivationDTOapplication/json

Output Payload

element produceable content type(s)
ActionProfileActivationDTO application/json

Response Codes

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

/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
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
ExtensionMappingDTO application/json

Response Codes

code reason
200OK

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)
ExtensionMappingDTOapplication/json

Output Payload

element produceable content type(s)
ExtensionMappingDTO application/json

Response Codes

code reason
201Create operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is present in request path.
500Request is formed correctly, but server cannot perform entity 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
extensionThe extension of the object.path

Output Payload

element produceable content type(s)
ExtensionMappingDTO application/json

Response Codes

code reason
200OK
404NOT 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
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT. Extension mapping was successfully deleted.
404NOT 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
uuidThe uuid of the Extension Mapping.path

Input Payload

element consumeable content type(s)
ExtensionMappingDTOapplication/json

Output Payload

element produceable content type(s)
ExtensionMappingDTO application/json

Response Codes

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

/api/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
searchSearchquery
sortSortquery
paginationPaginationquery

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)
WorkflowTriggerEventDTOapplication/json

Output Payload

element produceable content type(s)
WorkflowTriggerEventDTO application/json

Response Codes

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

/api/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
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
WorkflowTriggerEventDTO application/json

Response Codes

code reason
200OK
404NOT 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
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT. Entity was deleted.
404NOT 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
uuidThe uuid of Workflow Trigger Event.path

Input Payload

element consumeable content type(s)
WorkflowTriggerEventDTOapplication/json

Output Payload

element produceable content type(s)
WorkflowTriggerEventDTO application/json

Response Codes

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

/api/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
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
ActionTemplateActivationDTO application/json

Response Codes

code reason
200OK

/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
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
ActionTemplateActivationDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

DELETE

This method is used to perform deactivation of Action Template.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

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

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
uuidThe uuid of the Action template.path

Input Payload

element consumeable content type(s)
ActionTemplateActivationDTOapplication/json

Output Payload

element produceable content type(s)
ActionTemplateActivationDTO application/json

Response Codes

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

/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
uuidThe uuid of the Dynamic Queue Entry. REQUIRED for RETRY_COUNT actionpath
searchSearch term must have next structure: fieldName:value;anotherFieldName:value;... Allowable field names: method, batchSize, retryCount, statusFilter, typeFilter, deleteAfterProcess, newStatusquery

Input Payload

element consumeable content type(s)
DynamicQueueEntryActionDTOapplication/json

Output Payload

element produceable content type(s)
DynamicQueueEntryActionDTO application/json

Response Codes

code reason
200Request is formed correctly, operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404UUID from request is not found in DB.
405Operation is not allowed without proper action values
500Request 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
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
HotfolderActivationDTO application/json

Response Codes

code reason
200OK

/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
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
HotfolderActivationDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

DELETE

This method is used to perform deactivation of Hotfolder.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

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

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
uuidThe uuid of the Hotfolder.path

Input Payload

element consumeable content type(s)
HotfolderActivationDTOapplication/json

Output Payload

element produceable content type(s)
HotfolderActivationDTO application/json

Response Codes

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

/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
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
HotfolderDTO application/json

Response Codes

code reason
200OK

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)
HotfolderDTOapplication/json

Output Payload

element produceable content type(s)
HotfolderDTO application/json

Response Codes

code reason
201Create operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is present in request path.
500Request is formed correctly, but server cannot perform entity 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
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
HotfolderDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

DELETE

This method is used to delete the Hotfolder by given UUID.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT. Entity was deleted.
404NOT 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
uuidThe uuid of the Hot folder.path

Input Payload

element consumeable content type(s)
HotfolderDTOapplication/json

Output Payload

element produceable content type(s)
HotfolderDTO application/json

Response Codes

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

/api/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
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
ActionTemplateDTO application/json

Response Codes

code reason
200OK

POST

This method is used to create new Action Template.

Input Payload

element consumeable content type(s)
ActionTemplateDTOapplication/json

Output Payload

element produceable content type(s)
ActionTemplateDTO application/json

Response Codes

code reason
201Create operation passed successfully.
400Error in JSON request, or request didn't pass field validation, or not unique data is provided.
404Request path formed incorrectly and cannot be resolved.
405UUID is present in request path.
500Request is formed correctly, but server cannot perform entity 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
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
ActionTemplateDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

DELETE

This method is used to delete Action Template. UUID must be specified for this operation.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT. Action Template was successfully deleted.
400Action Template can not be removed since it is used by other Action Profiles.
404NOT 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
uuidThe uuid of the Action template.path

Input Payload

element consumeable content type(s)
ActionTemplateDTOapplication/json

Output Payload

element produceable content type(s)
ActionTemplateDTO application/json

Response Codes

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

/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_uuidThe uuid of the Repository Node.path

Input Payload

element consumeable content type(s)
FilesystemTreeNodeDTOapplication/json

Output Payload

element produceable content type(s)
FilesystemTreeNodeDTO application/json

Response Codes

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

Type ActionProfileActivationDTO

JSON object description

nametyperequireddescription
is_activebooleantrue[REQUIRED] Shows if Action Profile is active
uuidstringfalse[READ_ONLY] The UUID of the Action Profile

Type ActionProfileDTO

JSON object description

nametyperequireddescription
is_activebooleanfalse[READ_ONLY] Shows if Action Profile is active
settings_xmlstringfalseThe specific XML settings for Action Profile. More details are described in offline REST API documentation
last_modified_dateDatefalse[READ_ONLY] The last modified date of Action Profile
descriptionstringfalseThe description of Action Profile
namestringtrue[REQUIRED] The name of Action Profile. Unique
modified_bystringfalse[READ_ONLY] The user login who did last modification of the Action Profile
action_template_refDTOReferencetrue[REQUIRED][READ_ONLY_AFTER_CREATION] The reference to Action Template DTO, as Action Template is part of Action Profile
uuidstringfalse[READ ONLY] The UUID of the Action Profile

Type ActionTemplateActivationDTO

JSON object description

nametyperequireddescription
is_activebooleantrue[REQUIRED] Shows if Action Template is active
uuidstringfalse[READ_ONLY] The UUID of the Action Template

Type ActionTemplateDTO

JSON object description

nametyperequireddescription
is_activebooleanfalse[READ_ONLY] Shows if the Action Template is active
esb_categorystringtrue[REQUIRED][READ_ONLY_AFTER_CREATION] The name of the ESB Category associated with the ESB Service
esb_servicestringtrue[REQUIRED][READ_ONLY_AFTER_CREATION] The name of the ESB Service
descriptionstringfalseThe description of Action Template
namestringtrue[REQUIRED] The name of the Action Template
configuration_xmlstringfalseAction 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
uuidstringfalse[READ_ONLY] The UUID of the Action Template

Type Auth

JSON object description

nametyperequireddescription
user_namestringfalseThe username that has credentials for access to this node
domainstringfalseThe node's domain
passwordstringfalseThe password to access to this node
private_keystringfalseThe private key for this node

Type DTOReference

JSON object description

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

Type DynamicQueueEntryActionDTO

JSON object description

nametyperequireddescription
actionstringfalse[REQUIRED] Action
entry_dtosArray[DynamicQueueEntryDTO]falselist of suitable DynamicQueueEntryDTO objects, may include single item or even be empty depending on action
uuidstringfalse

Type DynamicQueueEntryDTO

JSON object description

nametyperequireddescription
lock_dateDatefalse[READ_ONLY] The Date when the Queue Entry was Locked
indexed_datastringfalseThe indexed data which can be used easily for locating a set of entities if required
sort_integerintfalseThe Sort Integer is inserted by custom plugin. We can decide to sort by this integer
last_modified_dateDatefalse[READ_ONLY] The Last modified date of the current entry
typestringfalse[REQUIRED] The identifier to depict which Queue
datastringfalseThe Data of the queue entry. We can store anything such as JSON or XML. Encoded in Base64 string
retry_countintfalse[READ_ONLY] Number of times entry tried to be processed
content_idstringfalse[REQUIRED] The identifier of the Queue Entry within the same type
priorityintfalse[REQUIRED] Min = 1, Max = 10. The priority of the entry
statusstringfalseThe Status of the current entry. Default value is 'NEW'
create_dateDatefalse[READ_ONLY] The Date the Queue Entry is Created
uuidstringfalse[READ_ONLY] The UUID of the Dynamic Queue Entry

Type EventItemDTO

JSON object description

nametyperequireddescription
valuestringfalse[READ_ONLY] The value which will be used for processing
user_textstringfalse[READ_ONLY] The Text which will be shown user for select

Type ExtensionMappingDTO

JSON object description

nametyperequireddescription
mime_typestringtrue[REQUIRED] The mime type for extension
extensionstringtrue[REQUIRED] The extension of Extension Mapping. Unique
physical_asset_typestringtrue[REQUIRED] The physical asset type for extension
uuidstringfalse[READ_ONLY] The uuid of the ExtensionMapping

Type FilesystemTreeNodeDTO

JSON object description

nametyperequireddescription
child_nodesSetfalse[READ_ONLY] The child nodes of the current one
full_pathstringfalse[READ_ONLY] The full path to a File System folder
repository_node_uuidstringfalse[READ_ONLY] The uuid of the Repository Node
pathstringfalseThe 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

nametyperequireddescription
is_activebooleantrue[REQUIRED] Activation Status of Hotfolder
uuidstringfalse[READ_ONLY]. The UUID of the Hotfolder

Type HotfolderDTO

JSON object description

nametyperequireddescription
process_subfoldersbooleanfalseProcess subfolders in hotfolder
is_activebooleanfalse[READ-ONLY] If the Hotfolder is active
last_modified_dateDatefalse[READ_ONLY] The last modified date of Hotfolder
last_scan_dateDatefalseThe hotfolder last scan date
descriptionstringfalseThe description of the Hotfolder
scanner_filter_filenamestringfalseThe filename that should be excluded for scanner to process
namestringtrue[REQUIRED] The name of the Hotfolder
priorityintfalsePriority of workflow execution order. min=1, max=10. If omitted in JSON, default value will be set from Admin Config
repository_node_refDTOReferencetrue[REQUIRED] The reference on Repository Node object
exclude_filenamestringfalseThe filename that should be excluded to trigger workflow instance
root_pathstringfalse[READ_ONLY_AFTER_CREATION] The relative path, should start from '/' and point to existing path of chosen Node. If omitted, default value '/' is set
uuidstringfalse[READ_ONLY] The uuid of the Hotfolder

Type HotfolderUpdateSetting

JSON object description

nametyperequireddescription
updatablebooleantrue[REQUIRED] Shows that update operation is supported for generation of event
hotfolder_refDTOReferencetrue[REQUIRED] Reference to Hotfolder which updating is used for event
update_path_typestringfalseType of path update. It is mandatory if updatable=true

Type HttpWokflowTriggerSetting

JSON object description

nametyperequireddescription
trigger_option_namestringtrue[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_valuestringtrue[REQUIRED] The workflow trigger option value

Type ProductSetting

JSON object description

nametyperequireddescription
optionstringtrue[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

nametyperequireddescription
urlstringfalse[REQUIRED] The filesystem URL
descriptionstringfalseThe description of the Repository Node
namestringtrue[REQIURED] The name of the Repository Node
is_read_onlybooleanfalseDetermines whether repository node should be read-only or not. Dafault value is 'false'
authAuthfalseCredentials, required to connect by given URL
uuidstringfalse[READ_ONLY] The uuid of the Repository Node

Type ScheduleSetting

JSON object description

nametyperequireddescription
interval_typestringtrue[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_expressionstringtrue[REQUIRED] Contains plain cron expression for raising event

Type WorkflowSetting

JSON object description

nametyperequireddescription
workflow_refDTOReferencetrue[REQUIRED] Reference to workflow from which it depends on

Type WorkflowTriggerEventDTO

JSON object description

nametyperequireddescription
is_activebooleanfalse[READ_ONLY] Shows if Workflow Trigger Event Type is active
hotfolder_update_settingHotfolderUpdateSettingfalse[REQUIRED if eventType='HotFolderNewContent'] Settings for HotFolder eventType. Must be absent for another eventtypes
workflow_definition_refDTOReferencefalse[READ_ONLY_AFTER_CREATION] WorkflowDefinition to which event belongs
product_settingProductSettingfalse[REQUIRED if eventType='ProductUpdate'|'ProductCreate'] Settings for product eventType. Must be absent for another eventtypes
workflow_settingWorkflowSettingfalse[REQUIRED if eventType='Workflow'] Settings for workflow eventType. Must be absent for another eventtypes
http_workflow_trigger_settingHttpWokflowTriggerSettingfalse[REQUIRED if eventType='HTTPWokflowTrigger'] Settings for http workflow trigger eventType. Must be absent for another eventtypes
event_typeDTOReferencefalse[REQUIRED][READ_ONLY_AFTER_CREATION] Workflow Event Type which is base for Event
schedule_settingScheduleSettingfalse[REQUIRED if eventType='ScheduledInterval'] Settings for Schedule eventType. Must be absent for another eventtypes
uuidstringfalse[READ_ONLY] The UUID of the Workflow Trigger Event

Type WorkflowTriggerEventTypeDTO

JSON object description

nametyperequireddescription
is_activebooleanfalse[READ_ONLY] Shows if Workflow Trigger Event Type is active
data_classstringfalse[READ_ONLY] The data class of Workflow Trigger Event Type
descriptionstringfalse[READ_ONLY] The description of Workflow Trigger Event Type
namestringfalse[READ_ONLY] The name of the Workflow Trigger Event Type
event_type_optionsArray[EventItemDTO]false[READ_ONLY] The list of allowed values for setting for this EventType
uuidstringfalse[READ_ONLY] The UUID of the Workflow Trigger Event Type