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/WorkflowService/resource/rest{Method Mount Point}

/api/workflow/v1/definition/{uuid}/reload

  • Mount point: /api/workflow/v1/definition/{uuid}/reload

The following operations are supported on this resource:

DELETE

This method is used to reload WorkflowDefinition from its template by given UUID.

Reloading the workflow template cannot be undone. Any current configuration settings will be reset.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT
404NOT FOUND

/api/workflow/v1/definition/{uuid}/activation

  • Mount point: /api/workflow/v1/definition/{uuid}/activation

The following operations are supported on this resource:

PUT

This method is used to perform activate or deactivate operation for WorkflowDefinition. 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 WorkflowDefinition.

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

URL Parameters

name description type default
uuidThe uuid of Workflow Definition.path

Input Payload

element consumeable content type(s)
WorkflowDefinitionActivationDTOapplication/json

Output Payload

element produceable content type(s)
WorkflowDefinitionActivationDTO application/json

Response Codes

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

DELETE

This method is used to deactivate WorkflowDefinition by given UUID.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT
404NOT FOUND

GET

This method is used to get a activate status of WorkflowDefinition by given UUID.

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
WorkflowDefinitionActivationDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/workflow/v1/task/

  • Mount point: /api/workflow/v1/task/

The following operations are supported on this resource:

GET

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

API Search OR operation, brackets are not supported. For API Search use next tokens: </br>bundle_name:equals:{value}, bundle_type_uuid:equals:{value}, status:equals:{value}, task_group_name:equals:{value}, date:gt:{value} and date:lt:{value}.</br> Date should be defined in format: yyyyMMddHHmmss. Allowed values for status are: Assigned, Started, Completed.</br> API Sort allowed fields are: bundleName, bundleType. Please use exponent symbol ^ to escape colons.

URL Parameters

name description type default
searchSearchquery
sortSortquery
paginationPaginationquery

Output Payload

element produceable content type(s)
WorkflowTaskDTO application/json

Response Codes

code reason
200OK

/api/workflow/v1/task/{uuid}

  • Mount point: /api/workflow/v1/task/{uuid}

The following operations are supported on this resource:

GET

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

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
WorkflowTaskDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/workflow/v1/bpm/definition/instance/{instance_id}/token

  • Mount point: /api/workflow/v1/bpm/definition/instance/{instance_id}/token

The following operations are supported on this resource:

GET

This method is used to get list of JBPM Token DTO objects which belongs to chosen JBPM Process Instance

API Search, Sort and Pagination parameters are not supported

URL Parameters

name description type default
instance_idThe numeric id of the JBPM Process Instance.path

Output Payload

element produceable content type(s)
TokenDetailsDTO application/json

Response Codes

code reason
200OK

/api/workflow/v1/bpm/definition/instance/{instance_id}/token/{token_id}

  • Mount point: /api/workflow/v1/bpm/definition/instance/{instance_id}/token/{token_id}

The following operations are supported on this resource:

GET

This method is used to get a specific instance of the Token Details DTO by given id.

URL Parameters

name description type default
token_idThe numeric id of the JBPM Token.path
instance_idThe uuid of the JBPM Process Instance.path

Output Payload

element produceable content type(s)
TokenDetailsDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/workflow/v1/definition/{uuid}/deployment

  • Mount point: /api/workflow/v1/definition/{uuid}/deployment

The following operations are supported on this resource:

PUT

This method is used to perform deploy or undeploy operation for WorkflowDefinition . 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 WorkflowDefinition.

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

URL Parameters

name description type default
uuidThe uuid of Workflow Definition.path

Input Payload

element consumeable content type(s)
WorkflowDefinitionDeploymentDTOapplication/json

Output Payload

element produceable content type(s)
WorkflowDefinitionDeploymentDTO application/json

Response Codes

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

DELETE

This method is used to undeploy WorkflowDefinition by given UUID.

URL Parameters

