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": [
"fb766a92041a96f35942c07c",
"66e42ac97bd5d2c0961edf87",
"0baad71818eb4d9aa2db78c2",
"4fe93ed9428df0ad9f057661"
],
"x": -35042529.69021176,
"y": -15723876.556227535
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"e353cf7100a0ecd8c4bfde22",
"3a8a342ff803714270ab30df",
"b32c5cd43e6b2c8b3b762d17"
],
"x": 78083289.35013399,
"y": -47473374.354379505
},
"error_handler": {
"name": "childJob",
"summary": "cupidatat nostrud reprehenderit Excepteur",
"description": "adipisicing nisi dolore officia",
"app": "laborum non in",
"variables": {
"error": ""
},
"groups": [
"d6810a55ecf8b2700c988a05",
"4c21876a88e5109d899ca964",
"8312284aee0be90c810a201a",
"d0112b12fcc0db91f2e60b81"
],
"type": "operation",
"deprecated": false,
"scheduled": false,
"retrySettings": {
"state": [
"error",
"success",
"failure",
"success"
],
"autoRetry": true,
"limit": 20,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"2c4c2f9c85f30584d715b7be",
"70ec61376debee086168064b",
"5a05076c9c02a7a3243ce4ae",
"49274df46aa486f3797e6db7",
"9fac7bfb77c9168d985c8395"
],
"_id": "4321abcdef694aa79dae47ad",
"description": "quis est",
"preAutomationTime": 250000,
"font_size": 12,
"created": "1988-11-27T01:38:46.693Z",
"created_by": "11357e82d61224bad7d1d642",
"last_updated": "1981-09-01T18:06:50.666Z",
"last_updated_by": "a4892c6b8f3ca3e1cd3a030b",
"lastUpdatedVersion": "ullamco id sunt Excepteur",
"tags": [
"in enim exercitation id",
"occaecat amet",
"enim exercitation ea",
"sunt cupidatat occaecat",
"et sint fugiat"
],
"canvasVersion": 1,
"encodingVersion": 1
}