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": "onAddUpdate" }, { "id": "onDelete" }, { "id": "onPublish", "item": { "id": "404fefb7-b7f4-48cf-a7b1-81872587a85b", "type": "reference", "ruleId": "5d1273b8-9dc0-4f6d-89f3-fe6f331a6067", "enabled": true } }, { "id": "onError" }, { "id": "onIdentity" }, { "id": "AAABcIueWUc=onIdentityError", "description": "Publish to Elasticsearch" "event": { "id": "onAddUpdate", } "rule": { "id": "AAABcQwxWUc=",] ... } } } } |
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 Response Examples Create multiple events (body parameter)
Response
Status: 200, 404, 406 |
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
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 ADMINISTRATOR role to be executed.
Path Parameters
Response
Status: 200, 404, 406 | |||||||||||||||||||||||||||||||||||||||||||||
Section |
Panel | ||||
---|---|---|---|---|
| ||||
|
Path Parameters
which the item should be inserted. The valid parents for condition items are references which ruleId is for a rule of type "choice". | ||||
value | object | Required | The value to be compared against | |
conditionType | String | Required | The value type, possible types are "string", "boolean", "integer", "long", "double", "float" | |
enabled | boolean | Optional | Whether or not the item is enabled (default true) | |
template | String | Required | The condition template id. | |
exit | parentId | string | Optional | The identifier of the node in to which the item should be inserted. Defaults to the root node. The valid parents for exit items are the root node, items of the type condition or references which ruleId is for a rule of type "folder" |
---|---|---|---|---|
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) |
Response
Code Block | ||
---|---|---|
| ||
{
"workflow": {
"id": "AAABcIueWUc=",
"description": "Publish to Elasticsearch"
"event": {
"id": "onAddUpdate",
"rule": {
"id": "AAABcQwxWUc=",
...
}
}
}
} |
Status: 200, 404, 406
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update a workflow event itemUpdate a workflow event item |
Code Block | ||
---|---|---|
| ||
{
"template": [{
"id": "AAABcQwrWUc",
...
}]
} |
Status: 200, 404, 406
Get a single workflow rule from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
Panel | ||||
---|---|---|---|---|
| ||||
|
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The identifier of the workflow(s) to return rules for |
ruleIdeventId | string | Required | The identifier of the rule event to get |
Response
Code Block | ||
---|---|---|
| ||
{
"workflow": {
"id": "AAABcIueWUc=",
"description": "Publish to Elasticsearch"
"rule": {
"id": "ddSWeq123",
"description": "Some rule",
"type": "application",
...
}
}
} |
Status: 200, 404, 406
type | string | Required | The type of the item to create |
Body Parameters
The request body parameters will differ depending on the type of item created. Some examples are shown below
Item Type | Parameter Name | Parameter Type | Required | Description |
---|---|---|---|---|
reference | parentId | string | Required | The identifier of the parent node of the item to update. The parent cannot be updated using this method, use the move event item method to change the parent. |
ruleId | String | Optional | The rule to be referenced, it must exist | |
enabled | boolean | Optional | Whether or not the item is enabled (default true) | |
condition | parentId | string | Required | The identifier of the parent node of the item to update. The parent cannot be updated using this method, use the move event item method to change the parent. |
value | object | Optional | The value to be compared against | |
type | String | Optional | The value type, possible types are "string", "boolean", "integer", "long", "double", "float" | |
enabled | boolean | Optional | Whether or not the item is enabled (default true) | |
template | String | Optional | The condition template id. | |
exit | parentId | string | Required | The identifier of the parent node of the item to update. The parent cannot be updated using this method, use the move event item method to change the parent. |
enabled | boolean | Optional | Whether or not the item is enabled (default true) |
Response
Code Block |
---|
Create 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.
Optionally you may opt to add the created rule to a workflow event by adding the following query parameters
Response when parentId used
Code Block | ||
---|---|---|
| ||
{ "workflow": { "id": "AAABcIueWUc=", "description": "Publish to Elasticsearch" "event": { "id": "onAddUpdate", "rule": { "id": "ddSWeq123AAABcQwxWUc=", "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: 200, 404, 406
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
| ||||||||||||||||||||||||||||||
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
Status: 200, 404, 406 |
Section | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Move a workflow event itemMove a workflow event item | ||||||||||||||||||||||||||||||||
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
Body Parameters
Response
Status: 200, 404, 406 | ||||||||||||||||||||||||||||||||
Section |
Panel | ||||
---|---|---|---|---|
| ||||
GET /aspire/_api/workflows/itemType |
event item to move | |||
dest | string | Required | The identifier of the new parent for the moved item |
orderId | integer | Optional | The position (which in the children of the parent node) where this item should be inserted. For example 0 means at the beginning, in the case of using a number greater than the current number of children within the parent node the item will be inserted at the end. If no provided the item will be moved at the end of the children list of the new parent. |
Response
Code Block | ||
---|---|---|
| ||
{
"message": "move result response message"
} |
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
Status: 200, 404, 406
|
Code Block | ||
---|---|---|
| ||
{
type: [ "application", "publisher", "function"]
} |
Status: 200
Returns a workflow item by its type
Panel | ||||
---|---|---|---|---|
| ||||
GET /aspire/_api/workflows/itemType/:id |
Path Parameters
The identifier of the workflow item type
Example
Code Block | ||
---|---|---|
| ||
/aspire/_aspire/workflows/types/applications |
Response
Code Block | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||
{
items: [{
"id": "AAABcID5GBc="
"type": "application",
"description": "Application_1"
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: Get workflow item type dxf (TODO: to be moved)Returns the dxf for a specific workflow item type
Response
|