Warning | ||
---|---|---|
| ||
This page is in development and as such, its contents may be incorrect |
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
Response
| ||||||||||||||||||||||||||||||||||
Response code | Description | Success |
Section | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Getall workflows, filtereda single workflowGet information about a single workflow in AspireLists workflows configured in the Aspire, filtered by a specified criteria
Pagination query string parameters
Path Query String Parameters
| ||||||||||||||||
Section | ||||||||||||||||
Response
Get a single workflowGet information about a single workflow in Aspire
Path Parameters | ||||||||||||||||
Name | Type | Required | Description | |||||||||||||
id | string | Required | The id of the workflow to return |
Code Block | ||
---|---|---|
| ||
{
"workflow": {
"id": "AAABcID5GBc=",
"description": "Publish to Elasticsearch",
...
}
} |
: 200, 404
Section | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add single workflowAdds | |||||||||||||||||||||||||||||||||
Section | |||||||||||||||||||||||||||||||||
Add single workflowAdds a single workflow to Aspire
Body Parameters
Query String Parameters
Example
Response
| |||||||||||||||||||||||||||||||||
Response code | Description | ||||||||||||||||||||||||||||||||
201 | Created | ||||||||||||||||||||||||||||||||
406 | Not acceptable - there was an issue validating the input |
Section | |||||||
---|---|---|---|---|---|---|---|
Update | |||||||
Section | |||||||
Delete multiple workflows, filteredDelete multiple workflows from Update connectors configured in the Aspire, filtered by a specified criteria
Body Parameters | |||||||
Name | Type | Required | Description | ||||
filter | JSON | Required | Filters workflows to be deleted. Check the filter definition here |
Code Block | ||
---|---|---|
| ||
{
|
Response
Code Block | ||
---|---|---|
| ||
{ "message": "optionalupdate result response message" } |
See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors
Status
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 Delete single workflowDelete a single workflow from Aspire.
Path Parameters
ExampleExamples
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 a workflow eventGet a event from a workflow in Aspire.
Path Parameters
Response
Status
|
Section | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Create workflow event(s)Create one or more workflow events in Aspire.
Path Parameters
Examples Create a single event Create multiple events (body parameter)
Create multiple events (alternative version) Response
Status
|
Section | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete a workflow eventDelete a workflow event from Aspire.
Path Parameters
Response
Status
|
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
Status
|
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
Status
|
Section | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete single workflow event item
Path Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Move a workflow event itemDelete one or more services from Aspire.
Path Parameters
Body Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get workflow templatesRetrieve all workflow templates from Aspire.
Path Parameters
Query String Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get single workflow templateRetrieve a single workflow templates from Aspire.
Path Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get single workflow ruleGet a single workflow rule from Aspire.
Path Parameters
Response
Status
|
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
|
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
Status
|
Section | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete single workflow ruleDeletes a single workflow rule from Aspire.
Path Parameters
Response
Status
|
Section | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get workflow item types (TODO: to be moved)Lists all available workflow item types
Response
Status
|
Section | |||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get specific workflow items by type (TODO: to be moved)Returns a workflow item by its type
Path Parameters
Example
Response
Status
|
Section | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get workflow item type dxf (TODO: to be moved)Returns the dxf for a specific workflow item type
Response
Status
|