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": [],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"error_handler": {
"name": "childJob",
"summary": "dolore",
"description": "anim incididunt",
"app": "aliquip Duis enim eiusmod proident",
"variables": {
"error": ""
},
"groups": [
"1935d2ae5c19701270ce335d",
"d75d34abeab2817e0aa48fa4"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": true,
"scheduled": true,
"retrySettings": {
"state": [
"success",
"error",
"success"
],
"autoRetry": false,
"limit": 20,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"1a0b1fef80176ba4c3938a1c",
"8d0e075d5ea0d393778b10e6",
"6655787aa5ab6dc6aafce315",
"2af8ed32cf8f1e27948fd5fd"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": null,
"preAutomationTime": 5000,
"font_size": 12,
"created": "2001-07-19T23:49:09.664Z",
"created_by": "080bdc22d3b78a2a65f36d99",
"last_updated": "1985-01-07T16:20:07.787Z",
"last_updated_by": "71648813957f8a0e188e8318",
"lastUpdatedVersion": "deserunt",
"tags": [],
"canvasVersion": 2
}