Summary
Get Details of a Workflow
Description
Get the details of a Workflow by Workflow name.
Route
GET /automation-studio/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": [
"1f5e2f8d61070abf671f9750",
"7047edda4a3954eeb4069784"
],
"gridCoordinate": {
"x": 52248605.59693149,
"y": 32543205.734191805
}
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"3d9fdf5552ff734233e14875",
"0f8636f12e895f12f7f6628d",
"6fd7a32ba042c58a5acdc693"
],
"x": 38317021.094836,
"y": 93855488.17177507
},
"error_handler": {
"name": "childJob",
"summary": "Excepteur mollit ullamco",
"description": "sed non",
"app": "dolore dolor",
"variables": {
"error": ""
},
"groups": [
"7f9e41f4a9b579cf076905f4",
"33a48f845642212e0acafb60",
"ab98cce419552ac30b7d2679",
"e2eee81e5c53d231a96795e5"
],
"type": "operation",
"deprecated": true,
"scheduled": true,
"retrySettings": {
"state": [
"error",
"failure",
"failure",
"failure",
"failure"
],
"autoRetry": false,
"limit": 20,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"068c8f9dbde3414ffc20470e",
"b119320878df1eaa6e2fb7c3"
],
"_id": "4321abcdef694aa79dae47ad",
"description": "ea Duis Excepteur anim",
"preAutomationTime": 250000,
"font_size": 12,
"created": "1949-06-29T10:57:33.596Z",
"created_by": "579121e18c3ca86d2829b00c",
"last_updated": "1991-01-11T02:30:27.116Z",
"last_updated_by": "306e2c684e74abf151f4fc31",
"lastUpdatedVersion": "ut dolore qui aliquip incididunt",
"tags": [
"ex aliqua occaecat",
"sint veniam",
"dolore cillum occaecat id",
"ut dolor id"
],
"canvasVersion": 2,
"encodingVersion": 1
}