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": [
"9c45bb30b181595a54e1ce83",
"52c5e69614cdc0fd57d57864",
"dd9169694266fa34d69ea5cd"
],
"nodeLocation": {
"x": 73122295.57817683,
"y": 4087701.076590374
}
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"6057d4fbe3c9231a511bec8a",
"fa55c740f7a4edcaca7cb876",
"90ed5cf37303f752cbccac8b"
],
"x": -21630399.675786987,
"y": 14193730.414841264
},
"error_handler": {
"name": "childJob",
"summary": "pariatur eiusmod",
"description": "enim laborum",
"app": "commodo cillum",
"variables": {
"error": ""
},
"groups": [
"504e5b6e90bbff02fba56095",
"74e4d08596fc0971220d4273",
"1a815ee359bc61a206de3f2d",
"7fe97aff692e95257ba7e0f6",
"3a6cadce75f40881a21c327a"
],
"type": "operation",
"deprecated": true,
"scheduled": true,
"retrySettings": {
"state": [
"error",
"error",
"failure",
"failure"
],
"autoRetry": false,
"limit": 20,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"121937f99955eafed8a77a65",
"805254db281b60706440235b",
"b8ba20b76298a77410502150",
"6f9c982a555ccdf352b09633",
"38bcfae7c79af8fd264c72b1"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": null,
"preAutomationTime": 5000,
"font_size": 12,
"created": "1971-06-05T02:37:22.211Z",
"created_by": "40f327652cc1f5b91455f088",
"last_updated": "1988-11-23T00:28:43.139Z",
"last_updated_by": "509dafd9c743d6ab03ccbb2c",
"lastUpdatedVersion": "non labore commodo nostrud exercitation",
"tags": [
"magna",
"Ut proident incididunt",
"Excepteur sit id cupidatat velit",
"esse dolore ut",
"anim"
],
"canvasVersion": 1,
"encodingVersion": 1
}