Table of Contents
Read methods
| Method / Path: | GET /{workflowDefinitionId} |
|---|---|
| Description: | Returns a single workflow definition. |
| Path params: | workflowDefinitionId: The workflow definition id |
| Optional (query) params: |
withoperations:
Whether the workflow operations should be included in the response withconfigurationpaneljson: Whether the workflow configuration panel in JSON should be included in the response withconfigurationpanel: Whether the workflow configuration panel 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 definition is returned. 404: Not Found, The specified workflow definition does not exist. |
| Testing: |
Sample:
/{workflowDefinitionId}?withoperations={withoperations}&withconfigurationpaneljson={withconfigurationpaneljson}&withconfigurationpanel={withconfigurationpanel}
Testing form (click to reveal)
|
| Method / Path: | GET / |
|---|---|
| Description: | Returns a list of workflow definition. |
| Path params: | NONE |
| Optional (query) params: |
withoperations:
Whether the workflow operations should be included in the response withconfigurationpanel: Whether the workflow configuration panel should be included in the response filter: Usage [Filter Name]:[Value to Filter With]. Available filter: "tag" sort: Sort the results based upon a list of comma seperated sorting criteria. In the comma seperated list each type of sorting is specified as a pair such as: limit(Default value=0): The maximum number of results to return for a single request. offset(Default value=0): The index of the first result to return. |
| 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, A (potentially empty) list of workflow definitions is returned. 400: Bad Request, The request is invalid or inconsistent. |
| Testing: |
Sample:
/?withoperations={withoperations}&withconfigurationpanel={withconfigurationpanel}&filter={filter}&sort={sort}&limit=0&offset=0
Testing form (click to reveal)
|