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": [
"b26b57421bcfa830fafa0876",
"90d89c50048bafb3abfb069d"
],
"nodeLocation": {
"x": 31451499.59788856,
"y": -15820601.42442967
}
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"4edff425cb7e6a77e44d5a50",
"cccf04c5c9115a5057b0b828",
"1ee54d601c0e5c1daa7d1d55",
"3a625e9b15f2fae35ab37308",
"2b5aa05fe105cfaee5d5cbcf"
],
"nodeLocation": {
"x": -23172257.184360668,
"y": 8548175.06290169
}
},
"error_handler": {
"name": "childJob",
"summary": "adipisicing amet",
"description": "dolor ad sit",
"app": "sint eu esse occaecat",
"variables": {
"error": ""
},
"groups": [
"57588555d8850a86ec58ac07"
],
"type": "operation",
"deprecated": true,
"scheduled": false,
"retrySettings": {
"state": [
"success",
"error",
"error"
],
"autoRetry": true,
"limit": 20,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"67314519e29233d509d691d9",
"c235f348dd10d37ffac40279",
"e137b425afd07f4a4bdb5f26"
],
"canvasVersion": 3,
"_id": "5cb7b531d06cceb89fd21b1c",
"namespace": {
"type": "project",
"name": "irure proident amet",
"accessControl": {
"read": [
"nulla"
],
"write": [
"dolore velit",
"mollit veniam reprehenderit aliqua",
"exercitation aliquip laborum aliqua sunt",
"quis",
"consequat tempor"
],
"execute": [
"eu",
"commodo enim",
"exercitation est"
],
"manage": [
"cupidatat irure aliqua",
"ullamco",
"aliquip minim",
"cillum sint deserunt sunt eiusmod"
]
}
},
"description": null,
"preAutomationTime": 5000,
"font_size": 12,
"created": "1977-09-11T10:43:47.531Z",
"created_by": "cd2158ecc8fe6bbcc0e62803",
"last_updated": "2003-06-29T16:56:14.775Z",
"last_updated_by": "658165d0cdd19db60028d96e",
"lastUpdatedVersion": "in aliqua nostrud culpa fugiat",
"tags": [
"ea cillum sint Excepteur",
"velit fugiat",
"tempor proident culpa",
"aute",
"in cillum"
],
"encodingVersion": 1
}