Table of Contents
Read methods
| Method / Path: | GET /{workflowInstanceId} |
|---|---|
| Description: | Returns a single workflow instance. |
| Path params: | workflowInstanceId(Default value=0): The workflow instance id |
| Optional (query) params: |
withoperations:
Whether the workflow operations should be included in the response withconfiguration: Whether the workflow configuration should be included in the response |
| Response formats: |
application/json
application/v1.1.0+json application/v1.2.0+json application/v1.3.0+json application/v1.4.0+json application/v1.5.0+json application/v1.6.0+json application/v1.7.0+json application/v1.8.0+json application/v1.9.0+json application/v1.10.0+json application/v1.11.0+json |
| Status codes: |
200: OK, The workflow instance is returned. 403: Forbidden, The user doesn't have the rights to make this request. 404: Not Found, The specified workflow instance does not exist. |
| Testing: |
Sample:
/{workflowInstanceId}?withoperations={withoperations}&withconfiguration={withconfiguration}
Testing form (click to reveal)
|
Write methods
| Method / Path: | POST / |
|---|---|
| Description: | Creates a workflow instance. |
| Path params: | NONE |
| Required (form) params: |
event_identifier: The event identifier this workflow should run against
workflow_definition_identifier: The identifier of the workflow definition to use |
| Optional (form) params: |
configuration:
The optional configuration for this workflow withoperations: Whether the workflow operations should be included in the response withconfiguration: Whether the workflow configuration should be included in the response |
| Response formats: |
application/json
application/v1.1.0+json application/v1.2.0+json application/v1.3.0+json application/v1.4.0+json application/v1.5.0+json application/v1.6.0+json application/v1.7.0+json application/v1.8.0+json application/v1.9.0+json application/v1.10.0+json application/v1.11.0+json |
| Status codes: |
201: Created, A new workflow is created and its identifier is returned in the Location header. 400: Bad Request, The request is invalid or inconsistent. 404: Not Found, The event or workflow definition could not be found. |
| Testing: |
Sample:
/
Testing form (click to reveal)
|
| Method / Path: | DELETE /{workflowInstanceId} |
|---|---|
| Description: | Deletes a workflow instance. |
| Path params: | workflowInstanceId(Default value=0): The workflow instance id |
| Optional (query) params: | NONE |
| Response formats: |
application/json
application/v1.1.0+json application/v1.2.0+json application/v1.3.0+json application/v1.4.0+json application/v1.5.0+json application/v1.6.0+json application/v1.7.0+json application/v1.8.0+json application/v1.9.0+json application/v1.10.0+json application/v1.11.0+json |
| Status codes: |
204: No Content, The workflow instance has been deleted. 403: Forbidden, The user doesn't have the rights to make this request. 404: Not Found, The specified workflow instance does not exist. 409: Conflict, The workflow instance cannot be deleted in this state. |
| Testing: |
Sample:
/{workflowInstanceId}
Testing form (click to reveal)
|
| Method / Path: | PUT /{workflowInstanceId} |
|---|---|
| Description: | Creates a workflow instance. |
| Path params: | workflowInstanceId(Default value=0): The workflow instance id |
| Optional (form) params: |
configuration:
The optional configuration for this workflow state: The optional state transition for this workflow withoperations: Whether the workflow operations should be included in the response withconfiguration: Whether the workflow configuration should be included in the response |
| Response formats: |
application/json
application/v1.1.0+json application/v1.2.0+json application/v1.3.0+json application/v1.4.0+json application/v1.5.0+json application/v1.6.0+json application/v1.7.0+json application/v1.8.0+json application/v1.9.0+json application/v1.10.0+json application/v1.11.0+json |
| Status codes: |
200: OK, The workflow instance is updated. 400: Bad Request, The request is invalid or inconsistent. 403: Forbidden, The user doesn't have the rights to make this request. 404: Not Found, The workflow instance could not be found. 409: Conflict, The workflow instance cannot transition to this state. |
| Testing: |
Sample:
/{workflowInstanceId}
Testing form (click to reveal)
|