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 | 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 Parameters
Response
| ||||||||||||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||||||||||||
200 | Success | |||||||||||||||||||||||||||||||
404 | The given workflow id was not found |
Section | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add single workflowAdds a single workflow to Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed. | |||||||||||||||||||||||||||||||||
Section | |||||||||||||||||||||||||||||||||
Add a workflowAdds a workflow to Aspire
Request Body Parameters
Query String Parameters
ExamplesExample Add a single workflow
Response
| |||||||||||||||||||||||||||||||||
Response code | Description | ||||||||||||||||||||||||||||||||
201 | Created | ||||||||||||||||||||||||||||||||
406 | Not acceptable - there was an issue validating the input |
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 | |||||||||||||
Section | |||||||||||||
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
|
Delete multiple workflows
Code Block | ||
---|---|---|
| ||
DELETE /aspire/_api/workflows?id=AAABcID5GBc%3D&id=AAABcIueWUc%3D |
|
Response
Code Block | ||
---|---|---|
| ||
{ "message": "optionaldelete 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
Path Parameters and Query parameters
Body Parameter
ExamplesResponse
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 | |||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a workflow eventGet a event from a workflow in Aspire, this endpoint need the at least the OPERATOR role to be executed Create workflow event(s)Create one or more workflow events in Aspire.
Path Parameters
ExamplesResponse Create a single event
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": "onAddUpdate{ "id": "72022651-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": { "idruleId": "AAABcQwxWUc=5d1273b8-9dc0-4f6d-89f3-fe6f331a6067", ... } } } "messageenabled": "optional response message" } |
Status
Delete one or more services from Aspire.
Panel | ||||
---|---|---|---|---|
| ||||
|
Path Parameters
The identifier of the event to use
Request Body Parameters
The request body parameters will differ depending on the type of item created. See Create a workflow event item above
Response
Code Block | ||
---|---|---|
| ||
{ "workflow": { "id": "AAABcIueWUc=", "description": "Publish to Elasticsearch" "event": { true } }, { "id": "onError" }, { "id": "onAddUpdateonIdentity", "rule": { "id": "AAABcQwxWUc=" }, ... }{ } } "message": "optional response message" } |
Status
"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 Delete a workflow event itemDelete one or more services from Aspire.
Path Parameters
Response Examples Create multiple events (body parameter)
StatusResponse Response
| |||||||||||||||||||||||||||||||
200 | Success | ||||||||||||||||||||||||||||||
404 | Not found - a given workflow identifier was not found | ||||||||||||||||||||||||||||||
406 | Not acceptable - there was an issue validating the input | ||||||||||||||||||||||||||||||
Section |
Panel | ||||
---|---|---|---|---|
| ||||
|
Path Parameters
Body Parameters
Response
Code Block | ||
---|---|---|
| ||
{
"message": "optional response message"
} |
Status
| |
{
"workflow": {
"id": "AAABcIueWUc=",
"description": "Publish to Elasticsearch"
"event": {
"id": ["scan", "addUpdate"]
}
}
} |
Status: 200, 404, 406
Section | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete a workflow eventDelete a workflow event from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
Path Parameters
Response
Status: 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.
Path Parameters
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update a workflow event itemUpdate 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. 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 | ||||||||||||||||||||||||||||||||||||
Section | ||||||||||||||||||||||||||||||||||||
Get workflow templates - Review pendingRetrieve all workflow templates from Aspire.
Path and Query String Parameters
Response
Body Parameters The request body parameters will differ depending on the type of rule created. See Create a workflow rule above 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 | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete single workflow ruleDeletes a single workflow rule from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed Get a workflow template - Review pendingRetrieve 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 | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete workflow rulesDeletes a single workflow rule 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
Query 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 | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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
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
Response
Code Block | ||||
---|---|---|---|---|
| ||||
{ "workflowexport": { "idworkflows": "AAABcIueWUc=", "description": "Publish to Elasticsearch" { "eventworkflow": {[ "id": "onAddUpdate", { "rule": { "id": "ddSWeq123<workflow_id>", "descriptiontype": "Some ruleconnector", "typedescription": "applicationmyWorkflow", ... } } } "message": "optional response message" } |
Status
Delete one or more services from Aspire.
Panel | ||||
---|---|---|---|---|
| ||||
|
Path Parameters
Request 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
Code Block | ||
---|---|---|
| ||
{ "workflow": { "id": "AAABcIueWUc=", "description": "Publish to Elasticsearch" "eventtemplates": { "template": [ ... ] }, "events": { "event": [ ... ] }, "rules": { "id": "onAddUpdate", "rule": {[ "id": "ddSWeq123", ... "description": "Some rule", ] "type": "application", ...} } } }] "message": "optional response message" } } } |
: 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 |
.
|
Path Parameters
Request Body Parameters
The request body parameters will differ depending on the type of rule created. See Create a workflow rule above
Filters: The connection filter definition here Response
|
Status
Delete one or more workflows from Aspire.
Panel | ||||
---|---|---|---|---|
| ||||
|
Path and Request Body Parameters
The identifier of the workflow from which to delete rule(s)
or the identifier of the rule to delete when used in the body
Examples
Delete multiple workflows
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:
|
Code Block | ||
---|---|---|
| ||
DELETE /aspire/_api/workflows/AAABcID5GBc%3D/rule?ruleId=AAABcID5GBc%3D&ruleId=AAABcIueWUc%3D |
Response
Code Block | ||
---|---|---|
| ||
{
"message": "optional response message"
} |
Status
Duplicates a workflow rule.
Panel | ||||
---|---|---|---|---|
| ||||
|
Path Parameters
Response
Code Block | ||
---|---|---|
| ||
{ "workflow": { "id": "AAABcIueWUc=", "description": "Publish to Elasticsearch" "event": { "ids" : ["idID1":, "onAddUpdateID2", "ID3", ...], "ruletype" : { "TYPE", "iddescription" : "ddSWeq123DESCRIPTION", "descriptiondeleteIncrementalPolicy": "Some ruledeletePolicyId", "credentials" : "credentialId", "throttlePolicy" : "throttlePolicyId", "routingPolicies" : ["RP1", "typeRP2":, "applicationRP3", ...] } } } "message": "optional response message" } |
Status