name description type default
uuidpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204NO CONTENT
404NOT FOUND

GET

This method is used to get a deployment status of WorkflowDefinition by given UUID.

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
WorkflowDefinitionDeploymentDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/workflow/v1/definition/{uuid}/image

  • Mount point: /api/workflow/v1/definition/{uuid}/image

The following operations are supported on this resource:

GET

This method is used to get/generate an image of WorkflowDefinition by given UUID.

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
WorkflowDefinitionImageDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/workflow/v1/bpm/definition/instance/{instance_id}/action

  • Mount point: /api/workflow/v1/bpm/definition/instance/{instance_id}/action

The following operations are supported on this resource:

PUT

This method is used to perform Actions on selected Process Instance

Actions are made on all tokens of the Process Instance

URL Parameters

name description type default
instance_idThe numeric id of Process Instancepath

Input Payload

element consumeable content type(s)
ProcessInstanceActionDTOapplication/json

Output Payload

element produceable content type(s)
ProcessInstanceActionDTO application/json

Response Codes

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

DELETE

This method is used to Delete selected Process Instance

URL Parameters

name description type default
instance_idpath

Output Payload

element produceable content type(s)
application/json

Response Codes

code reason
204Request is formed correctly, operation passed successfully.
400Error in JSON request, or entity didn't pass field validation.
404id 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/bpm/definition/

  • Mount point: /api/workflow/v1/bpm/definition/

The following operations are supported on this resource:

GET

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

API Search OR operation, brackets are not supported. For API Search use next tokens: </br> date_from:equals:{value}, date_to:equals:{value}, filter_by_start:equals:{true/false}, status:equals:{value}. </br>Date should be defined in format: yyyyMMddHHmmss.</br> Allowed values for state are: COMPLETED, IN_PROGRESS, SUSPENDED, TERMINATED, ERRORED.</br> API Sort not supported.

URL Parameters

name description type default
searchSearchquery
paginationPaginationquery

Output Payload

element produceable content type(s)
WorkflowDefinitionGeneralListingDTO application/json

Response Codes

code reason
200OK

/api/workflow/v1/bpm/definition/{definition_id}/instance/

  • Mount point: /api/workflow/v1/bpm/definition/{definition_id}/instance/

The following operations are supported on this resource:

GET

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

API Search OR operation, brackets are not supported. For API Search use next tokens: </br> date_from:equals:{value}, date_to:equals:{value}, filter_by_start:equals:{true/false}, status:equals:{value}. </br>Date should be defined in format: yyyyMMddHHmmss.</br> Allowed values for status are: COMPLETED, IN_PROGRESS, SUSPENDED, TERMINATED, ERRORED.</br>Search of ERORRED will find both: ERRORED and TERMINATED_ERROR instances.</br>API Sort not supported.

URL Parameters

name description type default
definition_idThe numeric id of the JBPM Process Definition.path
searchSearchquery
paginationPaginationquery

Output Payload

element produceable content type(s)
ProcessInstanceDTO application/json

Response Codes

code reason
200OK

/api/workflow/v1/bpm/definition/instance/{instance_id}

  • Mount point: /api/workflow/v1/bpm/definition/instance/{instance_id}

The following operations are supported on this resource:

GET

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

URL Parameters

name description type default
instance_idThe numeric id of the Process Instance.path

Output Payload

element produceable content type(s)
ProcessInstanceDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/workflow/v1/task/{uuid}/action

  • Mount point: /api/workflow/v1/task/{uuid}/action

The following operations are supported on this resource:

PUT

This method is used to perform action for Workflow Task 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. It should be uuid of Task.

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

URL Parameters

name description type default
uuidThe uuid of Workflow Task instance.path

Input Payload

element consumeable content type(s)
WorkflowTaskActionDTOapplication/json

Output Payload

element produceable content type(s)
WorkflowTaskActionDTO 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/template/

  • Mount point: /api/workflow/v1/template/

The following operations are supported on this resource:

