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": [
"ef3beb42e04fc0858fd4aeae"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"c3d870f1c9fd934fc7974655",
"5e714e998390909849bfde07"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"error_handler": {
"name": "childJob",
"summary": "elit sit labore voluptate",
"description": "Lorem esse",
"app": "sed magna aute commodo aliquip",
"variables": {
"error": ""
},
"groups": [
"52909bb8ad65c28cc780c42b",
"9ede2c8d871e8a550ad93b3e",
"ce1e07c9d5bf6333a6b514ac",
"561051fd0942442b78637e99",
"e0e4b6aeb3b2ce7d9709e504"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": false,
"scheduled": false,
"retrySettings": {
"state": [
"error",
"error"
],
"autoRetry": true,
"limit": 20,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"bff34fb6d220c840b07ab6b6",
"44d691cd3d17228ce33629d3",
"73c90fae7e0332b369c3cc2d"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": null,
"preAutomationTime": 5000,
"font_size": 12,
"created": "1977-11-18T02:27:57.49Z",
"created_by": "180d815719f53ae17410fc38",
"last_updated": "2007-11-02T00:51:34.883Z",
"last_updated_by": "1739c37fa2115372a07e19cb",
"lastUpdatedVersion": "in ut incididunt",
"tags": [
"do esse dolore",
"aute Ut magna",
"labore do occaecat nulla"
],
"canvasVersion": 2,
"encodingVersion": 1
}
