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": "Port Turn Up IOS", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Pronghorn" } ], "nodeLocation": { "x": 23472396.799729362, "y": 6787765.595908642 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Pronghorn" } ], "x": 0, "y": 1 }, "error_handler": { "name": "Query", "summary": "Query Data Using 'json-query' Format", "description": "JSON Transformation", "app": "Array", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/aDR+AOQ/wurh/~0/r/~0/~0/hou" }, { "type": "encryption", "pointer": "/zlvt/h48yg/AP6/b3cpP5DiAh/t56OM.RV/~0/ORHsdR/Y/Ts/~0" }, { "type": "encryption", "pointer": "/~1/e/hl2P1/XtZ0Eb/~1/~1/kX/~1/hTW/~1/~0" }, { "type": "encryption", "pointer": "/~0/E3/Q2a/~0/HJoR4/n.gewb" }, { "type": "encryption", "pointer": "/~0/~0/~0/b4xKmyTA" } ] }, "groups": [ { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Local AAA" } ], "type": "operation", "x": 0, "y": 1, "deprecated": true, "scheduled": false, "retrySettings": null } }, "transitions": {}, "groups": [ { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Local AAA" } ], "_id": "50751d84-503a-b910-49b9-0adae0bba9d5", "uuid": "36fb4655-6471-1721-9508-b35156503a67", "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": "magna Lorem eiusmod in cillum", "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": "d06B2Df19c8fCc5BC57FB436", "name": "laboris amet", "description": "proident dolore incididunt elit laborum" } ], "canvasVersion": 3, "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~0/~0/~0/NEYdb4Pn9r/~0/M5ux-4y/B7G0Kmh8wuS/~1" }, { "type": "encryption", "pointer": "/s188DznEysZ/~0/~0/a5.zhaMHp/tv,/HoGKG/d8y3,/z/~1/~1/ROxn" }, { "type": "encryption", "pointer": "/iH3/n1GFan1-ndN/~0/~1/~1/~0/Gv" }, { "type": "encryption", "pointer": "/~1/~0/~1/rIS-l-2jl9/~0/Ol/~0/~0/oc2Y/l" } ], "migrationVersion": 10409499 }, { "name": "Command Template Runner", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ { "name": "Admin", "provenance": "Pronghorn" } ], "nodeLocation": { "x": -59294914.39980339, "y": 84992842.39963764 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Local AAA" } ], "x": 0, "y": 1 }, "error_handler": { "name": "Query", "summary": "JSON Transformation", "description": "JSON Transformation", "app": "WorkflowEngine", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/FHCa,qr5/~1/~0/~1/~1/mX-MN./~0/~0/tQ/kd/I" }, { "type": "encryption", "pointer": "/q2lKU5O/~1/~1/~0" }, { "type": "encryption", "pointer": "/iv/fE0/wQ/~1/~0/~1" } ] }, "groups": [ { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Pronghorn" } ], "type": "operation", "x": 0, "y": 1, "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "success", "error", "failure", "failure" ], "autoRetry": true, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Local AAA" } ], "_id": "71e6629e-b67f-d065-d10b-38d29a5f66c0", "uuid": "577fdb73-d244-9f9c-5746-5f27f30ed49b", "namespace": null, "description": "Port Turn Up IOS", "preAutomationTime": 250000, "sla": 10, "errorHandler": null, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": null, "createdBy": "laborum voluptate ex irure", "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": "F2e3918CD9a5DF7DCEBacC5C", "name": "do proident elit", "description": "laboris incididunt do Ut in" }, { "_id": "d09C48D8eB5AfAdDcAAb79DB", "name": "sed consectetur minim nostrud", "description": "Lorem proident sunt exercitation" }, { "_id": "580bDF2Beb6AdE7aeD087a25", "name": "sit quis magna ea tempor", "description": "magna commodo" } ], "canvasVersion": 3, "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~0/~0/VkACtNO6" }, { "type": "encryption", "pointer": "/~0/Q/Lu56/tcRxj/tiXQ/~1/nq,B/~1/wxM9EBRswe/R8a7trDzT/yGKG7wJ9" }, { "type": "encryption", "pointer": "/~1/~0/~0/~0/~0/Q7ln3hvTO/OUWaHBr06/~1" }, { "type": "encryption", "pointer": "/~0/~1/iUPEmbzWBeX/~0" } ], "migrationVersion": 33514677 }, { "name": "Push Config to Device", "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": "Pronghorn" } ], "nodeLocation": { "x": 70077770.66938484, "y": 44841324.459413946 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Local AAA" } ], "x": 0, "y": 1 }, "error_handler": { "name": "Transformation", "summary": "JSON Transformation", "description": "View Data", "app": "WorkflowEngine", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~0/~0/~1/i/~1" }, { "type": "encryption", "pointer": "/DiTX9qF/v7-lh75S/~1/~0/~1/~0/s" }, { "type": "encryption", "pointer": "/EeW/~0/~0/~0/~0/~1/deSN8xq35/8/~0/GqmyOf" }, { "type": "encryption", "pointer": "/~0/~0/~1/~0/F94+9Jpgt/~1/~0" }, { "type": "encryption", "pointer": "/~1/~1/h," } ] }, "groups": [ { "name": "Admin", "provenance": "Pronghorn" } ], "type": "operation", "x": 0, "y": 1, "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "error", "error" ], "autoRetry": true, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Pronghorn" } ], "_id": "4baffa97-877a-3cde-bd04-05217f9b074c", "uuid": "a30756e3-4fb7-5f4a-9322-99dd1652426b", "namespace": null, "description": null, "preAutomationTime": 5000, "sla": 10, "errorHandler": null, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": { "username": "admin@pronghorn", "provenance": "Local AAA" }, "createdBy": "proident nulla in", "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": "F96bf9bb9ABFDc1bE1A7A926", "name": "pariatur aute", "description": "occaecat deserunt" }, { "_id": "48F43B7B87Ae829cbE96385B", "name": "cillum veniam enim ad officia", "description": "dolor tempor" } ], "canvasVersion": 1, "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/lPKP-Es/qmCAggmo/cxCdy/~0/~1/At947/uLkW9lOu/x/y/e/~0" }, { "type": "encryption", "pointer": "/dE/~1" }, { "type": "encryption", "pointer": "/~1/~1/~1" }, { "type": "encryption", "pointer": "/~0/~0/~1/tLzlHBPQfpN/~1/G+aCe/H//M1CcxsfT-CN" } ], "migrationVersion": 47671444 }, { "name": "Command Template Runner", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Pronghorn" } ], "nodeLocation": { "x": -1935197.6378746629, "y": -52440519.98896708 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ { "name": "Admin", "provenance": "Pronghorn" } ], "x": 0, "y": 1 }, "error_handler": { "name": "Transformation", "summary": "View Data", "description": "Query Data Using 'json-query' Format", "app": "Array", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0" }, { "type": "encryption", "pointer": "/fOVang/aJiAR" }, { "type": "encryption", "pointer": "/UEd/D6e9CyLQmn,/~1/oIdftPj/EbcacKN3et" }, { "type": "encryption", "pointer": "/~1" }, { "type": "encryption", "pointer": "/~0/~1/Pmb/~0/AXAuctuJ/U/~1/C6/~0/~1" } ] }, "groups": [ { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Pronghorn" } ], "type": "operation", "x": 0, "y": 1, "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "error", "failure", "error", "failure" ], "autoRetry": false, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ { "name": "Admin", "provenance": "Pronghorn" } ], "_id": "d36becee-7ea4-51e0-9209-d7fb9a50627e", "uuid": "a82d1fdd-f7f0-e3fd-a4ac-d15580440cda", "namespace": { "type": "project", "name": "nulla esse", "accessControl": { "read": [ "labore", "enim minim" ], "write": [ "dolore incididunt pariatur aliqua", "qui", "ipsum elit", "Duis id" ], "execute": [ "culpa", "qui do deserunt elit sunt" ], "manage": [ "est do", "Ut culpa", "dolor", "aliqua voluptate" ] } }, "description": "Port Turn Up IOS", "preAutomationTime": 250000, "sla": 10, "errorHandler": { "type": "proident do ipsum", "name": "do in Lorem" }, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": null, "createdBy": "nostrud minim Duis", "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": "A30EDeEC12aBCf0D0ACfD2eB", "name": "et Duis in", "description": "eiusmod anim" }, { "_id": "FCf9fd048B0cB8626E5C00e7", "name": "consequat", "description": "deserunt quis sint" }, { "_id": "87CB50D450Ac0CFCaa01de23", "name": "non laborum eu enim", "description": "minim adipisicing consectetur" } ], "canvasVersion": 3, "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/g+h0tNf/FNSzt0a/uKrq,T/~0/~0/b/Y/~1" }, { "type": "encryption", "pointer": "/gNelfOnP/~1/R/~1/n+n/~0/iQKuY/1.X" }, { "type": "encryption", "pointer": "/n43odB3h/~0/K,6o/~0/~1" }, { "type": "encryption", "pointer": "/YVGA0axm/YOq/~0" }, { "type": "encryption", "pointer": "/~0/~1/~0/shFhrb+/OGZwy4.WZn./GEMV.m9V/MrE2Ei/KzGch" } ], "migrationVersion": 16658845 } ] }
{ "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": "proident in", "original": { "name": "Command Template Runner", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ { "name": "Admin", "provenance": "Pronghorn" } ], "x": 0, "y": 1 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ { "name": "Admin", "provenance": "Local AAA" } ], "nodeLocation": { "x": -24068638.683218196, "y": -56906516.32698205 } }, "error_handler": { "name": "Get Device", "summary": "Query Data Using 'json-query' Format", "description": "Query Data Using 'json-query' Format", "app": "WorkflowEngine", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/p7YSgBu/jn34F/FF/d8WsKq21/~0/~1" }, { "type": "encryption", "pointer": "/~0/~0/RL9V/mg1K/UTvzawE9XEu/~0/~0/~1/~1/Bq,t+7qiya/~1" } ] }, "groups": [ { "name": "Admin", "provenance": "Pronghorn" } ], "type": "operation", "nodeLocation": { "x": 39170129.44763836, "y": -9524512.419502512 }, "deprecated": false, "scheduled": false, "retrySettings": null } }, "transitions": {}, "groups": [ { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Pronghorn" } ], "_id": "980d4c9b-9a8b-2faa-f968-a275812898b4", "uuid": "6b99b10d-2654-08c5-c28e-eddeb72c2f50", "namespace": null, "description": null, "preAutomationTime": 5000, "sla": 10, "errorHandler": null, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": { "username": "admin@pronghorn", "provenance": "Local AAA" }, "createdBy": "eiusmod", "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": "aB79dDAbCeeC929eEc8120DD", "name": "occaecat anim veniam", "description": "nisi Ut quis" }, { "_id": "748938Ee9FfDCb31a720736E", "name": "ad minim fugiat", "description": "ea deserunt voluptate amet" }, { "_id": "b6B8720B95cA11c81D6b2F2e", "name": "in laborum", "description": "quis officia laboris incididunt est" }, { "_id": "CadBc2B1CC9BfC48eA770AA4", "name": "dolor nostrud eiusmod ex", "description": "labore non ea commodo id" }, { "_id": "ba8Abb36EcbA4b8cfA7a5B9f", "name": "anim", "description": "consectetur proident dolore esse Duis" } ], "canvasVersion": 1, "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/szNrD/D" }, { "type": "encryption", "pointer": "/Z/WoM./~1/~1" }, { "type": "encryption", "pointer": "/~0/vc3Pn3Fby/~1/g,SpCwJJ/~1/~1" } ], "migrationVersion": 76295638 }, "created": null, "edit": null, "success": false } ] }
{ "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" ] } } } }