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": "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" } ], "x": 0, "y": 100 }, "error_handler": { "name": "Eval", "summary": "View Data", "description": "Query Data Using 'json-query' Format", "app": "WorkflowEngine", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/tC2jb6-/~0/FmWOmQrrh3x/ckL3/4/~1/InN9PHmJTg/Dbn/KbLwnfuL-L4/YHF+Vyy/~1" } ] }, "groups": [ { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Pronghorn" } ], "type": "operation", "nodeLocation": { "x": 66968607.64138609, "y": -56315918.471243575 }, "deprecated": false, "scheduled": true, "retrySettings": null } }, "transitions": {}, "groups": [ { "name": "Admin", "provenance": "Pronghorn" }, { "name": "Admin", "provenance": "Local AAA" } ], "_id": "595c9742-2281-02f8-40cb-7e998af18e7b", "uuid": "3983f01c-14c0-7227-f4e0-56061e8a8e02", "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": "quis tempor consequat reprehenderit labore", "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": "Ca8E050bEcc3Cc2a1a811D6A", "name": "Ut labore velit", "description": "ut ad" }, { "_id": "188ba5C2df6dFbc1FbaC027b", "name": "fugiat dolore", "description": "nulla aliqua" } ], "canvasVersion": 3, "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~1/~0/~0/stW3Cp/Nrs/E" }, { "type": "encryption", "pointer": "/~1/YXV/~1/v13-LY/~1/agM+tuSDR/~0/~0/I-/~0" }, { "type": "encryption", "pointer": "/~0/~1/D1fK.1T./~0/~0/~1/ufU8OD/~1" }, { "type": "encryption", "pointer": "/~1/Uf." }, { "type": "encryption", "pointer": "/vGCnt/b-/Po6L/~0/~0/~1/b8f39/bllT,TtE" } ], "migrationVersion": 74172956 } ] }
{ "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": "elit velit non pariatur", "original": { "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" } ], "x": 0, "y": 1 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ { "name": "Admin", "provenance": "Local AAA" }, { "name": "Admin", "provenance": "Pronghorn" } ], "x": 0, "y": 100 }, "error_handler": { "name": "Transformation", "summary": "Query Data Using 'json-query' Format", "description": "Query Data Using 'json-query' Format", "app": "WorkflowEngine", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/hMq8VuN9sW" }, { "type": "encryption", "pointer": "/Rdt3HevkGLw/elidS5pGf/E/CjXZHZ,uw1b/~1/sRCY8M/ri/hk4It/yHDN" }, { "type": "encryption", "pointer": "/wNS7/b.IRIdx" } ] }, "groups": [ { "name": "Admin", "provenance": "Local AAA" } ], "type": "operation", "x": 0, "y": 100, "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "failure" ], "autoRetry": false, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ { "name": "Admin", "provenance": "Local AAA" } ], "_id": "7c308069-2a21-0f39-ebec-5dc0728cf624", "uuid": "2e4d683a-c5c2-fb42-fb70-f1ed5d6727c8", "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": "sed sint sunt Excepteur", "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": "24eEB91D72dAAA54dA47D01e", "name": "proident ad velit magna", "description": "velit dolor incididunt tempor sunt" } ], "canvasVersion": 3, "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~1/~0/~1/fzPmu+d/~0/T2Yk/aU0l/~1" } ], "migrationVersion": 11281731 }, "created": null, "edit": "ut et", "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" ] } } } }