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": "Local AAA" }, { "name": "Admin", "provenance": "Local AAA" }, { "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" }, { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Pronghorn" } ], "nodeLocation": { "x": -91060052.68187514, "y": 63383660.744769454 } }, "error_handler": { "name": "Eval", "summary": "View Data", "description": "JSON Transformation", "app": "WorkflowEngine", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/MsC" }, { "type": "encryption", "pointer": "/TxqHOJS2/~1/~0/~0/yDF6Lp4t/Snhevee5" } ] }, "groups": [ { "name": "Admin", "provenance": "Local AAA" } ], "type": "operation", "x": 0, "y": 100, "deprecated": true, "scheduled": false, "retrySettings": null } }, "transitions": {}, "groups": [ { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Local AAA" } ], "_id": "1fdd821b-d17f-c794-0aa0-d5b64d8efba1", "uuid": "ee6a8bf1-b57f-96d3-3379-6e0802d0afad", "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": { "username": "admin@pronghorn", "provenance": "Local AAA" }, "createdBy": "qui dolor velit", "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": "76F380d6BCa621B6d253F5dc", "name": "sunt id voluptate Excepteur est", "description": "commodo" }, { "_id": "c08F7E2CCF1BCea59ad6E473", "name": "irure est sit aliqua", "description": "est culpa eiusmod" } ], "canvasVersion": 3, "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~0/ADzFHtsfICo/a//~0/~1/~1/Ui1gT2MvyD" } ], "migrationVersion": 78632772 } ] }
{ "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": "tempor pariatur incididunt ipsum", "original": { "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" }, { "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" } ], "nodeLocation": { "x": 28918937.71201621, "y": -69181695.46771997 } }, "error_handler": { "name": "Query", "summary": "View Data", "description": "Query Data Using 'json-query' Format", "app": "Tools", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/N3x5d/Ah,yw4/~0/mS7xij/~1/~1/Xv.w/~0" }, { "type": "encryption", "pointer": "/G-2+LRiVCT" } ] }, "groups": [ { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Local AAA" } ], "type": "operation", "x": 0, "y": 1, "deprecated": true, "scheduled": true, "retrySettings": null } }, "transitions": {}, "groups": [ { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Local AAA" } ], "_id": "2bee9fbd-1f60-67d1-d0fb-f4ae43817d7d", "uuid": "86e756c4-deb6-786b-b03b-939799737cca", "namespace": null, "description": null, "preAutomationTime": 5000, "sla": 10, "errorHandler": { "type": "Ut", "name": "cupidatat Lorem amet in" }, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": { "username": "admin@pronghorn", "provenance": "Pronghorn" }, "createdBy": "aute ad veniam", "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": "Decb4bfF74a079df6E41BEcd", "name": "adipisicing proident ut", "description": "irure occaecat fugiat anim" }, { "_id": "5CC1DFaaEaaF930a77D91ECe", "name": "Duis culpa aliquip", "description": "Lorem minim ipsum" }, { "_id": "7a7Ff80BF1cC48C8F2015Fbc", "name": "nostrud consequat fugiat tempor ea", "description": "non Ut nulla esse" }, { "_id": "FF0fb5F66DC6804C36aD2c5e", "name": "aute laboris occaecat deserunt sed", "description": "esse" } ], "canvasVersion": 1, "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/p+F7/EnZWou/PO8DRS/a/ql5A4A" } ], "migrationVersion": 35478793 }, "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" ] } } } }