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}
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/template/
- /api/workflow/v1/template/{uuid}
- /api/workflow/v1/bpm/definition/instance/{instance_id}/token
- /api/workflow/v1/bpm/definition/instance/{instance_id}/token/{token_id}
- /api/workflow/v1/bpm/definition/
- /api/workflow/v1/definition/{uuiddefinition}/node/
- /api/workflow/v1/definition/{uuiddefinition}/node/{name}
- /api/workflow/v1/task/
- /api/workflow/v1/task/{uuid}
- /api/workflow/v1/definition/
- /api/workflow/v1/definition/{uuid}
- /api/workflow/v1/definition/{uuid}/activation
- /api/workflow/v1/definition/{uuid}/deployment
- /api/workflow/v1/queue/available_plugins
- /api/workflow/v1/bpm/definition/{definition_id}/instance/
- /api/workflow/v1/bpm/definition/instance/{instance_id}
- /api/workflow/v1/definition/{uuid}/reload
- /api/workflow/v1/task/{uuid}/action
- /api/workflow/v1/bpm/definition/instance/{instance_id}/action
- /api/workflow/v1/definition/{uuid}/image
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
- CommonListStringDTO
- DTOReference
- DecisionSetting
- JbpmCommentDTO
- ProcessInstanceActionDTO
- ProcessInstanceDTO
- ProcessorSetting
- ProductizeSetting
- TaskSetting
- TokenDetailsDTO
- WorkflowDefinitionActivationDTO
- WorkflowDefinitionDTO
- WorkflowDefinitionDeploymentDTO
- WorkflowDefinitionGeneralListingDTO
- WorkflowDefinitionImageDTO
- WorkflowDefinitionNodeDTO
- WorkflowTaskActionDTO
- WorkflowTaskDTO
- WorkflowTemplateDTO
/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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
WorkflowTemplateDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
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) |
---|---|
WorkflowTemplateDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
WorkflowTemplateDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is present in request path. |
500 | Request is formed correctly, but server cannot create entity. Unexpected error. |
/api/workflow/v1/template/{uuid}
- Mount point: /api/workflow/v1/template/{uuid}
The following operations are supported on this resource:
DELETE
This method is used to delete Workflow 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. Workflow Template was successfully deleted. |
400 | Workflow Template can not be removed since it is used by other Workflow Definitions. |
404 | NOT 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 |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
WorkflowTemplateDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
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 |
---|---|---|---|
uuid | The uuid of Workflow template. | path |
Input Payload
element | consumeable content type(s) |
---|---|
WorkflowTemplateDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
WorkflowTemplateDTO | 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/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_id | The numeric id of the JBPM Process Instance. | path |
Output Payload
element | produceable content type(s) |
---|---|
TokenDetailsDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/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_id | The numeric id of the JBPM Token. | path | |
instance_id | The uuid of the JBPM Process Instance. | path |
Output Payload
element | produceable content type(s) |
---|---|
TokenDetailsDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
/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 |
---|---|---|---|
search | Search | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
WorkflowDefinitionGeneralListingDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/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 |
---|---|---|---|
uuiddefinition | The uuid of WorkflowDefinition. | path |
Output Payload
element | produceable content type(s) |
---|---|
WorkflowDefinitionNodeDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/api/workflow/v1/definition/{uuiddefinition}/node/{name}
- Mount point: /api/workflow/v1/definition/{uuiddefinition}/node/{name}
The following operations are supported on this resource:
GET
This method is used to get a Node of WorkflowDefinition by given nodename.
URL Parameters
name | description | type | default |
---|---|---|---|
uuiddefinition | The uuid of WorkflowDefinition. | path | |
name | The name of the node. | path |
Output Payload
element | produceable content type(s) |
---|---|
WorkflowDefinitionNodeDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
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 |
---|---|---|---|
uuiddefinition | The uuid of WorkflowDefinition. | path | |
name | The name of Workflow Definition Node. | path |
Input Payload
element | consumeable content type(s) |
---|---|
WorkflowDefinitionNodeDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
WorkflowDefinitionNodeDTO | 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/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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
WorkflowTaskDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/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 |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
WorkflowTaskDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT 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 |
---|---|---|---|
search | Search | query | |
sort | Sort | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
WorkflowDefinitionDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
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) |
---|---|
WorkflowDefinitionDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
WorkflowDefinitionDTO | application/json |
Response Codes
code | reason |
---|---|
201 | Created. |
400 | Error in JSON request, or request didn't pass field validation, or not unique data is provided. |
404 | Request path formed incorrectly and cannot be resolved. |
405 | UUID is present in request path. |
500 | Request is formed correctly, but server cannot create entity. Unexpected error. |
/api/workflow/v1/definition/{uuid}
- Mount point: /api/workflow/v1/definition/{uuid}
The following operations are supported on this resource:
DELETE
This method is used to delete Workflow Definition. 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. Workflow Definition was successfully deleted. |
400 | Workflow Definition is deployed. Only undeployed Workflow Definitions can be deleted. |
404 | NOT 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 |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
WorkflowDefinitionDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
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) |
---|---|
WorkflowDefinitionDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
WorkflowDefinitionDTO | 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 | Workflow Definition with UUID from request is not found. |
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/definition/{uuid}/activation
- Mount point: /api/workflow/v1/definition/{uuid}/activation
The following operations are supported on this resource:
DELETE
This method is used to deactivate WorkflowDefinition by given UUID.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT |
404 | NOT FOUND |
GET
This method is used to get a activate status of WorkflowDefinition by given UUID.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
WorkflowDefinitionActivationDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
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 |
---|---|---|---|
uuid | The uuid of Workflow Definition. | path |
Input Payload
element | consumeable content type(s) |
---|---|
WorkflowDefinitionActivationDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
WorkflowDefinitionActivationDTO | 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/definition/{uuid}/deployment
- Mount point: /api/workflow/v1/definition/{uuid}/deployment
The following operations are supported on this resource:
DELETE
This method is used to undeploy WorkflowDefinition by given UUID.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT |
404 | NOT FOUND |
GET
This method is used to get a deployment status of WorkflowDefinition by given UUID.
URL Parameters
name | description | type | default |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
WorkflowDefinitionDeploymentDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
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 |
---|---|---|---|
uuid | The uuid of Workflow Definition. | path |
Input Payload
element | consumeable content type(s) |
---|---|
WorkflowDefinitionDeploymentDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
WorkflowDefinitionDeploymentDTO | 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/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 |
---|---|
200 | OK |
/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_id | The numeric id of the JBPM Process Definition. | path | |
search | Search | query | |
pagination | Pagination | query |
Output Payload
element | produceable content type(s) |
---|---|
ProcessInstanceDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
/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_id | The numeric id of the Process Instance. | path |
Output Payload
element | produceable content type(s) |
---|---|
ProcessInstanceDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
/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 |
---|---|---|---|
uuid | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | NO CONTENT |
404 | NOT 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 |
---|---|---|---|
uuid | The uuid of Workflow Task instance. | path |
Input Payload
element | consumeable content type(s) |
---|---|
WorkflowTaskActionDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
WorkflowTaskActionDTO | 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/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:
DELETE
This method is used to Delete selected Process Instance
URL Parameters
name | description | type | default |
---|---|---|---|
instance_id | path |
Output Payload
element | produceable content type(s) |
---|---|
application/json |
Response Codes
code | reason |
---|---|
204 | Request is formed correctly, operation passed successfully. |
400 | Error in JSON request, or entity didn't pass field validation. |
404 | id 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. |
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_id | The numeric id of Process Instance | path |
Input Payload
element | consumeable content type(s) |
---|---|
ProcessInstanceActionDTO | application/json |
Output Payload
element | produceable content type(s) |
---|---|
ProcessInstanceActionDTO | 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 | id 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/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 |
---|---|---|---|
uuid | The uuid of the object. | path |
Output Payload
element | produceable content type(s) |
---|---|
WorkflowDefinitionImageDTO | application/json |
Response Codes
code | reason |
---|---|
200 | OK |
404 | NOT FOUND |
Type CommonListStringDTO
JSON object description
name | type | required | description |
---|---|---|---|
description | string | false | [READ_ONLY] Descpiption of list |
list | Array[string] | false | [READ_ONLY] String list |
uuid | string | false |
Type 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 DecisionSetting
JSON object description
name | type | required | description |
---|---|---|---|
transition_setting | Set | false | List of settings for transitions |
Type JbpmCommentDTO
JSON object description
name | type | required | description |
---|---|---|---|
publish_date | Date | false | [READ_ONLY] The Date when the comment was published |
message | string | false | The comment message |
author | string | false | [READ_ONLY] The author of comment |
Type ProcessInstanceActionDTO
JSON object description
name | type | required | description |
---|---|---|---|
comment | string | false | Comment message. [REQUIRED for COMMENT action] |
action | string | false | [REQUIRED] Action name. |
id | string | false | [READ_ONLY] ID of the Process Instance |
Type ProcessInstanceDTO
JSON object description
name | type | required | description |
---|---|---|---|
event_file_name | string | false | event file name |
tokens | Set | false | bottom tokens of Process Instance |
comments | Array[JbpmCommentDTO] | false | List of comments to current Token |
end_date | Date | false | end date of Process Instance |
start_date | Date | false | start date of Process Instance |
origin | string | false | equals to currentFileSet |
id | string | false | ID of the Process Instance |
version | int | false | version, means count of Workflowdefinition deployments |
Type ProcessorSetting
JSON object description
name | type | required | description |
---|---|---|---|
action | DTOReference | false | Reference to action which is assigned to node |
allowed_actions | Set | false | [READ ONLY] List of actions which can be assigned to node |
Type ProductizeSetting
JSON object description
name | type | required | description |
---|---|---|---|
policy_refs | Set | false | List of policies assigned to node |
allowed_policy_refs | Set | false | [READ_ONLY] List of allowed policies which can be assigned to node |
Type TaskSetting
JSON object description
name | type | required | description |
---|---|---|---|
actor | string | true | [REQUIRED]. Actor type |
is_producer_task | boolean | true | [REQUIRED]. True - Task is producer task |
instructions | string | false | Description of the Task |
notify_by_email | boolean | true | [REQUIRED]. True - email notification is performed |
actor_ref | DTOReference | false | Reference to actor. It may be reference to Role or User. Important: if 'actor'='ROLE' name field of DTOReference must be provided |
accepted_transition | string | false | [REQUIRED if is_producer_task=true] The name of node to transition to upon approval (processed only for producer task) |
name | string | true | [REQUIRED]. Name of the Task |
rejected_transition | string | false | [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
name | type | required | description |
---|---|---|---|
process_instance_id | string | false | [READ_ONLY] ID of the related process instance |
state | ProcessInstanceStateEnum | false | [READ_ONLY] ProcessInstanceStatusEnum - state |
error_type | string | false | [READ_ONLY] If token state is ERRORED, this field contains type of error |
node_name | string | false | [READ_ONLY] Node name, on which token is situated |
bind_file_set | Array[string] | false | [READ_ONLY] Bind file set of workflow |
token_path_image | WorkflowDefinitionImageDTO | false | [READ_ONLY][GET_LIST_HIDDEN] DTO with SVG image of workflow with token path metadata |
author | string | false | [READ_ONLY] If token state is changed by user, this field will store its login |
token_id | string | false | [READ_ONLY] ID of the Token |
end_date | Date | false | [READ_ONLY] End date of Token's lifecycle |
event_file | string | false | [READ_ONLY] Current file set's first element |
curent_file_set | Array[string] | false | [READ_ONLY] Current file set of workflow |
event_data | Map[string,string] | false | [READ_ONLY] Event data map of workflow context |
context_map | Map[string,string] | false | [READ_ONLY] Context map of workflow context |
path_taken | Array[string] | false | [READ_ONLY] Represents token path as a list of node names, which were visited by token |
start_date | Date | false | [READ_ONLY] Start date of Token's lifecycle |
error_info | string | false | [READ_ONLY] If token state is ERRORED, this field contains detailed error message |
Type WorkflowDefinitionActivationDTO
JSON object description
name | type | required | description |
---|---|---|---|
is_active | boolean | true | [REQUIRED] Shows if Workflow definition is active. true - activate definition, false - deactivate definition |
uuid | string | false | [READ_ONLY] The UUID of the Workflow Definition |
Type WorkflowDefinitionDTO
JSON object description
name | type | required | description |
---|---|---|---|
is_active | boolean | false | [READ_ONLY] Shows if Workflow definition is active |
deployment_status | string | false | [READ_ONLY] Stores enum value of the deployment status. |
current_version | int | false | [READ_ONLY] Current version of definition which is deployed and activated |
last_modified_date | Date | false | [READ_ONLY] Date+Time when definition was modified last time |
definition_status | string | false | [READ_ONLY] Stores enum value of the definition status. |
priority_computing_workflow_uuid | string | false | [REQUIRED if priority_source is COMPUTED] Stores UUID of the workflow definition that will compute priority. |
display_property | string | false | Set the Display Property value on the Workflow Definition |
is_deployed | boolean | false | [READ_ONLY] Shows if Workflow definition is deployed |
time_out | int | true | [REQUIRED] Set the Time Out value on the Workflow Definition |
deployed_on_date | Date | false | [READ_ONLY] Date and time when definition was deployed |
description | string | false | The description of Workflow definition |
name | string | true | [REQUIRED, UNIQUE, READ_ONLY_AFTER_CREATION] The name of Workflow Definition |
is_valid | boolean | false | [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_ref | DTOReference | false | [READ ONLY AFTER CREATION] Workflow template wich was used for creating definition |
trigger_event_refs | Set | false | [READ_ONLY] Set of trigger events, which linked with WorkflowDefinition |
priority | int | false | Priority of workflow execution order. min=1, max=10. If omitted in JSON, default value will be set from Admin Config |
priority_source | string | true | [REQUIRED] Stores enum value of the priority source. |
node_refs | Set | false | [READ_ONLY] Set of nodes` configuration |
uuid | string | false | [READ_ONLY] The UUID of the Workflow Definition |
Type WorkflowDefinitionDeploymentDTO
JSON object description
name | type | required | description |
---|---|---|---|
is_deployed | boolean | true | [REQUIRED] Shows if Workflow definition is deployed. true - deploy, false - undeploy |
deployed_on_date | Date | false | [READ_ONLY] Date+time when definition was deployed |
uuid | string | false | [READ_ONLY] The UUID of the Workflow Definition |
Type WorkflowDefinitionGeneralListingDTO
JSON object description
name | type | required | description |
---|---|---|---|
count | long | false | shows count of all Process Instances, which has given status and given Definition |
filter_by_start_date | boolean | false | true: date filter applies to start date of Process instance, false - end date. default value 'true' of ommited |
state | ProcessInstanceStateEnum | false | State of Process Instances wich has this Process Definition |
date_from | Date | false | represents chosen filter 'from date' |
date_to | Date | false | represents chosen filter 'to date' |
name | string | false | Name of the Process Definition |
id | string | false | UUID of the Process Definition |
version | int | false | version, means count of Workflowdefinition deployments |
Type WorkflowDefinitionImageDTO
JSON object description
name | type | required | description |
---|---|---|---|
workflow_definition_image | string | false | [READ_ONLY] WorkflowDefinition image in SVG format that is encoded in Base64 string |
workflow_definition_nodes_config | Set | false | [READ_ONLY] List of base information regarding WorkflowDefinition nodes configuration |
Type WorkflowDefinitionNodeDTO
JSON object description
name | type | required | description |
---|---|---|---|
transition_to_node_names | Array[string] | false | [READ_ONLY] List of nodes` name to which transitions are |
node_category | string | false | [READ_ONLY] The category of node |
decision_setting | DecisionSetting | false | [REQUIRED if node_category='DECISION'] Settings for decision node type. Must be absent for another nodetypes |
workflow_definition_ref | DTOReference | true | [READ_ONLY] The link to Workflow Definition which node belongs to |
node_name | string | false | [READ_ONLY] The name of the node |
processor_setting | ProcessorSetting | false | [REQUIRED if node_category='PROCESSOR'] Settings for processor node type. Must be absent for another nodetypes |
is_valid | boolean | false | [READ_ONLY] Shows current state for node: true - valid, false - invalid |
productize_setting | ProductizeSetting | false | [REQUIRED if node_category='PRODUCTIZE'] Settings for productize node type. Must be absent for another nodetypes |
task_setting | TaskSetting | false | [REQUIRED if node_category='TASK'] Settings for task node type. Must be absent for another nodetypes |
Type WorkflowTaskActionDTO
JSON object description
name | type | required | description |
---|---|---|---|
actor_type | string | false | [REQUIRED if 'action'=ASSIGN] The type of the actor to be assigned for the Workflow Task instance. |
comment | string | false | [REQUIRED if 'action'=ADD_COMMENT] The comment to be added to the Workflow Task instance |
action | string | false | [REQUIRED] The type of an action to perfom on the Workflow Task instance |
actor | string | false | [REQUIRED if 'action'=ASSIGN] The actor to be assigned for the Workflow Task instance |
uuid | string | false | [READ_ONLY] The uuid of the Workflow Task instance |
Type WorkflowTaskDTO
JSON object description
name | type | required | description |
---|---|---|---|
bundle_name | string | false | The Bundle name of the Workflow Task instance |
task_name | string | false | The name of the Workflow Task instance |
producer_task | boolean | false | Shows if Workflow Task instance is a Producer Task |
bundle_ref | DTOReference | false | The reference to the Bundle of the Workflow Task instance |
assigned_to_role | boolean | false | Shows if Workflow Task instance is assigned to Role |
task_group_name | string | false | The name of the Task Group to which this Workflow Task instance belongs |
instructions | string | false | Instructions of the Workflow Task instance |
asignee_name | string | false | The name of the assigned Person who is responsible for this Workflow Task instance |
suspended | boolean | false | |
comments | Array[JbpmCommentDTO] | false | |
started_by_user | string | false | The name of the Person who started this Workflow Task instance |
end_date | Date | false | The date when Workflow Task instance was completed |
status | string | false | The status of the Workflow Task instance |
event_file | string | false | The name of the processed file of the Workflow Task instance |
bundle_type_ref | DTOReference | false | The reference to the Bundle type of the Workflow Task instance |
start_date | Date | false | The date when Workflow Task instance was started |
create_date | Date | false | The date when Workflow Task instance was created |
uuid | string | false | [READ_ONLY] The UUID of the Workflow Task instance |
bundle_type | string | false | The name of the Bundle type of the Workflow Task instance |
Type WorkflowTemplateDTO
JSON object description
name | type | required | description |
---|---|---|---|
is_active | boolean | true | Shows if Workflow Temaplte is active |
archive_bytes | string | false | [GET_LIST_HIDDEN] Archive bytes in Base64 format. Archive presents set of files for template |
last_modified_date | Date | false | [READ_ONLY] Date+Time when template was modified |
type | string | true | The type values which used for storing in database field of <code>OWS_PROCESS_TEMPLATE</code>: standard or priority computation workflow |
process_definitions | Set | false | [READ_ONLY][GET_LIST_HIDDEN] Set of process definitions which were created based on this template |
description | string | false | The description of Workflow Template |
name | string | true | [REQUIRED, UNIQUE] The name of Workflow Template |
archive_upload_date | Date | false | Date+Time when archive of template was uploaded |
archive_name | string | true | The name of archive which contains template`s files |
uuid | string | false | [READ_ONLY] The UUID of the Workflow Template |