Summary
Get Details of a Workflow
Description
Get the details of a Workflow by Workflow name.
Route
GET /workflow_engine/workflows/detailed/:name
Roles
admin
engineering
support
apiread
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| name |
string |
yes |
Name of Workflow to get Workflow details. |
Copied to Clipboard
{
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| workflow_details |
object |
Workflow details matching the Workflow name. |
Copied to Clipboard
{
"name": "My Workflow",
"type": "automation",
"tasks": {
"workflow_start": {
"name": "workflow_start",
"summary": "workflow_start",
"groups": [
"9cd262e7cfa974a02ab7ecab",
"118fc623b1d6d1d2e8090652",
"e58e20ff68e98307b4cad6ff",
"8a058e9c446924b482e436ff"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"144341c41e62906076a2dc74",
"bab1e865e037beca7b171e7f",
"c6903446adc5715ca9d8f62f"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"error_handler": {
"name": "childJob",
"summary": "esse",
"description": "incididunt Lorem eu cillum",
"app": "eiusmod",
"variables": {
"error": ""
},
"groups": [
"ee2cd22ee994ba1601961066"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": true,
"scheduled": true,
"retrySettings": {
"state": [
"error",
"success"
],
"autoRetry": false,
"limit": 20,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"2aed893be0123d5fd05c39a8"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": null,
"preAutomationTime": 5000,
"font_size": 12,
"created": "1957-07-25T08:11:23.326Z",
"created_by": "c3647c0a55a351da1b3001e6",
"last_updated": "2021-01-05T10:26:47.013Z",
"last_updated_by": "e87665297a418deba5077780",
"lastUpdatedVersion": "in do anim",
"tags": [
"fugiat dolore consectetur",
"nostrud dolor exercitation"
],
"canvasVersion": 2,
"encodingVersion": 1
}