The workflow API provides functionality that allows a administrator to perform actions such as adding and configuring workflow
Easy Heading Free | ||||||
---|---|---|---|---|---|---|
| ||||||
Section | |||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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
Status: 200 |
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 Parameters
Response
Status: 200, 404 |
Section | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add single workflowAdds a single workflow to Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
Body Parameters
Query String Parameters
Example
Response
Status: 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.
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.
Response
Status: 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.
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, this endpoint need the at least the OPERATOR role to be executed.
Path Parameters
Response
Status: 200, 404, 406 |
Section | |||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Create Get workflowevent(s)eventsGet a event from a workflow Create one or more workflow events in Aspire, this endpoint need the at least the ADMINISTRATOR OPERATOR role to be executed.
Path Parameters
Examples Create multiple events (body parameter)
Response
Response
Status: 200, 404, 406 | |||||||||||||||||||||||||||||||
Section |
Panel | ||||
---|---|---|---|---|
| ||||
|
Path Parameters
Response
Code Block | ||
---|---|---|
| ||
{
"message": "delete result response message"
} |
Status: 200, 404, 406
Create a workflow event item - a rule, condition and the like, this endpoint need the at least the ADMINISTRATOR role to be executed.
Panel | ||||
---|---|---|---|---|
| ||||
|
Path Parameters
Body Parameters
The request body parameters will differ depending on the type of item created. Some examples are shown below
Response
Code Block | ||
---|---|---|
| ||
{ "workflow": { "id": "onScan" }, { "id": "onAddUpdate" }, { "id": "onDelete" }, { "id": "onPublish", "item": { "id": "404fefb7-b7f4-48cf-a7b1-81872587a85b", "type": "reference", "ruleId": "5d1273b8-9dc0-4f6d-89f3-fe6f331a6067", "enabled": true } }, { "id": "AAABcIueWUc=onError", "description": "Publish to Elasticsearch" "event": { }, "id": "onAddUpdate", "rule": { "id": "AAABcQwxWUc=onIdentity", ... }, }{ } } "id": "onIdentityError" } ] } } } |
Status: 200, 404, 406
Section | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update a Create workflow eventitem(s)Create one or more workflow events in Update a workflow event item from 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 item created. See Create a workflow event item above Examples Create multiple events (body parameter)Response
Response
|
Section | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Deletesinglea workflow eventitemDelete a workflow event item from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
Path Path Parameters
Response string
| Required | The identifier of the node with the item to be deleted |
| ||
{
" |
Response
Code Block | ||
---|---|---|
| ||
{
"message": "delete result response message"
} |
Status: 200, 404, 406
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Move Create a workflow event itemMove Create a workflow event item from Aspire- a rule, condition and the like, this endpoint need the at least the ADMINISTRATOR role to be executed.
Path Parameters
Body Parameters
Response
Status: 200, 404, 406 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body Parameters The request body parameters will differ depending on the type of item created. Some examples are shown below
Get workflow templatesRetrieve all workflow templates from Aspire, this endpoint need the at least the OPERATOR role to be executed.
Path Parameters
Response
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.
Path Parameters
Response
Status: 200, 404, 406
Status: 200, 404, 406 |
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update a workflow event itemUpdate a workflow event item | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Get single workflow ruleGet a single workflow rule from Aspire, this endpoint need the at least the OPERATOR ADMINISTRATOR role to be executed.
Path Parameters
Response
Status: 200, 404, 406 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body Parameters The request body parameters will differ depending on the type of item created. Some examples are shown below
Response
Status: 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.
Path Parameters
Response
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.
Path Parameters
Response
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.
Path Parameters
Response
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
Create a workflow ruleCreate a single workflow rule in Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
Path Parameters | ||||||||||||||||||||||||||||||||||||||||||||||||||
Name | Type | Required | Description | |||||||||||||||||||||||||||||||||||||||||||||||
id | string | Required | The identifier of the workflow to create a rule for | |||||||||||||||||||||||||||||||||||||||||||||||
Rule Type | ||||||||||||||||||||||||||||||||||||||||||||||||||
groovy | ||||||||||||||||||||||||||||||||||||||||||||||||||
application | ||||||||||||||||||||||||||||||||||||||||||||||||||
Parameter Name | Parameter Type | Required | Description | |||||||||||||||||||||||||||||||||||||||||||||||
parentId | string | Optional | The identifier of the node in to which the item should be inserted. Defaults to the root node | |||||||||||||||||||||||||||||||||||||||||||||||
orderId | integer | Optional | The position (which in the children of the parent node) where this reference should be inserted |
Code Block | ||
---|---|---|
| ||
{ "workflow": { "id": "AAABcIueWUc=", "description": "Publish to Elasticsearch" "event": { "id": "onAddUpdate", "rule": {[ "id": "ddSWeq123", ... "description": "Some rule", ] "type": "application", } ...} }] } } } |
Status: 200, 404, 406
Section | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Export multiple connections, filteredExport multiple connections from Aspire, filtered by a specified criteria, this endpoint needs at least the OPERATOR role to be executed.
Filters: The connection filter definition here Response
|
Status: 200, 404, 406
Updatee a single workflow rule in Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
Panel | ||||
---|---|---|---|---|
| ||||
|
Path Parameters
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=",
"description": "Publish to Elasticsearch"
"rule": {
"id": "ddSWeq123",
"description": "Some rule",
|
Status: 200, 404, 406
Status: 200 |
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:
| |||||||||||||
Section |
Panel | ||||
---|---|---|---|---|
| ||||
|
Path Parameters
The identifier of the workflow from which to delete rule(s)
Response
Code Block | ||
---|---|---|
| ||
{
"message": "delete result response message"
} |
Status: 200, 404, 406
Deletes a single workflow rule from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
Panel | ||||
---|---|---|---|---|
| ||||
|
Path Parameters
The identifier of the workflow from which to delete rule(s)
Query Parameters
One or more rule ids to be deleted
Response
Code Block | ||
---|---|---|
| ||
{
"message": "delete result response message"
} |