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": [
"ceaa19586b3f5b1c3e1f4510",
"9f541f834ecd6d78513f369a",
"85a5b069379a474f551bf216"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"aa2ec74320ad0e9b605a895d",
"7b0ae60ab65dd0d3798e3bef",
"75d2015e212b32db39211a6e",
"a096acc4ead1591e32e0ad8c"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"error_handler": {
"name": "childJob",
"summary": "ut eiusmod aliqua amet",
"description": "ut in reprehenderit",
"app": "ex",
"variables": {
"error": ""
},
"groups": [
"3dcedda18b88f028220e1dea"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": true,
"scheduled": false,
"retrySettings": {
"state": [
"success",
"failure"
],
"autoRetry": true,
"limit": 20,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"c9dea212bbe1eeab713a0ce4",
"70dac6cce3e1703274c3d969"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": null,
"preAutomationTime": 5000,
"font_size": 12,
"created": "1973-07-07T03:09:01.334Z",
"created_by": "6a14634ed4e57b398abe49aa",
"last_updated": "2012-11-08T12:30:11.177Z",
"last_updated_by": "c373592e37a2941672f994da",
"lastUpdatedVersion": "sint ex",
"tags": [
"anim velit",
"ipsum deserunt anim elit",
"in pariatur proident ad",
"non commodo consectetur",
"ipsum in"
],
"canvasVersion": 2,
"encodingVersion": 1
}