GET

This method is used to get list of available WorkflowTemplate 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)
WorkflowTemplateDTO application/json

Response Codes

code reason
200OK

POST

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

Input Payload

element consumeable content type(s)
WorkflowTemplateDTOapplication/json

Output Payload

element produceable content type(s)
WorkflowTemplateDTO application/json

Response Codes

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

/api/workflow/v1/template/{uuid}

  • Mount point: /api/workflow/v1/template/{uuid}

The following operations are supported on this resource:

PUT

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

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

URL Parameters

name description type default
uuidThe uuid of Workflow template.path

Input Payload

element consumeable content type(s)
WorkflowTemplateDTOapplication/json

Output Payload

element produceable content type(s)
WorkflowTemplateDTO application/json

Response Codes

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

DELETE

This method is used to delete Workflow 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. Workflow Template was successfully deleted.
400Workflow Template can not be removed since it is used by other Workflow Definitions.
404NOT FOUND. Workflow Template with provided id was not found.

GET

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

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
WorkflowTemplateDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/workflow/v1/definition/{uuiddefinition}/node/

  • Mount point: /api/workflow/v1/definition/{uuiddefinition}/node/

The following operations are supported on this resource:

GET

This method is used to get list of available WorkflowDefinitionNode DTO objects for WorkflowDefinition. API Search and API Sort are not supported.

URL Parameters

name description type default
uuiddefinitionThe uuid of WorkflowDefinition.path

Output Payload

element produceable content type(s)
WorkflowDefinitionNodeDTO application/json

Response Codes

code reason
200OK

/api/workflow/v1/definition/{uuiddefinition}/node/{name}

  • Mount point: /api/workflow/v1/definition/{uuiddefinition}/node/{name}

The following operations are supported on this resource:

PUT

This method is used to update WorkflowDefinitionNode. Note, that UUID for workflowdefinition and name for node in request string must be present. UUID of workflowdefinition and node name in JSON body must be absent.

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

URL Parameters

name description type default
uuiddefinitionThe uuid of WorkflowDefinition.path
nameThe name of Workflow Definition Node.path

Input Payload

element consumeable content type(s)
WorkflowDefinitionNodeDTOapplication/json

Output Payload

element produceable content type(s)
WorkflowDefinitionNodeDTO application/json

Response Codes

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

GET

This method is used to get a Node of WorkflowDefinition by given nodename.

URL Parameters

name description type default
uuiddefinitionThe uuid of WorkflowDefinition.path
nameThe name of the node.path

Output Payload

element produceable content type(s)
WorkflowDefinitionNodeDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/workflow/v1/definition/

  • Mount point: /api/workflow/v1/definition/

The following operations are supported on this resource:

GET

This method is used to get list of available WorkflowDefinition 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)
WorkflowDefinitionDTO application/json

Response Codes

code reason
200OK

POST

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

Input Payload

element consumeable content type(s)
WorkflowDefinitionDTOapplication/json

Output Payload

element produceable content type(s)
WorkflowDefinitionDTO application/json

Response Codes

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

/api/workflow/v1/definition/{uuid}

  • Mount point: /api/workflow/v1/definition/{uuid}

The following operations are supported on this resource:

PUT

This method is used to update Workflow Definition. UUID must be specified for this operation. Request body must contain all required fields.

Input Payload

element consumeable content type(s)
WorkflowDefinitionDTOapplication/json

Output Payload

element produceable content type(s)
WorkflowDefinitionDTO 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.
404Workflow Definition with UUID from request is not found.
405Request path has no UUID or it doesn't match the one from request body.
500Request is formed correctly, but server cannot perform entity update. Unexpected error.

DELETE

This method is used to delete Workflow Definition. 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. Workflow Definition was successfully deleted.
400Workflow Definition is deployed. Only undeployed Workflow Definitions can be deleted.
404NOT FOUND. Workflow Definition with provided id was not found.

GET

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

