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 workflow planGet a plan from a workflow in Aspire.
Path Parameters
Response
Status
|
Section | |||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Create workflow plan(s)Create one or more workflow plans in Aspire.
Path Parameters
Examples Create a single plan
Create multiple plans
Create multiple plans (alternative version)
Response
Status
|
Section | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete a workflow planDelete a workflow plan from Aspire.
Path and Request Body Parameters
Response
Status
|
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Create a workflow plan itemCreate a workflow plan 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 workflow plan itemDelete one or more services from Aspire.
Path and Request Body Parameters
Request Body Parameters The request body parameters will differ depending on the type of item created. See Create a workflow plan item above Response
Status
|
Section | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get Delete a workflow plan itemDelete one or more services from Aspire.
Path and Request Body Parameters
Response
Status
|
Section | |||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get Move a workflow plan itemDelete one or more services from Aspire.
Path and Request Body Parameters
Response
Status
|
>>>>>>>>>>>>>>>>>>>>>>>>>> here <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
Section | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a workflow planDelete one or more services from Aspire.
Path and Request Body Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a workflow planDelete one or more services from Aspire.
Path and Request Body Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a workflow planDelete one or more services from Aspire.
Path and Request Body Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a workflow planDelete one or more services from Aspire.
Path and Request Body Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a workflow planDelete one or more services from Aspire.
Path and Request Body Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a workflow planDelete one or more services from Aspire.
Path and Request Body Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a workflow planDelete one or more services from Aspire.
Path and Request Body Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a workflow planDelete one or more services from Aspire.
Path and Request Body Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a workflow planDelete one or more services from Aspire.
Path and Request Body Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a workflow planDelete one or more services from Aspire.
Path and Request Body Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a workflow planDelete one or more services from Aspire.
Path and Request Body Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a workflow planDelete one or more services from Aspire.
Path and Request Body Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a workflow planDelete one or more services from Aspire.
Path and Request Body Parameters
Response
Status
|
Section | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a workflow planDelete one or more services from Aspire.
Path and Request Body Parameters
Response
Status
|