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 | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
List workflowsLists all the workflows configured in the Aspire
Query String Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a single workflowGet information about a single workflow in Aspire
Path Parameters
Response
Status
|
Section | |||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add a workflowAdds a workflow to Aspire
Request Body Parameters
Query String Parameters
Examples Add a single workflow
Response
Status
|
Section | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete workflow(s)Delete one or more workflow from Aspire.
Path and Request Body Parameters
Examples Delete a single workflow
Delete multiple workflows
Delete multiple workflows(alternative form)
Response
Status
|
Section | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a workflowplaneventGet a plan event from a workflow in Aspire.
Path Parameters
Response
Status
|
Section | |||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Create workflowplanevent(s)Create one or more workflow plans events in Aspire.
Path Parameters
Examples Create a single planevent
Create multiple plansevents
Create multiple plans events (alternative version)
Response
Status
|
Section | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete a workflowplaneventDelete a workflow plan event from Aspire.
Path and Request Body Parameters
Response
Status
|
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Create a workflowplanevent itemCreate a workflow plan event item - a rule, condition and the like.
Path Parameters
Request 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 workflowplanevent 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 plan event item above Response
Status
|
Section | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete a workflowplanevent itemDelete one or more services from Aspire.
Path Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Move a workflowplanevent itemDelete one or more services from Aspire.
Path Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get workflow templatesRetrieve all workflow templates from Aspire.
Path and Query String Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a workflow templateRetrieve a workflow templates from Aspire.
Path Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get workflow rulesGet all the rules for a given workflow.
Path Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a workflow ruleDelete one or more services from Aspire.
Path Parameters
Response
Status
|
Section | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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
Response
Status
|
Section | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update 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. See Create a workflow rule above Response
Status
|
Section | |||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete workflow rule(s)Delete one or more services from Aspire.
Path and Request Body Parameters
Examples Delete a single rule
Delete multiple rules
Delete multiple rules (alternative version)
Response
Status
|
Section | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Copy (duplicate) a workflow rule?? Needed ?? Duplicates a workflow rule.
Path Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Share a workflow rule?? Needed ?? Move a workflow rule to a shared library.
Path Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get workflow libraries?? Needed ?? Get all of the workflow libraries
Query String Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a workflow library?? Needed ?? Get a single workflow library.
Path and Request Body Parameters
Response
Status
|
Section | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Reload workflow libraries?? Needed ?? Reload all workflow libraries.
Response
Status
|