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
Easy Heading Free | ||||||
---|---|---|---|---|---|---|
| ||||||
Section | |||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
List Get all workflowsLists all the workflows configured in the Aspire, this endpoint need the at least the OPERATOR role to be executed.
Pagination query string parameters Sorting query string parameters Query String Parameters
Response
Response
| |||||||||||||||||||||||||||||||||||||||
Response code | Description | 200 | Success
Section | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a single workflowGet information about a single workflow in Aspire, this endpoint need the at least the OPERATOR role to be executed.
Path Parameters
Query String ParametersResponse
Response
| ||||||||||||||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||||||||||||||
200 | Success | 404 | The given workflow id was not found
Section | |||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Addasingle workflowAdds a single workflow to Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
Request Body Parameters
Query String Parameters
Examples Add a single workflow:Example
Response
| |||||||||||||||||||||||||||||||||||||||
Response code | Description | ||||||||||||||||||||||||||||||||||||||
201 | Created | ||||||||||||||||||||||||||||||||||||||
406 | Not acceptable - there was an issue validating the input | ||||||||||||||||||||||||||||||||||||||
Section | |||||||||||||||||||||||||||||||||||||||
: 200, 406 |
Section | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update workflows, filteredUpdate connectors configured in the Aspire, filtered by a specified criteria, this endpoint need the at least the ADMINISTRATOR role to be executed Delete workflow(s)Delete one or more workflow from Aspire.
Path and Request Body Parameters
Response
Status: 200, 406 |
Section | |||||||
---|---|---|---|---|---|---|---|
Delete multiple workflows, filteredDelete multiple workflows from Aspire, filtered by a specified criteria, this endpoint need the at least the ADMINISTRATOR role to be executed.
| |||||||
Name | Type | Required | Description | ||||
id | string | Required | The identifier(s) of the workflow(s) to delete |
Code Block | ||
---|---|---|
| ||
DELETE
|
ResponseDelete multiple workflows
Code Block | ||
---|---|---|
| ||
DELETE /aspire/_api/workflows
{
"id": [ "AAABcID5GBc=", "AAABcIueWUc=" ]
} |
Response
Code Block | ||
---|---|---|
| ||
{ "message": "optional { "message": "delete result response message" } |
: 200, 404, 406
Section | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete workflow(s)Delete one or more workflows from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed Get a workflow eventGet a event from a workflow in Aspire.
Path Parameters and Query parameters
Body Parameter
ExamplesResponse
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 |
DELETE /aspire/_api/workflows/AAABcID5GBc
DELETE /aspire/_api/workflows?id=AAABcID5GBc&id=AAABcID5GBd
POST /aspire/_api/workflows/delete
{
"ids":["AAABcID5GBc","AAABcID5GBd"]
}
|
Response
Code Block | ||
---|---|---|
| ||
{
"message": "delete result response message"
} |
Status: 200, 404, 406
Section | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a workflow eventGet a event from a workflow in Aspire, this endpoint need the at least the OPERATOR role to be executed | ||||||||||||||||||||||||||||||||||||||||
Section | ||||||||||||||||||||||||||||||||||||||||
Create workflow event(s)Create one or more workflow events in Aspire.
Path Parameters
Examples Create a single event Response
Create multiple events
Create multiple events (alternative version)
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 | |||||||||||||||||||||||||||||||||||||||
Section | ||||||||||||||||||||||||||||||||||||||||
Status: 200, 404, 406 |
Section | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get workflow eventsGet a event from a workflow in Aspire, this endpoint need the at least the OPERATOR role to be executed Delete a workflow eventDelete a workflow event from Aspire.
Path and Request Body 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 | ||||||||||||||||||||||||
Section | |||||||||||||||||||||||||
Create a workflow event itemCreate a workflow event item - a rule, condition and the like.
Path Parameters | |||||||||||||||||||||||||
Name | Type | Required | Description | ||||||||||||||||||||||
id | string | Required | The identifier of the workflow(s) to return | ||||||||||||||||||||||
eventId | string | Required | The identifier of the event to get | ||||||||||||||||||||||
type | string | Required | The type of the item to create | ||||||||||||||||||||||
Item Type | Parameter Name | Parameter Type | Required | Description | |||||||||||||||||||||
Reference | parentId | string | Optional | The identifier of the node in to which the item should be inserted. Defaults to the root node | orderId | integer | Required | The position (which in the children of the parent node) where this reference should be inserted | ruleId | String | Required | The rule to be referenced | enabled | boolean | Optional | Whether or not the item is enabled (default true) | |||||||||
Condition | parentId | string | Optional | The identifier of the node in to which the item should be inserted. Defaults to the root node | value | object | Required | The value to be compared against | enabled | boolean | Optional | Whether or not the item is enabled (default true) | |||||||||||||
Exit | parentId | string | Optional | The identifier of the node in to which the item should be inserted. Defaults to the root node | orderId | integer | Required | The position (which in the children of the parent node) where this reference should be inserted | enabled | boolean | Optional | Whether or not the item is enabled (default true) |
Code Block | ||
---|---|---|
| ||
{ "workflow": { "id": "AAABcIueWUc=", "description": "Publish to Elasticsearch" "event": { "id": "onAddUpdate72022651-c2f4-45a9-9e18-2b0ace529cda", "type": "connector", "description": "Test Workflow", "checksum": "2b8dc08a2da838304528b4695109e2379da9a670c5a195dcd27355e8daa20a8b", "events": { "event": [ { "id": "onScan" }, { "id": "onAddUpdate" }, { "id": "onDelete" }, { "id": "onPublish", "item": { "id": "404fefb7-b7f4-48cf-a7b1-81872587a85b", "type": "reference", "rule": { "ruleId": "5d1273b8-9dc0-4f6d-89f3-fe6f331a6067", "id "enabled": "AAABcQwxWUc=", true ... } }, } } |
Status
{
"id": "onError"
},
{
"id": "onIdentity"
},
{
"id": "onIdentityError"
}
]
}
}
} |
Status: 200, 404, 406
Section | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Create workflow event(s)Create one or more workflow events in Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
Path Parameters
| |||||||||||||||||||||||||||||||||
Section | |||||||||||||||||||||||||||||||||
Update a workflow event itemDelete one or more services from Aspire.
Path Parameters
Request Body Parameters The request body parameters will differ depending on the type of item created. See Create a workflow event item aboveExamples Create multiple events (body parameter)
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 a workflow eventDelete a workflow event from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed | ||||||||||||||||||||||||||||
Section | ||||||||||||||||||||||||||||
Delete a workflow event itemDelete one or more services from Aspire.
Path 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 | ||||||||||||||||||||||||||||
: 200, 404, 406 |
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Create a workflow event itemCreate a workflow event item - a rule, condition and the like, this endpoint need the at least the ADMINISTRATOR role to be executed Move a workflow event itemDelete one or more services from Aspire.
Path Parameters
Body Parameters
Body Parameters The request body parameters will differ depending on the type of item created. Some examples are shown below
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
Get workflow templatesRetrieve all workflow templates from Aspire.
Path and Query String 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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
Get a workflow templateRetrieve a workflow templates 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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
Status: 200, 404, 406 |
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update a workflow event itemUpdate a workflow event item from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed Get workflow rulesGet all the rules for a given workflow.
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body Parameters The request body parameters will differ depending on the type of item created. Some examples are shown below
Response
Get a workflow ruleGet one or more workflow rule from Aspire.
Path Parameters | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Name | Type | Required | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string | Required | The identifier of the workflow to return rules for | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ruleId | string | Required | The identifier of the rule to get |
Code Block | ||
---|---|---|
| ||
{ "workflow": { "id": "AAABcIueWUc=", "description": "Publish to Elasticsearch" "event": { "id": "onAddUpdate", "rule": { "id": "ddSWeq123AAABcQwxWUc=", "description": "Some rule", ... "type": "application", ... } } } "message": "optional response message" } |
: 200, 404, 406
Section | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete single workflow event itemDelete a workflow event item from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed Create a workflow ruleDelete one or more services from Aspire.
Path Parameters
Request Body Parameters The request body parameters will differ depending on the type of rule created. Some examples are shown below | |||||||||||||||
Rule Type | Parameter Name | Parameter Type | Required | Description | groovy | <TODO> | application |
use | |||
eventId | string | Required | The identifier of the event to use |
Optionally you may opt to add the created rule to a workflow event by adding the following query parameters
Parameter Name | Parameter Type | Required | Description | ||
---|---|---|---|---|---|
parentId | string | Required | The identifier of the node | in to whichwith the item | should be inserted. Defaults to the root nodeto be deleted |
itemIdorderId | integer | Required | The position (which in the children of the parent node) where this reference should be inserted | ||
enabled | boolean | Optional | Whether or not the item is enabled (default true) | ||
identifier of the item to delete |
ResponseResponse when parentId used
Code Block | ||
---|---|---|
| ||
{ "workflowmessage": { "id": "AAABcIueWUc=", "description": "Publish to Elasticsearch" "event": { "id": "onAddUpdate", "rule": { "id": "ddSWeq123", "description": "Some rule", "type": "application", ... } } } } |
Response without parentId
Code Block | ||
---|---|---|
| ||
{
"workflow": {
"id": "AAABcIueWUc=",
"description": "Publish to Elasticsearch"
"rule": {
"id": "ddSWeq123",
"description": "Some rule",
"type": "application",
...
}
}
} |
Status
delete result response message"
} |
Status: 200, 404, 406
Section | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Move a workflow event itemMove a workflow event item from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
Path Parameters
Body Parameters
Response
Status: 200, 404, 406 |
Section | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get workflow templatesRetrieve all workflow templates from Aspire, this endpoint need the at least the OPERATOR role to be executed Update a workflow ruleDelete one or more services from Aspire.
Path Parameters
Response string
| Required | The identifier of the rule to update |
| ||
{
"template": [{
|
Request Body Parameters
The request body parameters will differ depending on the type of rule created. See Create a workflow rule above
Response
Code Block | ||
---|---|---|
| ||
{ "workflow": { "id": "AAABcIueWUc=AAABcQwrWUc", "description": "Publish to Elasticsearch" ... "rule": { }, "id": "ddSWeq123AAABcQwrWUd", "description": "Some rule", "type": "application", ... } } } |
Status
...
}]
} |
Status: 200, 404, 406
Section | |||||||
---|---|---|---|---|---|---|---|
Get single workflow templateRetrieve a single workflow templates from Aspire, this endpoint need the at least the OPERATOR role to be executed | |||||||
Section | |||||||
Delete workflow rule(s)Delete one or more workflows from Aspire.
Path and Request Body Parameters | |||||||
Name | Type | Required | Description | ||||
id | string | Required | The identifier of the workflow from which to delete rule(s) or the identifier of the rule to delete when used in the body | ||||
ruleId | string | Required | The identifier of the rule to delete |
Code Block | ||
---|---|---|
| ||
DELETE /aspire/_api/workflows/AAABcID5GBc%3D/rule
{
"id": [ "AAABcID5GBc=", "AAABcIueWUc=" ]
} |
Response
Code Block | ||
---|---|---|
| ||
{
"message": "optional response message"
} |
Status
|
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The identifier of the workflow to get the templates for |
templateId | string | Required | The identifier of the template to get |
Response
Code Block | ||
---|---|---|
| ||
{
"template": [{
"id": "AAABcQwrWUc",
...
}]
} |
Status: 200, 404, 406
Section | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get single workflow ruleGet a single workflow rule from Aspire, this endpoint need the at least the OPERATOR role to be executed.
Path Parameters
Response
Status: 200, 404, 406 |
Section | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get workflow rulesGet workflow rules from Aspire, this endpoint need the at least the OPERATOR role to be executed.
Path Parameters
Response
Status: 200, 404, 406 |
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Create a workflow ruleCreate a single workflow rule in Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
Path Parameters
Body Parameters The request body parameters will differ depending on the type of rule created.
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: 200, 404, 406 |
Section | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update single workflow ruleUpdatee a single workflow rule in Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
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: 200, 404, 406 |
Section | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete single workflow ruleDeletes a single workflow rule from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
Path Parameters
Response
Status: 200, 404, 406 |
Section | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete workflow rulesDeletes a single workflow rule from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
Path Parameters
Query Parameters
Response
Status: 200, 404, 406 |
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Export workflow(s)Export one or more workflows from Aspire, this endpoint needs at least the OPERATOR role to be executed.
Path Parameters and Query parameters
Body Parameter
Examples
Response
Status: 200, 404, 406
|
Section |
---|
ImportThe import usage can be found here |
Section | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Filters
Some endpoint queries require a filter. A filter is basically a JSON object with the following format: Seed filter:
|