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": [
"08807b42577625dae9fa5322",
"51811c1d4b7dd552acb2138f"
],
"nodeLocation": {
"x": -36629859.813574225,
"y": 7419470.948738873
}
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"00d4b510bbe978a36cf81ec4"
],
"nodeLocation": {
"x": 64857070.46042362,
"y": 82981073.04959732
}
},
"error_handler": {
"name": "childJob",
"summary": "anim eiusmod Duis sunt",
"description": "exercitation officia aute aliquip",
"app": "proident officia dolor",
"variables": {
"error": ""
},
"groups": [
"efa71a67ae2c69212a07f79f",
"e83033d4a408c4e531bc3f50",
"7afb40659ae95ad0215bd02b"
],
"type": "operation",
"deprecated": false,
"scheduled": true,
"retrySettings": {
"state": [
"success",
"error",
"failure"
],
"autoRetry": true,
"limit": 10,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"7f70e75a542bd86f8aad6cf6",
"3ae0b230c15a76e3c4c2e9dd",
"bfbabf60fb8be7029b59ff67",
"f7422890a287884f43d5ae0a"
],
"canvasVersion": 3,
"_id": "4321abcdef694aa79dae47ad",
"namespace": {
"type": "project",
"name": "aliquip laborum consectetur dolor ut",
"accessControl": {
"read": [
"id elit sint non ut",
"mollit ullamco elit adipisicing Ut",
"fugiat consectetur ipsum",
"voluptate aliquip Excepteur commodo qui",
"est quis"
],
"write": [
"commodo ex ullamco tempor",
"veniam minim sed sint",
"proident"
],
"execute": [
"in amet dolore",
"Ut veniam ipsum consequat",
"pariatur"
],
"manage": [
"ex enim consequat"
]
}
},
"description": null,
"preAutomationTime": 5000,
"font_size": 12,
"created": "1957-03-12T17:50:54.473Z",
"created_by": "d21f42896e13e052ff18714e",
"last_updated": "1994-10-13T13:53:05.214Z",
"last_updated_by": "ad590151b855a92c914f3b13",
"lastUpdatedVersion": "sed pariatur sunt eu",
"tags": [
"proident officia pariatur",
"consequat esse",
"dolor",
"dolore eu",
"consequat exercitation mollit voluptate"
],
"encodingVersion": 1
}