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 | |||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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 from
Optional | Indicates the initial page to be retrieved | size | integer | Optional | Specifies the size of results page | sortBy | string | Optional | Field by which results are sorted | sortMode | string | Optional | Sort mode
expand | string | Optional | List of fields to expand, * will expand everything
Response
Response
| |||||||||||||||||||||||||||||||||
Response code | Description | Success |
Section | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Getall workflows, filtereda single workflowGet information about a single workflow in Aspire, this endpoint need the at least the OPERATOR role to be executed.Lists workflows configured in the Aspire, filtered by a specified criteria
Query String Path Parameters
Body Parameters | |||||||||||||||||||||||||||||||||||
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||
filter | JSON | Required | Filters retrieved connectors. Check the filter definition here |
The id of the workflow to return |
Query String Parameters
Name | Type | Required | Description |
---|---|---|---|
transform | boolean | Optional | Whether to transform the output. Default "false" |
section | string | Optional | The section required for the output. The value can be "templates", "rules", "events" |
Response
Code Block | ||
---|---|---|
| ||
{
"workflow": |
Response
Code Block | ||
---|---|---|
| ||
{ "workflow": [{ "id": "AAABcID5GBc=", "description": "Publish to Elasticsearch", ... }, { "id": "AAABcIueWUc=", "description": "Normalise data", ... }] } |
Status
} |
Status: 200, 404
Section | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add single workflowAdds a single workflow to Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed. Get a single workflowGet information about a single workflow in Aspire
Body Path Parameters
ResponseQuery String Parameters code
Example
Response
| ||||||||||||||||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||||||||||||||||
200 | Success | |||||||||||||||||||||||||||||||||||
404 | The given workflow id was not found | |||||||||||||||||||||||||||||||||||
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. Add single workflowAdds a single workflow to Aspire
Body Parameters | |||||||
Name | Type | Required | Description | ||||
description | string | Required | A description of the workflow | ||||
Name | Type | Required | Description | ||||
type | string | Required | Accepted values are: "connector" and "service" If connector is set the workflow created with the following events will be created:
If service is set the workflow will be created without events. |
Code Block | ||
---|---|---|
| ||
/aspire/_api/workflow?type=connector
{
"description": "Publish to Elastic"
} |
Response
Code Block | ||
---|---|---|
| ||
{
"workflow": {
"id": "AAABcID5GBc=",
"description": "Publish to Elastic",
"type": "connector"
....
}
} |
Status
|
Response
Code Block | ||
---|---|---|
| ||
{
"message": "update result response message"
} |
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
Delete multiple workflows, filteredDelete multiple workflows from Aspire, filtered by a specified criteria
Body Parameters | |||||||||||||||||||||||||||||||||||
Name | Type | Required | Description | filter | JSON | Required | Filters workflows to be deleted. Check the filter definition here
Response
Code Block | ||
---|---|---|
| ||
{ "message": "optionaldelete result response message" } |
See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors
Status
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 Delete single workflowDelete a single workflow from Aspire.
Path Parameters
ResponseExample
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 workflow eventGet a event from a workflow in Aspire, this endpoint need the at least the OPERATOR role to be executed.
Path Parameters
Response 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 workflow event(s)Create one or more workflow events in Aspire.
Path Parameters | ||||||||||||||||||||||||
Name | Type | Required | Description | |||||||||||||||||||||
id | string | Required | The identifier of the workflow(s) to add a event to | |||||||||||||||||||||
eventId | string | Required | The identifier of the event to add |
Code Block | ||
---|---|---|
| ||
[{
"id": "scan"
},
{
"id": "addUpdate"
}] |
Create multiple events (alternative version)
Response
Code Block | ||
---|---|---|
| ||
{ "workflow": { "event": [ { "id": "onScan" }, { "id": "AAABcIueWUc=onAddUpdate", "description": "Publish to Elasticsearch" "event": { }, "id": ["scan", "addUpdate"] } } } |
Status
Delete a workflow event from Aspire.
Panel | ||||
---|---|---|---|---|
| ||||
|
Path Parameters
Response
Code Block | ||
---|---|---|
| ||
{
"message": "optional response message"
} |
Status
Create a workflow event item - a rule, condition and the like.
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": "AAABcIueWUc=", "description": "Publish to Elasticsearch" "event": { "id": "onAddUpdate", "rule": { "id": "AAABcQwxWUc=", ... { "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" } ] } } } } |
: 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 | |||||||||||||||||||||||||||||||||
Section | |||||||||||||||||||||||||||||||||
Update a workflow event itemDelete one or more services from Aspire.
Path Parameters
Body Parameters The request body parameters will differ depending on the type of item created. See Create a workflow event item aboveExamples Create multiple events (body parameter)
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 |
}
} |
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. | ||||||||||||||||||||||||||||||||
Section | ||||||||||||||||||||||||||||||||
Delete single workflow event item
Path Path Parameters
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 | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Move Create a workflow event itemDelete one or more services from AspireCreate 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
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 |
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 | Optional | The identifier of the node in to which the item should be inserted. Defaults to the root node. The valid parents for reference 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. 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 | |
ruleId | String | Required | 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 node in to 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 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Get workflow templatesRetrieve all workflow templates from Aspire.
Path Parameters
Body Parameters The request body parameters will differ depending on the type of rule created.
Query String 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Optionally you may opt to add the created rule to a workflow event by adding the following query parameters
Response when parentId used
Get all workflow templates, filteredLists workflow templates configured in the Aspire, filtered by a specified criteria
Query String Parameters | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Name | Type | Required | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
from | integer | Optional | Indicates the initial page to be retrieved | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
size | integer | Optional | Specifies the size of results page | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sortBy | string | Optional | Field by which results are sorted | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sortMode | string | Optional | Sort mode
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
expand | string | Optional | List of fields to expand, * will expand everything | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Name | Type | Required | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
filter | JSON | Required | Filters retrieved workflow templates. Check the filter definition here |
Code Block | ||
---|---|---|
| ||
{ "template": [{ "id": "AAABcQwrWUconAddUpdate", ... "rule": { }, "id": "AAABcQwrWUdddSWeq123", ... "description": "Some rule", }] "messagetype": "optional response message" } |
Status
application",
...
}
}
}
} |
Response without parentId
Retrieve a single workflow templates from Aspire.
Panel | ||||
---|---|---|---|---|
| ||||
|
Path Parameters
Response
Code Block | ||
---|---|---|
| ||
{ "workflow": { "id": "AAABcIueWUc=", "description": "Publish to Elasticsearch" "templaterule": [{ "id": "AAABcQwrWUcddSWeq123", ..."description": "Some rule", }] "messagetype": "optional response message""application", ... } } } |
: 200, 404, 406
Section | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get Update single workflow ruleGet Updatee a single workflow rule from Aspirein 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 | ||||||||||||||||||||||||
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 Create a workflow ruleCreate a single workflow rule in Aspirefrom 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. Some examples are shown below | |||||||||||||||
Rule Type | Parameter Name | Parameter Type | Required | Description | groovy | <TODO> | application | ||||||||
Parameter Name | Parameter Type | Required | Description | ||||||||||||
parentId | string | Required | 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 |
Code Block | ||
---|---|---|
| ||
{
"workflow": {
"id": "AAABcIueWUc=",
"description": "Publish to Elasticsearch"
"event": {
"id": "onAddUpdate",
"rule": {
"id": "ddSWeq123",
"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
Updatee a single workflow rule in Aspire.
Panel | ||||
---|---|---|---|---|
| ||||
|
Path Parameters
Body Parameters
The request body parameters will differ depending on the type of rule created. See Create a workflow rule above
Response
Code Block | ||
---|---|---|
| ||
{
"workflow": {
"id": "AAABcIueWUc=",
"description": "Publish to Elasticsearch"
"rule": {
"id": "ddSWeq123",
"description": "Some rule",
"type": "application",
...
}
}
}
|
Status
Deletes a single workflow rule from Aspire.
Panel | ||||
---|---|---|---|---|
| ||||
|
Path 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
Response
Code Block | ||
---|---|---|
| ||
{
"message": "optional response message"
} |
Status
delete rule(s) | |||
ruleId | string | Required | The identifier of the rule to delete |
Response
Code Block | ||
---|---|---|
| ||
{
"message": "delete result response message"
} |
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
| |||||||||||||||||||||||||||||||||||||||||||||
Section |
Panel | ||||
---|---|---|---|---|
| ||||
GET /aspire/_api/workflows/itemType |
Response
Code Block | ||
---|---|---|
| ||
{
type: [ "application", "publisher", "function"]
} |
Status
|
Path Parameters
The identifier of the workflow item type
|
Example
Code Block | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||
/aspire/_aspire/workflows/types/applications Response
|
Status
Status: 200 |
Section | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
ImportThe import usage can be found here | ||||||||||||
Section | ||||||||||||
Get connector type dxfReturns the dxf for a specific workflow item type
Response
Status | ||||||||||||
Response code | Description | |||||||||||
200 | Success | 404 | Not found - a given service identifier was not found
Section | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Filters
Some endpoint queries require a filter. A filter is basically a JSON object with the following format: Credentials Seed filter:
|