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": [
"4591bdcc28b5422a5787fd43",
"3b53c5d522f0818771f13a5a",
"abe4bb5d81c7134d42a7fedb",
"fa22a7cccc2b984194de84c1"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"18d6d49b498923793be144a7",
"652622414056dde801701175"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"error_handler": {
"name": "childJob",
"summary": "et aliqua esse",
"description": "id",
"app": "elit reprehenderit",
"variables": {
"error": ""
},
"groups": [
"9422abf779048de43ece8955",
"cfdb75edbfa2af89b9a2f459"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": true,
"scheduled": false,
"retrySettings": {
"state": [
"success"
],
"autoRetry": true,
"limit": 10,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"ba6b20d67759060987192f55",
"a73a6c9e157dd2daebd928ae",
"22bbb8967516714e007321e2",
"7d245f181f365f033ebc81a1",
"dbeff3a7c760e1117aa34cda"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": null,
"preAutomationTime": 5000,
"font_size": 12,
"created": "1956-08-30T22:59:08.063Z",
"created_by": "cc6bf377fcc104ba7d13e976",
"last_updated": "1989-05-23T08:29:12.176Z",
"last_updated_by": "27bae71855afd5762cb349ca",
"lastUpdatedVersion": "dolor labore minim proident est",
"tags": [
"elit"
],
"canvasVersion": 2,
"encodingVersion": 1
}