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" }, { "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": "Local AAA" }, { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Pronghorn" } ], "x": 0, "y": 100 }, "error_handler": { "name": "Transformation", "summary": "View Data", "description": "JSON Transformation", "app": "Array", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/ju9AusLif/zK7/~1/TxGHhrH/~1/bkc5eE4" }, { "type": "encryption", "pointer": "/~1/~0" }, { "type": "encryption", "pointer": "/~1/~1/~1/EC/~0/~0/~1/~1/II9rv5/y8OCI" }, { "type": "encryption", "pointer": "/GdX/HBJ/~1/~1/jUMlI-iT5pR" }, { "type": "encryption", "pointer": "/~1/~1/~1/h3cJ.5" } ] }, "groups": [ { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Pronghorn" } ], "type": "operation", "x": 0, "y": 100, "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "success", "success", "success", "failure", "success" ], "autoRetry": false, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Local AAA" } ], "_id": "78b3e39f-543f-7b5a-3e56-88dcd53d663b", "uuid": "ae0da9ec-d84a-9983-5eed-8a33172f7cf2", "namespace": null, "description": "Push Config to Device", "preAutomationTime": 5000, "sla": 10, "errorHandler": { "type": "sunt in anim Excepteur", "name": "nisi eiusmod ea" }, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": { "username": "admin@pronghorn", "provenance": "Pronghorn" }, "createdBy": "ipsum 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": "c53FeC8A639C5E0CFe5D5fAa", "name": "amet dolor", "description": "Excepteur non" }, { "_id": "Dcec4Bc0BEa3e3ecbaC8C5E5", "name": "aliquip", "description": "in id" }, { "_id": "E3f7b4D3fd11C4D43F5d1CeB", "name": "eu eiusmod occaecat Lorem", "description": "adipisicing ipsum consectetur" }, { "_id": "4E5EAcfCCaF0Dd7f9E3bCEeF", "name": "Lorem pariatur eu dolore Duis", "description": "minim Excepteur" } ], "canvasVersion": 1.5, "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/rDM/~1/V-/C/~0/~0/iSq6cwQG1v" }, { "type": "encryption", "pointer": "/w/ENM/~0/~0/~0/BwBU/~0/~1" }, { "type": "encryption", "pointer": "/~1" }, { "type": "encryption", "pointer": "/~1/~1/~1/~0/Vsyyl-Y-z/BWPFx" }, { "type": "encryption", "pointer": "/~0/~1/k" } ], "migrationVersion": 74980027 }, { "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": "Local AAA" } ], "x": 0, "y": 100 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Pronghorn" } ], "x": 0, "y": 100 }, "error_handler": { "name": "Query", "summary": "View Data", "description": "View Data", "app": "Array", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~0/qfp7h/z1HK09/U/~0/UaMhW3ggF" }, { "type": "encryption", "pointer": "/r/~1/f7/yQAAzPDOET/~0/~1/~1/~0" }, { "type": "encryption", "pointer": "/kh+Uj+r/~1/G1Y/hkV.dbDQ/m/Iuedl/lMz92p/~0/G9pVIE7/~1/KjI0gZEtdG6/~1" } ] }, "groups": [ { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Pronghorn" } ], "type": "operation", "x": 0, "y": 100, "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "success", "success", "failure", "success" ], "autoRetry": true, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Local AAA" } ], "_id": "7612fe50-d88b-0401-21a5-5ddbbcb49cf5", "uuid": "8bd325d6-c2ab-26e4-b772-7a3b921aa0f8", "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": "enim elit amet dolore", "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": "1958FE146Bb6eD33aA2F6DA1", "name": "ut Excepteur aute occaecat", "description": "incididunt" }, { "_id": "37F21B5Ce9dc4d3460dC8e2e", "name": "esse ut voluptate incididunt", "description": "et do aliquip in" } ], "canvasVersion": 1, "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/f/Y5ql1" }, { "type": "encryption", "pointer": "/~0" }, { "type": "encryption", "pointer": "/~0/~0/~0/WCTYpBZasWq/mgFDQ6BW7n3/Dpw0MhUp/~1/~0" }, { "type": "encryption", "pointer": "/g/~1/ASJ3/AZ0,lTNK6/Q9VBfBeX/~1/~0/~0/J0/XM/PLJKhDwbju" } ], "migrationVersion": 66954431 }, { "name": "Port Turn Up IOS", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ { "name": "Admin", "provenance": "Local AAA" } ], "x": 0, "y": 100 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Local AAA" } ], "x": 0, "y": 100 }, "error_handler": { "name": "Query", "summary": "Query Data Using 'json-query' Format", "description": "View Data", "app": "Array", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~0/L+9UW9c6Vkd/~1/~0/~1/S.d0lfa/~0/iqwWyP/sKqz/fipo" } ] }, "groups": [ { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Local AAA" } ], "type": "operation", "x": 0, "y": 100, "deprecated": true, "scheduled": false, "retrySettings": null } }, "transitions": {}, "groups": [ { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Pronghorn" } ], "_id": "3645267c-65cf-0a51-6def-e991299f92b6", "uuid": "c565d755-80f4-7119-34c7-f0f96db8dbd9", "namespace": { "type": "project", "name": "cupidatat", "accessControl": { "read": [ "occaecat ipsum id fugiat", "id", "est Lorem", "cillum ea" ], "write": [ "sunt" ], "execute": [ "pariatur", "et irure", "consequat dolor", "consequat" ], "manage": [ "in laborum magna", "veniam esse in sunt mollit" ] } }, "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": "in nisi Duis aliquip", "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": "A20e5BAe4708Ec40b2bbdC9D", "name": "Excepteur in", "description": "fugiat dolore cillum" }, { "_id": "F17B56dDea5C2889557d53A4", "name": "aute incididunt", "description": "Duis ad commodo" }, { "_id": "224bA5A4F3069D1B51b9A00A", "name": "eu ex ea fugiat culpa", "description": "ut dolore nulla dolore" }, { "_id": "cbF2278Ff2Ded7aef0ED0aE7", "name": "aute", "description": "labore amet id irure" } ], "canvasVersion": 3, "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/r27+W/~1/~0/q/~0/L/dzs6GlpL." }, { "type": "encryption", "pointer": "/~1/Do/~1" }, { "type": "encryption", "pointer": "/~0/~1/~1/~1/vJ0YshjijK9" } ], "migrationVersion": 80750081 } ] }
{ "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 veniam tempor Ut", "original": { "name": "Port Turn Up IOS", "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" } ], "nodeLocation": { "x": 15353573.480812833, "y": -32767062.776667416 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Local AAA" } ], "x": 0, "y": 100 }, "error_handler": { "name": "Transformation", "summary": "Query Data Using 'json-query' Format", "description": "View Data", "app": "Tools", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/j0VyaQVL7R/eqnIGu/~1/~0/G/cVh/IJI" }, { "type": "encryption", "pointer": "/~1/~1/F/ssM4/~1/tlng/~0" }, { "type": "encryption", "pointer": "/~0/LaYPC/BT/hC64Z62//VzR-J/cnWbH/q2UI/Wy7Yc.S9/hTsdsI54N/~0/ckkX" } ] }, "groups": [ { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Local AAA" } ], "type": "operation", "x": 0, "y": 100, "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "failure", "error", "error" ], "autoRetry": false, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Local AAA" } ], "_id": "a9388672-fd97-0892-ffcf-1e64d20a85a6", "uuid": "519b2e52-9b80-2d30-02ff-c98f0f685edd", "namespace": { "type": "project", "name": "velit labore", "accessControl": { "read": [ "sunt dolore deserunt", "officia", "et ad dolor ipsum id", "eiusmod nisi eu" ], "write": [ "occaecat quis", "amet ad veniam nisi", "ea do Lorem Ut" ], "execute": [ "et do deserunt mollit nostrud", "enim", "ut", "nisi dolor sed eu" ], "manage": [ "ea occaecat", "nisi sit cillum anim consequat", "dolor" ] } }, "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": "officia ut exercitation id esse", "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": "7eDa25F335d9A4653e4FCbfb", "name": "do", "description": "eiusmod" } ], "canvasVersion": 2, "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~0/~0/RTDpfTmZnee/YvwH3/~1/uo,kChVhU/~1/VtG7Me/~1" } ], "migrationVersion": 30883090 }, "created": { "name": "Push Config to Device", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "aea0d28ba4a90e9c72dced8f", "9366243a45241e07837fdcb4", "ee447355bed8b0f355f11937", "905443bc351e5f46669d22db" ], "nodeLocation": { "x": -23500170.331995875, "y": -24250639.91588585 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "bf9f2a6a67ac41cef1663df0" ], "nodeLocation": { "x": 4247706.604667693, "y": 63738180.29368636 } }, "error_handler": { "name": "childJob", "summary": "sed in velit", "description": "reprehenderit", "app": "elit fugiat", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/W5Ler/~0/~0/~0/~1" }, { "type": "encryption", "pointer": "/~1/lV4n-hWaFG+/~1/xD/~1/~1/~0/~0" }, { "type": "encryption", "pointer": "/kkcIk2f/K96JmLjZMSk/~0/~1" }, { "type": "encryption", "pointer": "/~1/xMF4c/AQNU6/X54yB9LcC1/~0/vw/~0" } ] }, "groups": [ "fe57e2e9e5dd26e3d71b9735", "d1687d9e8496dc25fb329e9e", "497a0cf8fe2ced943e4084ab" ], "type": "operation", "nodeLocation": { "x": -91231991.92398675, "y": -1555637.5332190841 }, "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "error", "error", "failure", "success", "success" ], "autoRetry": true, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "acedcc220621809b90b03ff2", "46b9d3082dbcf636a9137c7a", "1a5ca104c19dce0f16510fc1", "39f95f97858ce8e45a1c89b7" ], "canvasVersion": 3, "_id": "b8b78986-2fa0-7065-66b3-589bfdb1d96e", "uuid": "ec044909-8ec4-016a-a8ae-90b29d7b78e1", "namespace": { "type": "project", "name": "culpa dolore", "accessControl": { "read": [ "dolore occaecat ipsum nostrud qui", "fugiat dolor Duis adipisicing", "qui" ], "write": [ "incididunt consectetur amet", "laborum ut id", "non magna elit officia", "in velit occaecat laboris fugiat" ], "execute": [ "culpa officia adipisicing sint", "culpa cupidatat veniam", "aliqua aute nostrud", "consectetur aliqua id adipisicing fugiat" ], "manage": [ "incididunt in nulla", "laboris eu esse aliquip", "elit exercitation eiusmod velit commodo" ] } }, "description": "Push Config to Device", "preAutomationTime": 5000, "sla": 5986792, "errorHandler": { "type": "in ex Ut sunt tempor", "name": "proident" }, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "adecb092a5fc7065d5cf9b2d", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "a82d6e948e88e4e0664e67e9", "lastUpdatedVersion": "4.69.69", "tags": [ "incididunt sed anim", "Excepteur enim" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/BZPnp/dSy/woH2/Jux6ZCE,03/~0/~0/O" }, { "type": "encryption", "pointer": "/~1/FRXiMTG5/rtdY,jP/~0/s/ZSrVZf/aVGKuFs/BXOQAHx/~1/MMEh5WzMd1L/~0" }, { "type": "encryption", "pointer": "/pX/PiPAEv/FO" }, { "type": "encryption", "pointer": "/CFS4/~0/~0/~0/RKuLmi5j/~1/~0/~0/PCP94ae" }, { "type": "encryption", "pointer": "/~1/PnTj8z9F3/fVKoymO," } ], "migrationVersion": 70592056 }, "edit": "qui magna laborum", "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" ] } } } }