URL Parameters

name description type default
uuidThe uuid of the object.path

Output Payload

element produceable content type(s)
WorkflowDefinitionDTO application/json

Response Codes

code reason
200OK
404NOT FOUND

/api/workflow/v1/queue/available_plugins

  • Mount point: /api/workflow/v1/queue/available_plugins

The following operations are supported on this resource:

GET

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

Output Payload

element produceable content type(s)
CommonListStringDTO application/json

Response Codes

code reason
200OK

Type CommonListStringDTO

JSON object description

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

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 DecisionSetting

JSON object description

nametyperequireddescription
transition_settingSetfalseList of settings for transitions

Type JbpmCommentDTO

JSON object description

nametyperequireddescription
publish_dateDatefalse[READ_ONLY] The Date when the comment was published
messagestringfalseThe comment message
authorstringfalse[READ_ONLY] The author of comment

Type ProcessInstanceActionDTO

JSON object description

nametyperequireddescription
commentstringfalseComment message. [REQUIRED for COMMENT action]
actionstringfalse[REQUIRED] Action name.
idstringfalse[READ_ONLY] ID of the Process Instance

Type ProcessInstanceDTO

JSON object description

nametyperequireddescription
event_file_namestringfalseevent file name
tokensSetfalsebottom tokens of Process Instance
commentsArray[JbpmCommentDTO]falseList of comments to current Token
end_dateDatefalseend date of Process Instance
start_dateDatefalsestart date of Process Instance
originstringfalseequals to currentFileSet
idstringfalseID of the Process Instance
versionintfalseversion, means count of Workflowdefinition deployments

Type ProcessorSetting

JSON object description

nametyperequireddescription
actionDTOReferencefalseReference to action which is assigned to node
allowed_actionsSetfalse[READ ONLY] List of actions which can be assigned to node

Type ProductizeSetting

JSON object description

nametyperequireddescription
policy_refsSetfalseList of policies assigned to node
allowed_policy_refsSetfalse[READ_ONLY] List of allowed policies which can be assigned to node

Type TaskSetting

JSON object description

nametyperequireddescription
actorstringtrue[REQUIRED]. Actor type
is_producer_taskbooleantrue[REQUIRED]. True - Task is producer task
instructionsstringfalseDescription of the Task
notify_by_emailbooleantrue[REQUIRED]. True - email notification is performed
actor_refDTOReferencefalseReference to actor. It may be reference to Role or User. Important: if 'actor'='ROLE' name field of DTOReference must be provided
accepted_transitionstringfalse[REQUIRED if is_producer_task=true] The name of node to transition to upon approval (processed only for producer task)
namestringtrue[REQUIRED]. Name of the Task
rejected_transitionstringfalse[REQUIRED if is_producer_task=true] The name of node to transition to upon rejection (processed only for producer task)

Type TokenDetailsDTO

JSON object description

nametyperequireddescription
process_instance_idstringfalse[READ_ONLY] ID of the related process instance
stateProcessInstanceStateEnumfalse[READ_ONLY] ProcessInstanceStatusEnum - state
error_typestringfalse[READ_ONLY] If token state is ERRORED, this field contains type of error
node_namestringfalse[READ_ONLY] Node name, on which token is situated
bind_file_setArray[string]false[READ_ONLY] Bind file set of workflow
token_path_imageWorkflowDefinitionImageDTOfalse[READ_ONLY][GET_LIST_HIDDEN] DTO with SVG image of workflow with token path metadata
authorstringfalse[READ_ONLY] If token state is changed by user, this field will store its login
token_idstringfalse[READ_ONLY] ID of the Token
end_dateDatefalse[READ_ONLY] End date of Token's lifecycle
event_filestringfalse[READ_ONLY] Current file set's first element
curent_file_setArray[string]false[READ_ONLY] Current file set of workflow
event_dataMap[string,string]false[READ_ONLY] Event data map of workflow context
context_mapMap[string,string]false[READ_ONLY] Context map of workflow context
path_takenArray[string]false[READ_ONLY] Represents token path as a list of node names, which were visited by token
start_dateDatefalse[READ_ONLY] Start date of Token's lifecycle
error_infostringfalse[READ_ONLY] If token state is ERRORED, this field contains detailed error message

