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": "dolor",
"description": "enim",
"app": "fugiat",
"variables": {
"error": ""
},
"groups": [
"64ecc3949eebdb2d546c52c4"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": true,
"scheduled": true,
"retrySettings": {
"state": [
"success",
"error",
"success",
"failure",
"failure"
],
"autoRetry": false,
"limit": 20,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"e03efeec679fd1ea2e569c69",
"85084209c286dcfff6290c8d",
"e8846f1e98458dec91919790"
],
"_id": "4321abcdef694aa79dae47ad",
"description": "do",
"preAutomationTime": 5000,
"font_size": 12,
"created": "1985-01-25T21:46:49.584Z",
"created_by": "eb16f229e956dcd7114b839b",
"last_updated": "1949-08-10T23:24:56.246Z",
"last_updated_by": "e0eda664f9d351566690092c",
"lastUpdatedVersion": "ut minim do et",
"tags": [],
"canvasVersion": 2
}