Get details of a workflow

curl http://localhost:3000/automation-studio/workflows/detailed/name \
     -u "<username>:<password>"

{
  "name": "Port Turn Up IOS",
  "type": "automation",
  "tasks": {
    "workflow_start": {
      "name": "string",
      "summary": "string",
      "groups": [
        "62a1f3d2ebedfc54e6e0065c"
      ],
      "nodeLocation": {
        "x": 1.1,
        "y": 1.1
      }
    },
    "workflow_end": {
      "name": "string",
      "summary": "string",
      "groups": [
        "62a1f3d2ebedfc54e6e0065c"
      ],
      "nodeLocation": {
        "x": 1.1,
        "y": 1.1
      }
    },
    "error_handler": {}
  },
  "transitions": {
    "workflow_start": {},
    "workflow_end": {},
    "error_handler": {}
  },
  "groups": [
    "62a1f3d2ebedfc54e6e0065c"
  ],
  "canvasVersion": 1.1,
  "_id": "string",
  "uuid": "string",
  "namespace": {
    "_id": {},
    "name": "Juniper JUNOS"
  },
  "description": "Port Turn Up IOS",
  "preAutomationTime": 5000,
  "sla": 1,
  "font_size": 12,
  "created": "2024-03-13T18:21:15.352Z",
  "created_by": {
    "username": "admin@pronghorn",
    "provenance": "Pronghorn"
  },
  "createdVersion": "5.40.5-2021.1.72.0",
  "last_updated": "2024-03-13T18:21:15.352Z",
  "last_updated_by": {
    "username": "admin@pronghorn",
    "provenance": "Pronghorn"
  },
  "lastUpdatedVersion": "4.69.69",
  "tags": [
    "string"
  ],
  "encodingVersion": 1,
  "inputSchema": {},
  "outputSchema": {},
  "outputData": {},
  "decorators": [
    {
      "type": "encryption",
      "pointer": "string"
    }
  ],
  "migrationVersion": 1,
  "scenarios": [
    {
      "name": "string",
      "input": {},
      "description": "string",
      "taskMocks": {},
      "last_updated": "2024-01-15T09:30:00Z",
      "last_updated_by": {
        "username": "admin@pronghorn",
        "provenance": "Pronghorn"
      }
    }
  ]
}

Returns the details of a Workflow by Workflow name.

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