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 | 200 | 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 | ||||||||||||||||||||||||||||||||||||
Section | ||||||||||||||||||||||||||||||||||||
Add a workflowAdds a single workflow to Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
Request Body Parameters
Query String Parameters
Examples Add a single workflow
Example
Response
| ||||||||||||||||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||||||||||||||||
201 | Created | |||||||||||||||||||||||||||||||||||
406 | Not acceptable - there was an issue validating the input | |||||||||||||||||||||||||||||||||||
Section | ||||||||||||||||||||||||||||||||||||
: 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 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.
Response | |||||||
Name | Type | Required | Description | ||||
id | string | Required | The identifier(s) of the workflow(s) to delete |
Code Block | ||
---|---|---|
| ||
{
"id": "AAABcID5GBc="
} |
Delete multiple workflows
Code Block | ||
---|---|---|
| ||
[{
"id": "AAABcID5GBc="
},
{
"id": "AAABcIueWUc="
}] |
Delete multiple workflows(alternative form)
Code Block | ||
---|---|---|
| ||
{ "idmessage": ["AAABcID5GBc=", "AAABcIueWUc="] } |
Response
Code Block | ||
---|---|---|
| ||
{
"message": "optional response message"
} |
Status
"delete result response message"
} |
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 Get a workflow planGet a plan from a workflow in Aspire.
Path 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 plan(s)Create one or more workflow plans in Aspire.
Path Parameters
ExamplesResponse Create a single plan
Create multiple plans
Create multiple plans (alternative version)
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 workflow eventsGet a event from a workflow in Aspire, this endpoint need the at least the OPERATOR role to be executed Delete a workflow planDelete a workflow plan 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 |
"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",
"ruleId": "5d1273b8-9dc0-4f6d-89f3-fe6f331a6067",
"enabled": true
}
},
{
"id": "onError"
},
{
"id": "onIdentity"
},
{
"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.
Path Parameters
Examples Create multiple events (body parameter)
Response
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
| ||||||||||||||||||||||||
Section | ||||||||||||||||||||||||
Create a workflow plan itemCreate a workflow plan item - a rule, condition and the like.
Path Parameters | ||||||||||||||||||||||||
Name | Type | Required | Description | |||||||||||||||||||||
id | string | Required | The identifier of the workflow(s) to return | |||||||||||||||||||||
planId | string | Required | The identifier of the plan to get | |||||||||||||||||||||
type | string | Required | The type of the item to create | |||||||||||||||||||||
Item Type | Parameter Name | Parameter Type | Required | Description | Rule | <TODO> | Application Rule | Condition | Exit |
Code Block | ||
---|---|---|
| ||
{ "workflow": { "id": "AAABcIueWUc=", "description": "Publish to Elasticsearch" "plan": { "id": "onAddUpdate", "rule": { "id": "AAABcQwxWUc=", ... } } } "message": "optional response message" } |
Status
}]
} |
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 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
| |||||||||||||||||||||||||||||||
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 |
>>>>>>>>>>>>>>>>>>>>>>>>>> here <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
: 200, 404, 406 |
Section | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GetaworkflowplanrulesGet workflow rules from Aspire, this endpoint need the at least the OPERATOR role to be executedDelete one or more services 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 | ||||||||||||||||||||||||
Get a workflow planDelete one or more services from Aspire.
Path and Request Body Parameters | ||||||||||||||||||||||||
Name | Type | Required | Description | |||||||||||||||||||||
id | string | Required | The identifier of the workflow(s) to return | |||||||||||||||||||||
planId | string | Required | The identifier of the plan to get |
Code Block | ||
---|---|---|
| ||
{ "workflow": { com.accenture.aspire:app-publish-to-file", "idtype": "AAABcIueWUc=application", "description": "Publish to ElasticsearchFile", "plan "properties": { "debug": "false", "idlogFileType": "onAddUpdatetrue", } } "message": "optional response message" } |
Status
Delete one or more services from Aspire.
Panel | ||||
---|---|---|---|---|
| ||||
|
Path and Request Body Parameters
Response
Code Block | ||
---|---|---|
| ||
{ "workflow": { "id": "AAABcIueWUc=", "description": "Publish to Elasticsearch" "plan": { "id": "onAddUpdate" "logFile": "${app.name}/publishToFile.jobs", "numJobs": 5 }, "id": "5d1273b8-9dc0-4f6d-89f3-fe6f331a6067" } } "message": "optional response message" } |
Status
Delete one or more services from Aspire.
Panel | ||||
---|---|---|---|---|
| ||||
|
Path and Request Body Parameters
Response
Code Block | ||
---|---|---|
| ||
{
"workflow": {
"id": "AAABcIueWUc=",
"description": "Publish to Elasticsearch"
"plan": {
"id": "onAddUpdate"
}
}
"message": "optional response message"
} |
Status
}
} |
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 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Get a workflow planDelete one or more services from Aspire.
Path and Request Body Parameters | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Name | Type | Required | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string | Required | The identifier of the workflow(s) to return | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
planId | string | Required | The identifier of the plan to get |
Code Block | ||
---|---|---|
| ||
{ "workflow": { "id": "AAABcIueWUc=", "description": "Publish to Elasticsearch" "planevent": { "id": "onAddUpdate"", "rule": { } } "messageid": "optional response message" } |
Status
ddSWeq123",
"description": "Some rule",
"type": "application",
...
}
}
}
} |
Response without parentId
Delete one or more services from Aspire.
Panel | ||||
---|---|---|---|---|
| ||||
|
Path and Request Body Parameters
Response
Code Block | ||
---|---|---|
| ||
{ "workflow": { "id": "AAABcIueWUc=", "description": "Publish to Elasticsearch" "planrule": { "id": "ddSWeq123", "description": "Some rule", "type": "onAddUpdateapplication", } ... } "message": "optional response message"} } |
: 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 a workflow planDelete one or more services from Aspire.
Path and Request Body Parameters
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 planDelete one or more services from Aspire.
Path and Request Body Parameters
Response
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 | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete workflow rulesDeletes a single workflow rule from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed Get a workflow planDelete one or more services from Aspire.
Path and Request Body 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 Get a workflow planDelete one or more services from Aspire.
Path and Request Body Parameters
Examples
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Get a workflow planDelete one or more services from Aspire.
Path and Request Body Parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string | Required | The identifier of the workflow(s) to return | ||||||||||||||||||||||||||||||||||||||||||||||||||||
planId | string | Required | The identifier of the plan to get |
Code Block | ||
---|---|---|
| ||
{ "workflow": { "id": "AAABcIueWUc=", "description": "Publish to Elasticsearch" "plan": { "type": "connector", "description": "myWorkflow", "templates": { "template": [ ... ] }, "idevents": "onAddUpdate"{ } } "message": "optional response message" } |
Status
Delete one or more services from Aspire.
Panel | ||||
---|---|---|---|---|
| ||||
|
Path and Request Body Parameters
Response
Code Block | ||
---|---|---|
| ||
{
"workflow": {
"id": "AAABcIueWUc=",
"description": "Publish to Elasticsearch"
"plan": {
"id": "onAddUpdate"
}
}
"message": "optional response message"
} |
Status
"event": [
...
]
},
"rules": {
"rule": [
...
]
}
}
]
}
}
} |
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.
|
Delete one or more services from Aspire.
Panel | ||||
---|---|---|---|---|
| ||||
|
Path and Request Body Parameters
Response
|
Status
Delete one or more services from Aspire.
Panel | ||||
---|---|---|---|---|
| ||||
|
Path and Request Body Parameters
Response
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{
"workflow": {
"id": "AAABcIueWUc=",
"description": "Publish to Elasticsearch"
"plan": {
|
Status
Delete one or more services from Aspire.
Panel | ||||
---|---|---|---|---|
| ||||
|
Path and Request Body Parameters
Response
Code Block | ||
---|---|---|
| ||
{
"workflow": {
"id": "AAABcIueWUc=",
"description": "Publish to Elasticsearch"
"plan": {
"id": "onAddUpdate"
}
}
"message": "optional response message"
} |
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:
| |||||||||||||
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 | |||||||||||||
Get a workflow planDelete one or more services from Aspire.
Path and Request Body Parameters | |||||||||||||
Name | Type | Required | Description | ||||||||||
id | string | Required | The identifier of the workflow(s) to return | ||||||||||
planId | string | Required | The identifier of the plan to get |
Code Block | ||
---|---|---|
| ||
{ "workflow": { "idids" : ["ID1", "ID2", "AAABcIueWUc=ID3", ...], "descriptiontype" : "Publish to ElasticsearchTYPE", "plandescription" : {"DESCRIPTION", "id""deleteIncrementalPolicy": "deletePolicyId", "credentials" : "onAddUpdatecredentialId", "throttlePolicy" } } "message": "optional response message" } |
Status
: "throttlePolicyId",
"routingPolicies" : ["RP1", "RP2", "RP3", ...]
}
} |