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": [],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"error_handler": {
"name": "childJob",
"summary": "dolore minim in pariatur nisi",
"description": "Lorem",
"app": "deserunt minim nisi incididunt adipisicing",
"variables": {
"error": ""
},
"groups": [
"bcc570344bea143947cdb9f1",
"31dc61fb438f868ac9eb5428",
"fa4fc8d4fd020d9f62e2d962",
"6b523cee8ba1fd03ec97cf9d",
"7c3c117c428f3236be34ab49"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": false,
"scheduled": false,
"retrySettings": {
"state": [
"success",
"success",
"failure",
"success",
"failure"
],
"autoRetry": true,
"limit": 20,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"d27b2036fe8b501b9bd3b7c1"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": null,
"preAutomationTime": 5000,
"font_size": 12,
"created": "1953-07-17T11:21:33.329Z",
"created_by": "3d00e8cb99a63b25689c034b",
"last_updated": "1966-07-10T09:19:58.393Z",
"last_updated_by": "95eaa244660664a9c63dbe1a",
"lastUpdatedVersion": "eu in commodo mollit non",
"tags": [],
"canvasVersion": 2
}