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": [
"0d27503cca99f1112ed29883"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"acdd89f8aa6da078d12fd814",
"36cadbd3bca8d284554ee367",
"9b1caf025c875b5d4a27adf0",
"00edd1e1bd266230a9ecedc7"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"error_handler": {
"name": "childJob",
"summary": "anim",
"description": "ea mollit dolore",
"app": "ut amet sunt aliqua exercitation",
"variables": {
"error": ""
},
"groups": [
"b660eaaacf123ab0c33b31b0",
"10e5d8b68926862b314b7a35",
"40992d7b8ffaa5aacd800e75",
"06098c3345b915dcdc238f0a"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": true,
"scheduled": true,
"retrySettings": {
"state": [
"failure"
],
"autoRetry": true,
"limit": 20,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"2edcf605740e2bc1d9f41832",
"067c9b3ced2c824282f1e838"
],
"_id": "4321abcdef694aa79dae47ad",
"description": null,
"preAutomationTime": 250000,
"font_size": 12,
"created": "2005-09-29T08:32:48.837Z",
"created_by": "1dcefb80982dbd8c709972f9",
"last_updated": "1997-01-24T15:05:51.502Z",
"last_updated_by": "35135f16a234e311d90012fe",
"lastUpdatedVersion": "fugiat dolore Ut",
"tags": [
"in deserunt labore Duis"
],
"canvasVersion": 2,
"encodingVersion": 1
}