Type WorkflowDefinitionActivationDTO

JSON object description

nametyperequireddescription
is_activebooleantrue[REQUIRED] Shows if Workflow definition is active. true - activate definition, false - deactivate definition
uuidstringfalse[READ_ONLY] The UUID of the Workflow Definition

Type WorkflowDefinitionDTO

JSON object description

nametyperequireddescription
is_activebooleanfalse[READ_ONLY] Shows if Workflow definition is active
deployment_statusstringfalse[READ_ONLY] Stores enum value of the deployment status.
current_versionintfalse[READ_ONLY] Current version of definition which is deployed and activated
last_modified_dateDatefalse[READ_ONLY] Date+Time when definition was modified last time
priority_computing_workflow_uuidstringfalse[REQUIRED if priority_source is COMPUTED] Stores UUID of the workflow definition that will compute priority.
definition_statusstringfalse[READ_ONLY] Stores enum value of the definition status.
display_propertystringfalseSet the Display Property value on the Workflow Definition
is_deployedbooleanfalse[READ_ONLY] Shows if Workflow definition is deployed
time_outinttrue[REQUIRED] Set the Time Out value on the Workflow Definition
deployed_on_dateDatefalse[READ_ONLY] Date and time when definition was deployed
descriptionstringfalseThe description of Workflow definition
namestringtrue[REQUIRED, UNIQUE, READ_ONLY_AFTER_CREATION] The name of Workflow Definition
is_validbooleanfalse[READ_ONLY] Shows current state for definition: true - definition is valid, false - definition is invalid (at least one node exists which is invalid)
workflow_template_refDTOReferencefalse[READ ONLY AFTER CREATION] Workflow template wich was used for creating definition
trigger_event_refsSetfalse[READ_ONLY] Set of trigger events, which linked with WorkflowDefinition
priorityintfalsePriority of workflow execution order. min=1, max=10. If omitted in JSON, default value will be set from Admin Config
priority_sourcestringtrue[REQUIRED] Stores enum value of the priority source.
node_refsSetfalse[READ_ONLY] Set of nodes` configuration
uuidstringfalse[READ_ONLY] The UUID of the Workflow Definition

Type WorkflowDefinitionDeploymentDTO

JSON object description

nametyperequireddescription
is_deployedbooleantrue[REQUIRED] Shows if Workflow definition is deployed. true - deploy, false - undeploy
deployed_on_dateDatefalse[READ_ONLY] Date+time when definition was deployed
uuidstringfalse[READ_ONLY] The UUID of the Workflow Definition

Type WorkflowDefinitionGeneralListingDTO

JSON object description

nametyperequireddescription
countlongfalseshows count of all Process Instances, which has given status and given Definition
filter_by_start_datebooleanfalsetrue: date filter applies to start date of Process instance, false - end date. default value 'true' of ommited
stateProcessInstanceStateEnumfalseState of Process Instances wich has this Process Definition
date_fromDatefalserepresents chosen filter 'from date'
date_toDatefalserepresents chosen filter 'to date'
namestringfalseName of the Process Definition
idstringfalseUUID of the Process Definition
versionintfalseversion, means count of Workflowdefinition deployments

Type WorkflowDefinitionImageDTO

JSON object description

nametyperequireddescription
workflow_definition_imagestringfalse[READ_ONLY] WorkflowDefinition image in SVG format that is encoded in Base64 string
workflow_definition_nodes_configSetfalse[READ_ONLY] List of base information regarding WorkflowDefinition nodes configuration

Type WorkflowDefinitionNodeDTO

JSON object description

nametyperequireddescription
transition_to_node_namesArray[string]false[READ_ONLY] List of nodes` name to which transitions are
decision_settingDecisionSettingfalse[REQUIRED if node_category='DECISION'] Settings for decision node type. Must be absent for another nodetypes
node_categorystringfalse[READ_ONLY] The category of node
workflow_definition_refDTOReferencetrue[READ_ONLY] The link to Workflow Definition which node belongs to
node_namestringfalse[READ_ONLY] The name of the node
processor_settingProcessorSettingfalse[REQUIRED if node_category='PROCESSOR'] Settings for processor node type. Must be absent for another nodetypes
is_validbooleanfalse[READ_ONLY] Shows current state for node: true - valid, false - invalid
productize_settingProductizeSettingfalse[REQUIRED if node_category='PRODUCTIZE'] Settings for productize node type. Must be absent for another nodetypes
task_settingTaskSettingfalse[REQUIRED if node_category='TASK'] Settings for task node type. Must be absent for another nodetypes

