Import a new workflow document

curl -X POST http://localhost:3000/automation-studio/automations/import \
     -H "Content-Type: application/json" \
     -u "<username>:<password>" \
     -d '{}'

{
  "imported": [
    {
      "message": "string",
      "original": {
        "name": "Port Turn Up IOS",
        "type": "automation",
        "tasks": {
          "workflow_start": {
            "name": "string",
            "summary": "string",
            "groups": [
              {
                "name": "Admin",
                "provenance": "Pronghorn"
              }
            ],
            "x": 0,
            "y": 100
          },
          "workflow_end": {
            "name": "string",
            "summary": "string",
            "groups": [
              {
                "name": "Admin",
                "provenance": "Pronghorn"
              }
            ],
            "x": 0,
            "y": 100
          },
          "error_handler": {}
        },
        "transitions": {
          "workflow_start": {},
          "workflow_end": {},
          "error_handler": {}
        },
        "groups": [
          {
            "name": "Admin",
            "provenance": "Pronghorn"
          }
        ],
        "_id": "string",
        "uuid": "string",
        "description": "Port Turn Up IOS",
        "preAutomationTime": 5000,
        "sla": 10,
        "font_size": 12,
        "created": "2024-03-13T18:21:15.352Z",
        "created_by": {
          "username": "admin@pronghorn",
          "provenance": "Pronghorn"
        },
        "createdBy": "string",
        "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": [
          {
            "_id": "string",
            "name": "string",
            "description": "string"
          }
        ],
        "canvasVersion": 1,
        "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"
            }
          }
        ]
      },
      "created": {
        "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"
            }
          }
        ]
      },
      "edit": "string",
      "success": true
    }
  ]
}

Imports a new workflow document.

Authentication

AuthorizationBasic

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

Request

request body

automationslist of objectsOptional

Array of workflow documents to import. If ‘_id’ is provided, it will be replaced with an autogenerated ‘_id’.

Response

Results from each individual import operation.

importedlist of objects

Errors

500

Internal Server Error