Summary
Imports a new workflow document.
Description
Imports a new workflow document.
Route
POST /automation-studio/automations/import
Roles
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| automations | array | yes | Workflows array. |
{ "automations": [ { "name": "Command Template Runner", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ { "name": "Admin", "provenance": "Pronghorn" } ], "x": 0, "y": 100 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Pronghorn" } ], "nodeLocation": { "x": -15977418.368087277, "y": -65793231.165171705 } }, "error_handler": { "name": "Eval", "summary": "JSON Transformation", "description": "View Data", "app": "Tools", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/AWpBU" }, { "type": "encryption", "pointer": "/~1/~0/Eiyu8Ii//~1/~1/ojZ3/ybAhN/tjXGH/bHAZt/KzSxrk9j/~1" }, { "type": "encryption", "pointer": "/z2K5/VwzEq7Nbk" }, { "type": "encryption", "pointer": "/~0/~0/FJL7q/ZWRn/x7/J471v/c/~1/~1/~1/rC/psjV" } ] }, "groups": [ { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Pronghorn" } ], "type": "operation", "nodeLocation": { "x": 70992778.80415839, "y": 52064350.210475 }, "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "success", "error", "failure", "error" ], "autoRetry": true, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ { "name": "Admin", "provenance": "Local AAA" } ], "_id": "2cec18bb-64a8-64a5-3b3e-125fc5e1971c", "uuid": "cf4bdf4f-a211-8af8-9807-88e5cf63463a", "namespace": { "type": "project", "name": "cupidatat Ut in", "accessControl": { "read": [ "dolor" ], "write": [ "cillum anim laborum in", "sed" ], "execute": [ "consequat Lorem qui cillum", "dolor", "amet ipsum dolore" ], "manage": [ "Excepteur enim adipisicing esse nisi", "occaecat eiusmod", "do", "est velit", "dolore nulla consequat esse minim" ] } }, "description": "Port Turn Up IOS", "preAutomationTime": 5000, "sla": 10, "errorHandler": null, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": null, "createdBy": "elit aliqua", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": null, "lastUpdatedVersion": "4.69.69", "tags": [ { "_id": "973ec6c3c4f7a3eDEA083E57", "name": "do ea", "description": "officia" }, { "_id": "247e7A1d531Eb5eFBdCda7c8", "name": "Ut consequat et sit exercitation", "description": "reprehenderit" }, { "_id": "fBEBCCaA32C7FdBeBbEaBa94", "name": "est commodo nulla amet", "description": "ad in eu" }, { "_id": "386acBCcfEdbBaE1c3AA6eE9", "name": "exercitation consectetur Ut mollit enim", "description": "do Ut dolor nostrud amet" }, { "_id": "858b6EE3fE0FACe3516383bc", "name": "commodo qui", "description": "nostrud esse cupidatat qui" } ], "canvasVersion": 3, "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~0" }, { "type": "encryption", "pointer": "/~0/UO4Hvo/~1/Tq/x92m6/~1/~1/O1jCV/~1" }, { "type": "encryption", "pointer": "/GD.YHtt/wI9SfUvucJw/~1/~1/LFo/W17/YuAGbS8vM" } ], "migrationVersion": 35516734 }, { "name": "Port Turn Up IOS", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Local AAA" } ], "x": 0, "y": 100 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Local AAA" } ], "nodeLocation": { "x": -56766715.84762367, "y": 18801472.19945614 } }, "error_handler": { "name": "View Data", "summary": "Query Data Using 'json-query' Format", "description": "JSON Transformation", "app": "Tools", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~1/~1/~0/MtzXTsD0/pq/~0" }, { "type": "encryption", "pointer": "/sEN9SEMf/~1/H/7VXsQ5Df/~0/Nwp6Px/AJd/~1/fwT0hrv.o/~0/OcguXa+YJE" }, { "type": "encryption", "pointer": "/~1/M65q56.hJ/~1/~1/kvF/~0" }, { "type": "encryption", "pointer": "/~0/~0/OQgtlJx/Kzj" } ] }, "groups": [ { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Local AAA" } ], "type": "operation", "nodeLocation": { "x": -31098473.78235364, "y": 78736987.39364597 }, "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "failure" ], "autoRetry": true, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Local AAA" } ], "_id": "7857a76b-8408-8681-5d3e-688367666e15", "uuid": "7205ee87-293d-1e29-ad96-e0238b944dff", "namespace": null, "description": null, "preAutomationTime": 5000, "sla": 10, "errorHandler": null, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": null, "createdBy": "Ut cillum Duis irure", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": { "username": "admin@pronghorn", "provenance": "Local AAA" }, "lastUpdatedVersion": "4.69.69", "tags": [ { "_id": "Affe2faCFd1DbaBD2c345dEf", "name": "aliquip consectetur do", "description": "exercitation ullamco in ut" }, { "_id": "D3d2fbCC4C9489e0BdbBCAA0", "name": "consequat ut aliquip cupidatat sunt", "description": "adipisicing ad" }, { "_id": "17Bba6F77b262DA3301D0C0C", "name": "ad laborum adipisicing in", "description": "eiusmod" }, { "_id": "C0c5A408B0E8B144F3CA6eaf", "name": "cillum incididunt consequat", "description": "reprehenderit aliquip" } ], "canvasVersion": 3, "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/KC+1m7/qrO,W7Kv/tBOUS/ls1ydbD/uHc+/~0/~0" }, { "type": "encryption", "pointer": "/~0/sXsE/~1/to.//mZobg2m7ak/~1/rKcBh/w/" }, { "type": "encryption", "pointer": "/MUJbN6cDBA/~1/~0/~1/RZl01bu4xZ/~0/~0/eUbz,lqrL/QAXQIK2nIp" }, { "type": "encryption", "pointer": "/XbRX2ADU" }, { "type": "encryption", "pointer": "/ekh/M/~1/ZKq5KqZ5M/U/~1/~0/~1/~0" } ], "migrationVersion": 33219539 }, { "name": "Push Config to Device", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Pronghorn" } ], "x": 0, "y": 100 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Local AAA" } ], "nodeLocation": { "x": -58367031.362270795, "y": 70575005.29010895 } }, "error_handler": { "name": "Get Device", "summary": "JSON Transformation", "description": "Query Data Using 'json-query' Format", "app": "WorkflowEngine", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~0/nH,V98f,Qvm/~0/t+sk/~0" }, { "type": "encryption", "pointer": "/~1/~1/gQw-ZBW/zj/xv,13d/t.m/vxIfM7g9Q" }, { "type": "encryption", "pointer": "/Lgzv3bLJDcR/Oa/.d90/Emi/K/RyPHW1I/F/Hp99Oo/~0" }, { "type": "encryption", "pointer": "/~0/Lll8/Uj/~1/~0/~1/Y-t9/cspZgphs/~1/serq" }, { "type": "encryption", "pointer": "/~1" } ] }, "groups": [ { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Local AAA" } ], "type": "operation", "nodeLocation": { "x": 99012835.40731373, "y": 26108675.207598075 }, "deprecated": true, "scheduled": false, "retrySettings": null } }, "transitions": {}, "groups": [ { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Pronghorn" } ], "_id": "c4d77058-6bbf-f3dd-7543-b69a1a6d6bce", "uuid": "bf7c5568-96a4-a7d5-063f-6b242797b85b", "namespace": null, "description": "Push Config to Device", "preAutomationTime": 5000, "sla": 10, "errorHandler": null, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": null, "createdBy": "Ut magna", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": null, "lastUpdatedVersion": "4.69.69", "tags": [ { "_id": "B368CFfd22fAaedEFe3AD1bb", "name": "id elit", "description": "deserunt labore id" }, { "_id": "a3cBD1B2d8f8CcfCA5cace54", "name": "dolor magna officia", "description": "laborum mollit aliqua cillum consectetur" }, { "_id": "9Acf547cFB93aec67AF7ecf8", "name": "in non fugiat", "description": "labore ex" }, { "_id": "Abceb9185FddBBB9FEC01A5F", "name": "do", "description": "nostrud" }, { "_id": "031676DA4Fc8e3C8d100D349", "name": "incididunt pariatur non proident", "description": "laborum" } ], "canvasVersion": 1, "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~1/U4tYHnr/~0" }, { "type": "encryption", "pointer": "/~1/~1/~0/NMXo0ZQMNg/~1/Od+1bDVWN/XlHJVS5/~0/D/A82g8" }, { "type": "encryption", "pointer": "/~0/jI2x/zfZT/~0/HHCY" }, { "type": "encryption", "pointer": "/~0/RCtfnN/ZA3d3eHkXf/~0/~0/~1/xxREK" }, { "type": "encryption", "pointer": "/~0/~0/vL36BLDMz9I" } ], "migrationVersion": 15306906 } ] }
{ "type": "object", "properties": { "automations": { "title": "automations", "description": "Array of workflow documents to import. If '_id' is provided, it will be replaced with an autogenerated '_id'.", "type": "array", "items": { "$ref": "workflowDocumentAll" } } }, "required": [ "automations" ], "additionalProperties": false }
Return
| Name | Type | Description |
|---|---|---|
| response | object | Results from each individual import operation. |
{ "imported": [ { "message": "laboris ut quis", "original": { "name": "Push Config to Device", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Pronghorn" } ], "nodeLocation": { "x": 98140398.89473644, "y": 78746985.92488411 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Local AAA" } ], "x": 0, "y": 1 }, "error_handler": { "name": "Eval", "summary": "View Data", "description": "JSON Transformation", "app": "Tools", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/mw4wc/~1/~0/peIa/lepik/rcFkktfuu/TltW3H/Inf" }, { "type": "encryption", "pointer": "/Gnve,HIzXA/~1" }, { "type": "encryption", "pointer": "/hHeq+81/D96HcFiJiD" }, { "type": "encryption", "pointer": "/~1/O-g/~0/x/d" }, { "type": "encryption", "pointer": "/WnRJfuXdF1B/~0/~0/~1/sVBC./Qb" } ] }, "groups": [ { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Pronghorn" } ], "type": "operation", "nodeLocation": { "x": -70982222.59875047, "y": 7969846.155154541 }, "deprecated": true, "scheduled": true, "retrySettings": null } }, "transitions": {}, "groups": [ { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Local AAA" } ], "_id": "4e9ce337-6811-cae0-5286-5357bba776af", "uuid": "d2445238-eaf4-db64-ef12-486558ee0ba8", "namespace": null, "description": "Push Config to Device", "preAutomationTime": 250000, "sla": 10, "errorHandler": null, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": { "username": "admin@pronghorn", "provenance": "Local AAA" }, "createdBy": "sit", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": null, "lastUpdatedVersion": "4.69.69", "tags": [ { "_id": "df61cFc3bf24DCbA147dFA75", "name": "amet dolore dolore Duis", "description": "anim proident elit minim ex" }, { "_id": "B5eeFbBCC0Bc8A098Db731A2", "name": "minim deserunt in sint", "description": "ullamco dolor do" }, { "_id": "C380a3ab3B70BF6C7EB84c0c", "name": "id commodo proident minim qui", "description": "amet" }, { "_id": "77ca3C84374Dc930B6bF21eC", "name": "anim aliqua dolor", "description": "laborum officia ea qui velit" } ], "canvasVersion": 1.5, "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/d/u,P/~0" }, { "type": "encryption", "pointer": "/~1/GcIv/~1/F7/CF/~0/xm6/~1/~1/~1/SYbPbu19nFr" } ], "migrationVersion": 74066347 }, "created": null, "edit": "sed", "success": true } ] }
{ "title": "response", "type": "object", "properties": { "imported": { "type": "array", "items": { "type": "object", "properties": { "success": { "type": "boolean", "description": "Status flag denoting the success (true) or failure (false) of the workflow's import operation." }, "message": { "type": "string", "description": "Message containing either confirmation of the import operation or the reason for the failure of the import operation." }, "original": { "description": "The original workflow given in the import array.", "$ref": "workflowDocumentAll" }, "created": { "description": "The imported workflow as it exists after being imported.", "oneOf": [ { "$ref": "workflowDocument" }, { "type": "null" } ] }, "edit": { "description": "URI to the edit page for the imported workflow.", "oneOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "status", "message", "original", "created", "edit" ] } } } }