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": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [], "x": 49598353.46280688, "y": -90371274.86756465 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [], "x": -84582161.464603, "y": 35787445.652297705 }, "error_handler": { "name": "childJob", "summary": "ea veniam sint", "description": "ea", "app": "magna aliqua adipisicing ipsum Duis", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/GGiwVuKnh,o/~0/cqCM2wW5U/j3A.r/R/W1b9T2e/~0" }, { "type": "encryption", "pointer": "/iy28/kZYc/~1" }, { "type": "encryption", "pointer": "/L7BdjCvmT/~1/lz8EV49/sr,/~1/ujkpPoU/~0" }, { "type": "encryption", "pointer": "/~0/U97/k5Zqr" }, { "type": "encryption", "pointer": "/H4D/BQ3Bh6J/~0/~0/mDwRj/~0/NUye2II9/~0" } ] }, "groups": [ { "name": "sed aute aliqua voluptate pariatur", "provenance": "deserunt Lorem" }, { "name": "adipisicing quis in", "provenance": "amet voluptate anim Lorem magna" }, { "name": "sit culpa", "provenance": "proident exercitation aliqua aute" }, { "name": "in aute nostrud", "provenance": "voluptate in minim" }, { "name": "ut do ipsum cillum dolor", "provenance": "officia sit cupidatat" } ], "type": "operation", "deprecated": false, "scheduled": true } }, "transitions": {}, "groups": [ { "name": "id", "provenance": "Lorem nostrud exercitation proident" }, { "name": "Duis Lorem ut adipisicing", "provenance": "magna aliqua eu" } ], "_id": "31a86cb5-1764-eb92-2ab6-e238b2c8911b", "description": null, "preAutomationTime": -1021298.0864489675, "sla": 95506522.9550525, "errorHandler": { "type": "Duis veniam in", "name": "in nisi dolor amet officia" }, "font_size": 12, "created": "2012-10-17T08:52:26.574Z", "created_by": null, "createdVersion": "proident", "last_updated": "1946-09-24T17:55:31.79Z", "last_updated_by": null, "lastUpdatedVersion": "nisi esse dolor qui", "tags": [ { "_id": "D58F83E09b5cba3Dc60fa8Ec", "name": "mollit esse", "description": "aliquip" }, { "_id": "73fBA8f1bdd633fDBD65207d", "name": "cupidatat occaecat ut aute in", "description": "ipsum in" }, { "_id": "11085aFf2fCB77640FDaad87", "name": "in", "description": "commodo consequat veniam sit" }, { "_id": "ec41aAAC03FCAc4bC0DbaBca", "name": "eu laboris", "description": "amet occaecat deserunt cillum dolor" } ], "canvasVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/b/~0/kDI/~1/hJ/~0/xaK/.dLcjG4/ukdQ5y/~0/~0/udXR" }, { "type": "encryption", "pointer": "/~1" }, { "type": "encryption", "pointer": "/~0/~1" } ], "migrationVersion": -92984771 } ] }
{ "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": "automationImport" } } }, "required": [ "automations" ], "additionalProperties": false }
Return
Name | Type | Description |
---|---|---|
response | object | Results from each individual import operation. |
{ "imported": [ { "message": "amet", "original": { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [], "x": 61728294.07949427, "y": -10627023.29661858 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [], "x": 86271111.33021438, "y": 71254135.84409901 }, "error_handler": { "name": "childJob", "summary": "commodo officia", "description": "laboris", "app": "nisi", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/GWOQtGu/-z4/~1" }, { "type": "encryption", "pointer": "/mV4+ab/b8O9/~1/G" } ] }, "groups": [ { "name": "amet dolore dolore sed", "provenance": "Excepteur" }, { "name": "commodo eu labore deserunt", "provenance": "commodo ut do ut" }, { "name": "laborum commodo", "provenance": "ea consequat" }, { "name": "laboris irure", "provenance": "adipisicing consectetur qui laborum" } ], "type": "operation", "deprecated": true, "scheduled": false } }, "transitions": {}, "groups": [ { "name": "Lorem pariatur", "provenance": "laboris" }, { "name": "deserunt sunt", "provenance": "sunt ipsum eiusmod commodo cillum" }, { "name": "amet elit in", "provenance": "veniam reprehenderit aliquip" }, { "name": "ut sit aute cillum commodo", "provenance": "adipisicing fugiat in exercitation Duis" } ], "_id": "a59b277b-2bd8-4af3-eb7d-256afe3f97e8", "description": null, "preAutomationTime": -4746202.885373399, "sla": -50596727.547154784, "errorHandler": null, "font_size": 12, "created": "1962-11-26T01:02:17.579Z", "created_by": { "username": "in anim magna ipsum sint", "provenance": "esse cupidatat" }, "createdVersion": "Excepteur Ut id", "last_updated": "1965-03-20T15:44:14.349Z", "last_updated_by": null, "lastUpdatedVersion": "eu", "tags": [ { "_id": "e5982A6f47fFBeBcccBF7cB8", "name": "fugiat et labore id voluptate", "description": "occaecat in aliqua" } ], "canvasVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/M/l5s.nEQv/~0/KN/m1/bs/~1/~1/p0/BBYyll/~0" }, { "type": "encryption", "pointer": "/QHnqrwa/~1/~1/~1/xnEGQc/ui3va/~0/S1Vas" }, { "type": "encryption", "pointer": "/~0/~0/~0/jZlu6LFee/Q8vQDVTHM/~1" }, { "type": "encryption", "pointer": "/~0/gCh+YP9G/~0/GlprqL/YysS2QL/sfk1bHc-Rk4/~0/~1" }, { "type": "encryption", "pointer": "/~1/dJ4CXiLi2n/~1/~1/oc4yx/~0/M/8/F2p/R3/wMnsxrS1" } ], "migrationVersion": -15511581 }, "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": "automationImport" }, "created": { "description": "The imported workflow as it exists after being imported.", "oneOf": [ { "$ref": "automation" }, { "type": "null" } ] }, "edit": { "description": "URI to the edit page for the imported workflow.", "type": [ "string", "null" ] } }, "required": [ "status", "message", "original", "created", "edit" ] } } } }