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" }, { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Pronghorn" } ], "x": 0, "y": 1 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Local AAA" } ], "nodeLocation": { "x": 8836112.479974419, "y": 61670928.12221861 } }, "error_handler": { "name": "Get Device", "summary": "Query Data Using 'json-query' Format", "description": "JSON Transformation", "app": "Tools", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/dShx8y/mXZC/~1/~1/T/bK,WTm2JFg/m-N/CPSJoFqfgN" }, { "type": "encryption", "pointer": "/JI/fgJ/R-lOx1/~0/~0/~0/~1/ByMLN/~0/~1" }, { "type": "encryption", "pointer": "/G6O3FciLwZk/~0/nKuioM,/L8NC.VlQE/WSy/~1" }, { "type": "encryption", "pointer": "/XP" } ] }, "groups": [ { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Local AAA" } ], "type": "operation", "x": 0, "y": 1, "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "success", "failure", "error" ], "autoRetry": false, "limit": 20, "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" }, { "name": "Admin", "provenance": "Pronghorn" } ], "_id": "d0f184ea-157a-382a-2adc-40f29de02bde", "uuid": "f382e02c-4589-9f7a-ac1c-d966ec1e777f", "namespace": { "type": "project", "name": "elit nisi irure laborum", "accessControl": { "read": [ "quis dolor velit aliqua", "eu aute ullamco esse", "pariatur ex incididunt minim quis", "cupidatat ut", "Lorem occaecat" ], "write": [ "irure in deserunt minim nulla", "ut", "sunt", "eu eiusmod in veniam" ], "execute": [ "occaecat magna id sint", "sunt adipisicing et est aliquip", "ad in ut" ], "manage": [ "aliquip et eiusmod deserunt", "non sed", "qui magna pariatur voluptate nulla", "ex id cupidatat", "anim nostrud ex mollit est" ] } }, "description": "Port Turn Up IOS", "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": "laboris pariatur", "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": "fEacDDFBff939EbAeEdCfB44", "name": "esse eiusmod qui et", "description": "est minim" }, { "_id": "18fD73Fc619a9758c2eC9CD0", "name": "dolor magna in sit", "description": "ad" }, { "_id": "618FA62bc839f82B22B2C63E", "name": "nostrud Duis ut eiusmod Lorem", "description": "pariatur sit proident id veniam" }, { "_id": "8c89Fe7b71aAa42AACFd4140", "name": "deserunt ullamco nostrud", "description": "deserunt" } ], "canvasVersion": 2, "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~1" }, { "type": "encryption", "pointer": "/UDFzsLEQm" }, { "type": "encryption", "pointer": "/pg/~0/~0/~1" }, { "type": "encryption", "pointer": "/~1/~0" } ], "migrationVersion": 10829598 }, { "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" } ], "x": 0, "y": 1 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ { "name": "Admin", "provenance": "Local AAA" } ], "nodeLocation": { "x": -52475623.84616189, "y": -24208131.26766172 } }, "error_handler": { "name": "Query", "summary": "JSON Transformation", "description": "View Data", "app": "WorkflowEngine", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/zf7y" }, { "type": "encryption", "pointer": "/uW/pU5Wtb/C22TFweIho/~0/am71o/l2/xtaItvW/Ifq3/hR6xW" }, { "type": "encryption", "pointer": "/~1/~1/tuVpj8Ipq" }, { "type": "encryption", "pointer": "/~1/WUToJpG-00/UIPzVe-/~1" }, { "type": "encryption", "pointer": "/~1/Eo/f.gWEE/CC/~0/~1/noyI/~0/~0/PMWIbNRH1tG/I-" } ] }, "groups": [ { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Local AAA" } ], "type": "operation", "x": 0, "y": 1, "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "success", "failure", "error", "success" ], "autoRetry": false, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Local AAA" } ], "_id": "db76ce24-879a-0351-a7e8-71dfcf2300c4", "uuid": "231d9def-629e-15ac-d073-1f216863ceac", "namespace": { "type": "project", "name": "occaecat in", "accessControl": { "read": [ "occaecat do Excepteur aute", "ut magna pariatur ex", "in consectetur" ], "write": [ "consectetur reprehenderit", "Lorem veniam", "id est pariatur labore", "elit culpa enim minim ipsum", "officia dolor" ], "execute": [ "sunt in", "velit", "laboris fugiat commodo id" ], "manage": [ "mollit pariatur veniam ea", "enim quis", "ea" ] } }, "description": null, "preAutomationTime": 250000, "sla": 10, "errorHandler": { "type": "sed culpa velit", "name": "mollit aliqua occaecat aliquip Ut" }, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": null, "createdBy": "sint labore anim 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": "Da1C8eDDd9D3CB29FFEa9c6F", "name": "eu laborum ullamco", "description": "deserunt est anim ut Lorem" }, { "_id": "DFEFc10d0ADE7EB2191d3CBB", "name": "magna anim adipisicing elit dolore", "description": "nulla consequat non" } ], "canvasVersion": 1, "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~0/eKQaJp/~0/Q6M,A0HQs/nSpHixdbDZ/bXI" }, { "type": "encryption", "pointer": "/~0/~0" } ], "migrationVersion": 59802870 }, { "name": "Command Template Runner", "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": 1 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Local AAA" } ], "nodeLocation": { "x": 79353307.05628148, "y": -2942846.4869116396 } }, "error_handler": { "name": "View Data", "summary": "Query Data Using 'json-query' Format", "description": "Query Data Using 'json-query' Format", "app": "Array", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~1/y/Jz/Or/yscz2/~0/~1" }, { "type": "encryption", "pointer": "/~1/~0/wMi5K/BB,.nFTNB/DReRZGiNYnb/ehSoRbLQ/B6SV9R.L6/Uw/~1" } ] }, "groups": [ { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Local AAA" } ], "type": "operation", "x": 0, "y": 1, "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "failure", "error" ], "autoRetry": true, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ { "name": "Admin", "provenance": "Local AAA" } ], "_id": "f521071b-a967-1c5b-e559-cc71b3818325", "uuid": "85076eac-ee31-6417-dae9-c24a1925a399", "namespace": null, "description": null, "preAutomationTime": 5000, "sla": 10, "errorHandler": { "type": "nisi cillum ullamco", "name": "velit amet pariatur" }, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": { "username": "admin@pronghorn", "provenance": "Pronghorn" }, "createdBy": "laboris laborum dolor 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": "Aecf8C0bA7eBE4f8d427b16D", "name": "non minim", "description": "aliquip laborum fugiat" }, { "_id": "C0FAcC5Bf8709Fe22515ae22", "name": "sunt amet ut dolor", "description": "voluptate cupidatat labore" }, { "_id": "089bB1700398BCCd2E2aF15e", "name": "reprehenderit velit", "description": "consectetur" }, { "_id": "f10ADf7fF011dDBeeb7f530d", "name": "Duis", "description": "amet laborum cupidatat laboris dolor" }, { "_id": "399Ea47364446B3EEc724ed7", "name": "in", "description": "ex sint consequat" } ], "canvasVersion": 1.5, "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~0" }, { "type": "encryption", "pointer": "/Bu/erMa/kjUObF/~0/~0/~0/~0" }, { "type": "encryption", "pointer": "/Z/~1/~1/~1/~1/~1/~1/~0/Yr4Jes3K7k/~1" } ], "migrationVersion": 97183081 }, { "name": "Command Template Runner", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Pronghorn" } ], "x": 0, "y": 1 }, "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" }, { "name": "Admin", "provenance": "Local AAA" } ], "nodeLocation": { "x": 15509477.65458548, "y": -89427242.07489215 } }, "error_handler": { "name": "Eval", "summary": "View Data", "description": "JSON Transformation", "app": "WorkflowEngine", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~1/~0" }, { "type": "encryption", "pointer": "/Pu/IP4w/Y7zZ8B5HdmG/XatS3eO9K/~1" }, { "type": "encryption", "pointer": "/~0/kLL5ZFez/M0h-xb/b1l/dEKjrO4NHe/pUXD6xNEb/l/VqNhS/tvh9lxJ-.g" }, { "type": "encryption", "pointer": "/JarF8jc/~0/hb+SaOsth/HupBI" }, { "type": "encryption", "pointer": "/uw5/FFbKRc,kp/TDeAyEFjbuk/~0/~1/F1//GTSdw5g/~0" } ] }, "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": "Local AAA" }, { "name": "Admin", "provenance": "Pronghorn" } ], "_id": "641e81e7-04b3-be09-6c66-18fd90733698", "uuid": "bb698056-2b0f-9d4b-c3cc-991c7bf0606c", "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": "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": "Fb5AfEC87e26Aea1cEC527fA", "name": "sint ea", "description": "velit aliqua labore voluptate sint" }, { "_id": "DF253be438CCc1CA0CD1ea4f", "name": "ipsum cillum", "description": "sed" }, { "_id": "49F7bb5B469A38a3F0f9ac9b", "name": "culpa Excepteur non pariatur", "description": "dolore culpa officia pariatur" }, { "_id": "6ae07DfCb65Bc60C481A8f14", "name": "velit culpa", "description": "officia quis aliqua qui veniam" } ], "canvasVersion": 2, "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/Z5qlbVi/b/czquKclns//IRZh,L/wZSsals7" }, { "type": "encryption", "pointer": "/jxu/zJcMgOnwbX/VC5vTisP/I/~0/k+/Fc7P6vGdeGm/yk7cvo/~1/RmgYZG/vdIx8NGu" } ], "migrationVersion": 58526500 } ] }
{ "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": "dolore", "original": { "name": "Port Turn Up IOS", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ { "name": "Admin", "provenance": "Pronghorn" } ], "nodeLocation": { "x": -93240142.08563165, "y": -6779563.680914208 } }, "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": "View Data", "summary": "JSON Transformation", "description": "Query Data Using 'json-query' Format", "app": "Array", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/BNjtdaKq/lPXiq5cCQ" }, { "type": "encryption", "pointer": "/~0/S/D6/jCDLoZL1F" }, { "type": "encryption", "pointer": "/~1/~0" }, { "type": "encryption", "pointer": "/~1/~0/dFs65J" } ] }, "groups": [ { "name": "Admin", "provenance": "Pronghorn" } ], "type": "operation", "x": 0, "y": 1, "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "failure", "success", "success" ], "autoRetry": false, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Local AAA" } ], "_id": "b2ddf604-4e05-2fca-ccb0-052889065012", "uuid": "1b068153-e9fa-485d-c03a-c96158f9ca74", "namespace": { "type": "project", "name": "aliqua sit", "accessControl": { "read": [ "sint", "sed nulla" ], "write": [ "non ea", "laboris consequat" ], "execute": [ "nostrud Lorem ad deserunt magna", "ut ad" ], "manage": [ "ut velit ut", "incididunt in et reprehenderit" ] } }, "description": null, "preAutomationTime": 5000, "sla": 10, "errorHandler": { "type": "do quis exercitation ea aliquip", "name": "ut et ut" }, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": { "username": "admin@pronghorn", "provenance": "Pronghorn" }, "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": "1f55320BFA2F852908ae1ebe", "name": "consectetur", "description": "ea" }, { "_id": "db6adAD3feAE6D14cB05FaCE", "name": "do dolore", "description": "sunt ad est" }, { "_id": "Eb6054CBaecFFFFC6AfbB9Bd", "name": "in exercitation sed", "description": "in aliqua aliquip esse" }, { "_id": "e778Be587BF8c25EE8a77eAf", "name": "mollit", "description": "reprehenderit id consequat" }, { "_id": "4FDbfC7BAbaeAc5521b9f73E", "name": "nulla laborum culpa ea cupidatat", "description": "exercitation veniam" } ], "canvasVersion": 1, "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/IZ,RtqVcn+B/~1/~1/kgYVq7/j/kq/~0/wnv.qkMd" }, { "type": "encryption", "pointer": "/Cpkx/IUq27cc" }, { "type": "encryption", "pointer": "/~0/v70pj/dkl" }, { "type": "encryption", "pointer": "/J" }, { "type": "encryption", "pointer": "/gsAHw/~1/cIkUyvWGSO2/LoJvK5JZY/~1/~0" } ], "migrationVersion": 88654330 }, "created": { "name": "Push Config to Device", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "4d1851ee7a933db65ca1bfc5", "1d513803c2ea97b3df9b3257" ], "nodeLocation": { "x": -93585583.24705668, "y": 77463926.80953321 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "c0aa8fb1bb325bc0da426308", "488323bb308780c80b136caf" ], "nodeLocation": { "x": 95105441.33801457, "y": -28275044.308342785 } }, "error_handler": { "name": "childJob", "summary": "Ut proident officia aute ut", "description": "enim fugiat exercitation dolor", "app": "enim aute", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/oF/~0" }, { "type": "encryption", "pointer": "/~0/~1/JyARHNWs/qSXFIaZFDO/Ni0g/S/N-sD-Aw/~1" }, { "type": "encryption", "pointer": "/ivk/~1/Lze5KqesKBH/~1/~0/bB2m/Mm/gC4+X9/ZXIPu9pANMt/Q3lcvWSU-z/Rb+J7" }, { "type": "encryption", "pointer": "/~0/HocVXg3pu/Z/~0/~1/~1/ET+Hdy56ApJ/~0/~1/~0" }, { "type": "encryption", "pointer": "/KweH/SElt8Q/rw/TlZcPsW.sR2/MEEg/+spCaH/~0/hAAkOfq,/WKdt/k/~1" } ] }, "groups": [ "314867e10ff1d65eee7c3ca0", "9d117907ef44ef30042d23c8" ], "type": "operation", "nodeLocation": { "x": -25856633.07348062, "y": -54673672.48686421 }, "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "success", "success", "success", "success" ], "autoRetry": false, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "7715ae3a7b9f5b2be986c151", "a0f3c599f87decc55b68dce0", "00f1e0b08aefd01ca8a480d3", "6591a9528b70f728834f6f3f", "2fd4a6d9e27e83679030150a" ], "canvasVersion": 3, "_id": "4ca59d39-0b2e-375e-2808-c63089ba720d", "uuid": "c4b0d8ed-be3c-73b7-aa8d-b40f50d8f5f3", "namespace": { "type": "project", "name": "minim ut Lorem est non", "accessControl": { "read": [ "consectetur tempor" ], "write": [ "sunt", "proident tempor elit ullamco", "irure", "incididunt mollit" ], "execute": [ "nisi aute anim ut quis", "exercitation do sed culpa", "culpa", "deserunt", "deserunt consectetur minim anim sint" ], "manage": [ "Ut adipisicing tempor" ] } }, "description": "Push Config to Device", "preAutomationTime": 250000, "sla": 86350239, "errorHandler": { "type": "nisi commodo cupidatat magna", "name": "fugiat ullamco" }, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "236987635ca1e5ff47b2a28a", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "a50255e6f33691af0568a22f", "lastUpdatedVersion": "4.69.69", "tags": [ "eu tempor ipsum" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~1" } ], "migrationVersion": 94271681 }, "edit": null, "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" ] } } } }