Type WorkflowTaskActionDTO

JSON object description

nametyperequireddescription
actor_typestringfalse[REQUIRED if 'action'=ASSIGN] The type of the actor to be assigned for the Workflow Task instance.
commentstringfalse[REQUIRED if 'action'=ADD_COMMENT] The comment to be added to the Workflow Task instance
actionstringfalse[REQUIRED] The type of an action to perfom on the Workflow Task instance
actorstringfalse[REQUIRED if 'action'=ASSIGN] The actor to be assigned for the Workflow Task instance
uuidstringfalse[READ_ONLY] The uuid of the Workflow Task instance

Type WorkflowTaskDTO

JSON object description

nametyperequireddescription
bundle_namestringfalseThe Bundle name of the Workflow Task instance
task_namestringfalseThe name of the Workflow Task instance
bundle_refDTOReferencefalseThe reference to the Bundle of the Workflow Task instance
producer_taskbooleanfalseShows if Workflow Task instance is a Producer Task
task_group_namestringfalseThe name of the Task Group to which this Workflow Task instance belongs
assigned_to_rolebooleanfalseShows if Workflow Task instance is assigned to Role
asignee_namestringfalseThe name of the assigned Person who is responsible for this Workflow Task instance
instructionsstringfalseInstructions of the Workflow Task instance
suspendedbooleanfalse
commentsArray[JbpmCommentDTO]false
started_by_userstringfalseThe name of the Person who started this Workflow Task instance
statusstringfalseThe status of the Workflow Task instance
end_dateDatefalseThe date when Workflow Task instance was completed
event_filestringfalseThe name of the processed file of the Workflow Task instance
bundle_type_refDTOReferencefalseThe reference to the Bundle type of the Workflow Task instance
start_dateDatefalseThe date when Workflow Task instance was started
create_dateDatefalseThe date when Workflow Task instance was created
uuidstringfalse[READ_ONLY] The UUID of the Workflow Task instance
bundle_typestringfalseThe name of the Bundle type of the Workflow Task instance

Type WorkflowTemplateDTO

JSON object description

nametyperequireddescription
is_activebooleantrueShows if Workflow Temaplte is active
archive_bytesstringfalse[GET_LIST_HIDDEN] Archive bytes in Base64 format. Archive presents set of files for template
last_modified_dateDatefalse[READ_ONLY] Date+Time when template was modified
typestringtrueThe type values which used for storing in database field of <code>OWS_PROCESS_TEMPLATE</code>: standard or priority computation workflow
process_definitionsSetfalse[READ_ONLY][GET_LIST_HIDDEN] Set of process definitions which were created based on this template
descriptionstringfalseThe description of Workflow Template
namestringtrue[REQUIRED, UNIQUE] The name of Workflow Template
archive_upload_dateDatefalseDate+Time when archive of template was uploaded
archive_namestringtrueThe name of archive which contains template`s files
uuidstringfalse[READ_ONLY] The UUID of the Workflow Template