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": [
"b282923c125d14c3b4a351c0",
"d60b75a0a94e0582ce313cf0",
"3d6da7b93fba6e36e0984721"
],
"x": -91191796.06766225,
"y": 5541335.83742477
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"36b9be32f4160ebc090c8bbe",
"6b90a72fed69937b27894b56",
"b4d003bab6e5e2c72a4e77af"
],
"nodeLocation": {
"x": 11415926.87620148,
"y": 6403588.776152164
}
},
"error_handler": {
"name": "childJob",
"summary": "labore Lorem ut aute",
"description": "eu",
"app": "ut nostrud laborum labore ad",
"variables": {
"error": ""
},
"groups": [
"d3c214e92e71b2b295bf9fe7"
],
"type": "operation",
"deprecated": false,
"scheduled": true,
"retrySettings": {
"state": [
"error",
"error"
],
"autoRetry": false,
"limit": 20,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"192e24b14e256f5dfd964be7",
"8c08bf5d914ed6e91e328300"
],
"_id": "4321abcdef694aa79dae47ad",
"namespace": {
"type": "project",
"name": "proident",
"accessControl": {
"read": [
"adipisicing",
"eu"
],
"write": [
"labore eu Lorem enim amet"
],
"execute": [
"occaecat dolore",
"labore ut id ut consequat",
"veniam occaecat",
"et enim proident",
"elit voluptate enim"
],
"manage": [
"ipsum dolore",
"exercitation anim commodo aliquip"
]
}
},
"description": "irure sed",
"preAutomationTime": 5000,
"font_size": 12,
"created": "2007-06-13T09:44:03.722Z",
"created_by": "353e4d39f5fe42e508f3aae2",
"last_updated": "1970-10-23T06:02:04.01Z",
"last_updated_by": "1e07d7231e075ff9ac60886d",
"lastUpdatedVersion": "ut ipsum",
"tags": [
"mollit nisi"
],
"canvasVersion": 2,
"encodingVersion": 1
}