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": [
"4f2984b92d80eddfee8d7069",
"ed561b78a8aec410492074db",
"0a3ce4a29b38f45a4ce6a343"
],
"nodeLocation": {
"x": -86654839.73154351,
"y": 65600708.005842716
}
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"64e04b9e01dbe4a53ba5996c",
"528425ec5ca05e2a2b2fef6e",
"2581a8d5760a5156a855e7ec"
],
"nodeLocation": {
"x": 10217305.408414885,
"y": 66263175.829782724
}
},
"error_handler": {
"name": "childJob",
"summary": "commodo elit qui",
"description": "consectetur est aute ex",
"app": "fugiat consectetur veniam",
"variables": {
"error": ""
},
"groups": [
"2b393aa332b062861f95b1fe"
],
"type": "operation",
"deprecated": false,
"scheduled": false,
"retrySettings": {
"state": [
"error",
"success"
],
"autoRetry": false,
"limit": 10,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"7b7ac2e0a4570d240bb59b30",
"0f206a59d06ad51013416328",
"ae3578733120f3b696f47947",
"5b3d9c2916639793dc1fa412",
"b35b63dafdaf830c4edecb14"
],
"canvasVersion": 3,
"_id": "4321abcdef694aa79dae47ad",
"namespace": {
"type": "project",
"name": "veniam consequat",
"accessControl": {
"read": [
"sed mollit aliqua sit enim",
"ut",
"sunt cupidatat mollit"
],
"write": [
"commodo cillum dolore",
"deserunt voluptate tempor",
"deserunt sunt",
"consequat Duis nostrud aliqua"
],
"execute": [
"est ut quis Lorem cupidatat",
"id qui",
"est do in"
],
"manage": [
"in dolore",
"reprehenderit nisi aute deserunt",
"culpa adipisicing qui",
"eiusmod ipsum qui aute"
]
}
},
"description": "tempor velit",
"preAutomationTime": 5000,
"font_size": 12,
"created": "1958-05-25T23:35:24.773Z",
"created_by": "eb0a03796c65d3a53e8bfc30",
"last_updated": "2007-02-23T20:49:53.324Z",
"last_updated_by": "1e7e588797b6299eb848cecd",
"lastUpdatedVersion": "consectetur",
"tags": [
"et"
],
"encodingVersion": 1
}