For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Open sourceSupportFAQsDocs Home
DocumentationAPI referenceRelease notes
DocumentationAPI referenceRelease notes
  • Introduction
    • Overview
    • Authentication
  • Guides
    • Operations Manager search APIs
    • Search API
    • URL query parameters
    • Use query parameters in API requests
  • Reference
        • POSTAdd one or more components to project
        • POSTCreate a new component group document
        • POSTCreate a new project
        • POSTCreate a new template document
        • POSTCreate a new workflow document
        • DELDelete a component group document
        • DELDelete a project and any components it contains
        • DELDelete a template document
        • POSTDiscover referenced resources
        • GETExport a template document
        • GETExport project as JSON document
        • GETGet a list of all the apps and adapters
        • GETGet a page of component group documents
        • GETGet a page of template documents
        • GETGet a page of workflow documents
        • GETGet a project's thumbnail
        • GETGet component group document
        • GETGet details of a workflow
        • GETGet project
        • GETGet references to a particular document
        • GETGet task details
        • POSTGet task details
        • GETGet template document
        • POSTImport a new component group document
        • POSTImport a new template document
        • POSTImport a new workflow document
        • POSTImport a project document from a JSON document
        • GETList all available rest calls
        • DELRemove a component from a project
        • PUTReplace a component group document
        • PUTReplace a template document
        • PUTReplace a workflow document
        • GETSearch projects
        • PUTSet a project's thumbnail image
        • PATCHUpdate an existing project
        • POSTValidate a workflow
LogoLogo
Open sourceSupportFAQsDocs Home
ReferenceAutomation Studio

Get details of a workflow

GET
http://localhost:3000/automation-studio/workflows/detailed/:name
GET
/automation-studio/workflows/detailed/:name
$curl http://localhost:3000/automation-studio/workflows/detailed/name \
>     -u "<username>:<password>"
1{
2  "name": "Port Turn Up IOS",
3  "type": "automation",
4  "tasks": {
5    "workflow_start": {
6      "name": "string",
7      "summary": "string",
8      "groups": [
9        "62a1f3d2ebedfc54e6e0065c"
10      ],
11      "nodeLocation": {
12        "x": 1.1,
13        "y": 1.1
14      }
15    },
16    "workflow_end": {
17      "name": "string",
18      "summary": "string",
19      "groups": [
20        "62a1f3d2ebedfc54e6e0065c"
21      ],
22      "nodeLocation": {
23        "x": 1.1,
24        "y": 1.1
25      }
26    },
27    "error_handler": {
28      "name": null
29    }
30  },
31  "transitions": {
32    "workflow_start": {},
33    "workflow_end": {},
34    "error_handler": {}
35  },
36  "groups": [
37    "62a1f3d2ebedfc54e6e0065c"
38  ],
39  "canvasVersion": 1.1,
40  "_id": "string",
41  "uuid": "string",
42  "namespace": {
43    "type": null,
44    "_id": {},
45    "name": "Juniper JUNOS"
46  },
47  "description": "Port Turn Up IOS",
48  "preAutomationTime": 5000,
49  "sla": 1,
50  "errorHandler": null,
51  "font_size": 12,
52  "created": "2024-03-13T18:21:15.352Z",
53  "created_by": {
54    "username": "admin@pronghorn",
55    "provenance": "Pronghorn"
56  },
57  "createdVersion": "5.40.5-2021.1.72.0",
58  "last_updated": "2024-03-13T18:21:15.352Z",
59  "last_updated_by": {
60    "username": "admin@pronghorn",
61    "provenance": "Pronghorn"
62  },
63  "lastUpdatedVersion": "4.69.69",
64  "tags": [
65    "string"
66  ],
67  "encodingVersion": 1,
68  "inputSchema": {},
69  "outputSchema": {},
70  "outputData": {},
71  "decorators": [
72    {
73      "type": "encryption",
74      "pointer": "string"
75    }
76  ],
77  "migrationVersion": 1,
78  "scenarios": [
79    {
80      "name": "string",
81      "input": {},
82      "description": "string",
83      "taskMocks": {},
84      "last_updated": "2024-01-15T09:30:00Z",
85      "last_updated_by": {
86        "username": "admin@pronghorn",
87        "provenance": "Pronghorn"
88      }
89    }
90  ]
91}
Returns the details of a Workflow by Workflow name.
Was this page helpful?
Previous

Get project

Next
Built with

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

namestringRequired
Name of Workflow to get Workflow details.

Response

Workflow details matching the Workflow name.
namestring
typestringDefaults to automation
tasksobject
transitionsobject
groupslist of strings
canvasVersiondouble
_idstringformat: "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$"
uuidstringformat: "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$"
namespaceobject
descriptionstring or null
preAutomationTimeinteger

Time (milliseconds) automation would have taken someone to complete without using IAP.

slainteger
errorHandlerobject or null

Deprecated gen2-specific feature

font_sizeinteger6-24Defaults to 12

Deprecated, unused, gen1-specific feature

createdstringformat: "date-time"
created_byobject or string
createdVersionstring
last_updatedstringformat: "date-time"
last_updated_byobject or string
lastUpdatedVersionstring

This value represents the semantic version of the application that last modified it. For workflows with canvasVersion = 1, this field will refer to the version of Workflow Builder. For workflows with canvasVersion > 1, this field will refer to the version of Studio.

tagslist of strings
encodingVersionenum
Allowed values:
inputSchemaobject
outputSchemaobject
outputDatamap from strings to objects

Deprecated gen2-specific feature

decoratorslist of objects
migrationVersioninteger>=0
scenarioslist of objects

Errors

500
Internal Server Error