The workflow API provides functionality that allows a administrator to perform actions such as adding and configuring workflow
Table of Contents |
---|
Section | |||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get all workflowsLists all the workflows configured in the Aspire
Pagination query string parameters Query String Parameters
Response
Status: 200 |
Section | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a single workflowGet information about a single workflow in Aspire
Path Parameters
Response
Status: 200, 404 |
Section | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add single workflowAdds a single workflow to Aspire
Body Parameters
Query String Parameters
Example
Response
Status: 200, 406 |
Section | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Update workflows, filteredUpdate connectors configured in the Aspire, filtered by a specified criteria
Response
Status: 200, 406 |
Section | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete multiple workflows, filteredDelete multiple workflows from Aspire, filtered by a specified criteria
Response
Status: 200, 404, 406 |
Section | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete workflow(s)Delete one or more workflows from Aspire.
Path Parameters and Query parameters
Body Parameter
Examples
Response
Status: 200, 404, 406 |
Section | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a workflow eventGet a event from a workflow in Aspire.
Path Parameters
Response
| ||||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||||
200 | Success | |||||||||||||||||||||||
404 | Not found - a given workflow identifier was not found | 406 | Not acceptable - there was an issue validating the input
Section | |||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Create workflow event(s)Create one or more workflow events in Aspire.
Path Parameters
Examples Create a single eventCreate multiple events (body parameter)
Create multiple events (alternative version) Response
| |||||||||||||||||||||||||||||
Response code | Description | ||||||||||||||||||||||||||||
200 | Success | ||||||||||||||||||||||||||||
404 | Not found - a given workflow identifier was not found | ||||||||||||||||||||||||||||
406 | Not acceptable - there was an issue validating the input |
Section | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete | ||||||||||||||||||||||||
Section | ||||||||||||||||||||||||
Delete a workflow eventDelete a workflow event from Aspire.
Path Parameters
Response
| ||||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||||
200 | Success | |||||||||||||||||||||||
404 | Not found - a given workflow identifier was not found | |||||||||||||||||||||||
406 | Not acceptable - there was an issue validating the input |
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Create a workflow event itemCreate a workflow event item - a | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Create a workflow event itemCreate a workflow event item - a rule, condition and the like.
Path Parameters
Body Parameters The request body parameters will differ depending on the type of item created. Some examples are shown below
Response
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response code | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 | Success | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
404 | Not found - a given workflow identifier was not found | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
406 | Not acceptable - there was an issue validating the input |
Section | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update a workflow event itemDelete one or more services from Aspire.
Path Parameters
Body Parameters The request body parameters will differ depending on the type of item created. See Create a workflow event item above Response
| ||||||||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||||||||
200 | Success | |||||||||||||||||||||||||||
404 | Not found - a given workflow identifier was not found | |||||||||||||||||||||||||||
406 | Not acceptable - there was an issue validating the input |
Section | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete single workflow event item
Path Parameters
Response
| ||||||||||||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||||||||||||
200 | Success | |||||||||||||||||||||||||||||||
404 | Not found - a given workflow identifier was not found | |||||||||||||||||||||||||||||||
406 | Not acceptable - there was an issue validating the input |
Section | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Move a workflow event itemDelete one or more | ||||||||||||||||||||||||||||||||||||
Section | ||||||||||||||||||||||||||||||||||||
Move a workflow event itemDelete one or more services from Aspire.
Path Parameters
Body Parameters
Response
| ||||||||||||||||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||||||||||||||||
200 | Success | |||||||||||||||||||||||||||||||||||
404 | Not found - a given workflow identifier was not found | |||||||||||||||||||||||||||||||||||
406 | Not acceptable - there was an issue validating the input |
Section | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get workflow templatesRetrieve all workflow templates from Aspire.
Path Parameters
Query String Parameters
Response Response
| ||||||||||||||||||||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||||||||||||||||||||
200 | Success | |||||||||||||||||||||||||||||||||||||||
404 | Not found - a given workflow identifier was not found | 406 | Not acceptable - there was an issue validating the input
Section | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get single workflow templateRetrieve a single workflow templates from Aspire.
Path Parameters
Response
| ||||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||||
200 | Success | |||||||||||||||||||||||
404 | Not found - a given workflow identifier was not found | |||||||||||||||||||||||
406 | Not acceptable - there was an issue validating the input |
Section | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get single workflow ruleGet a single workflow rule from Aspire.
Path Parameters
Response
| ||||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||||
200 | Success | |||||||||||||||||||||||
404 | Not found - a given workflow identifier was not found | |||||||||||||||||||||||
406 | Not acceptable - there was an issue validating the input |
Section | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Create a workflow ruleCreate a single workflow rule in Aspire.
Path Parameters
Body Parameters The request body parameters will differ depending on the type of rule created. Some examples are shown below
Optionally you may opt to add the created rule to a workflow event by adding the following query parameters
Response when parentId used
Response without parentId
Status | |||||||||||||||||||||||||||||||||||||||||||||
Response code | Description | ||||||||||||||||||||||||||||||||||||||||||||
200 | Success | ||||||||||||||||||||||||||||||||||||||||||||
404 | Not found - a given workflow identifier was not found | ||||||||||||||||||||||||||||||||||||||||||||
406 | Not acceptable - there was an issue validating the input |
} |
Status: 200, 404, 406
Section | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update single workflow ruleUpdatee a single workflow rule in Aspire.
Path Parameters
Body Parameters The request body parameters will differ depending on the type of rule created. See Create a workflow rule above Response
| ||||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||||
200 | Success | |||||||||||||||||||||||
404 | Not found - a given workflow identifier was not found | |||||||||||||||||||||||
406 | Not acceptable - there was an issue validating the input |
Section | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete single workflow ruleDeletes a single workflow rule from Aspire.
Path Parameters
Response
Status | ||||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||||
200 | Success | |||||||||||||||||||||||
404 | Not found - a given workflow identifier was not found | |||||||||||||||||||||||
406 | Not acceptable - there was an issue validating the input |
Status: 200, 404, 406
Section | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Get workflow item types (TODO: to be moved)Lists all available workflow item types
Response
| ||||||||||||
Response code | Description | Success |
Section | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get specific workflow items by type (TODO: to be moved)Returns a workflow item by its type
Path Parameters
Example
Response
| |||||||||||||||||||||||||
Response code | Description | Success |
Section | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Get workflow item type dxf (TODO: to be moved)Returns the dxf for a specific workflow item type
Response
| ||||||||||||
Response code | Description | |||||||||||
200 | Success | 404 | Not found - a given service identifier was not found