Summary
Replaces a workflow document.
Description
Replaces a workflow document.
Route
PUT /automation-studio/automations/:id
Roles
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Workflow id. |
| update | object | yes | Complete workflow definition to replace the existing workflow document with. |
{ "update": { "name": "Port Turn Up IOS", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "cc286d85ff96de452e987803", "fbc272c64b1b9eb8075d89d1", "dec77dd85911b0bf5b836d24", "3f2c7ddf21c3985b64400e3e", "53c4ce11efe46520bd108635" ], "nodeLocation": { "x": -82729590.71177888, "y": -79488355.17923425 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "6574e88670d35d57f119ac25", "6de988fb04cf1d8514528ba7", "272fd55c86b2217e3ec572a4", "4c62185d046944fc155b05b2", "d5494acc18ad63eb843c43db" ], "nodeLocation": { "x": 43719838.987008005, "y": -83139847.60256368 } }, "error_handler": { "name": "childJob", "summary": "id tempor dolor elit dolore", "description": "ex consectetur nostrud eiusmod mollit", "app": "dolor consequat ex aliquip", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/MIyLQ0SMc/~1/~0/he0/~0/~1/l.G6VbuFg/WZW," }, { "type": "encryption", "pointer": "/QufK/oIillN6l-T" }, { "type": "encryption", "pointer": "/cl-h/~1/~1" } ] }, "groups": [ "5f4875057932daab166034ee", "59e48bc71784c93b7b331489", "5b9bec230125f5c2cd36174d", "f66afe7cc72ff10b2641897f", "8352424a65edcce88c41cc8f" ], "type": "operation", "nodeLocation": { "x": -66444738.14315597, "y": 34628002.94534388 }, "deprecated": true, "scheduled": true, "retrySettings": null } }, "transitions": {}, "groups": [ "3b82d5a849540ceb9b909741", "f88964500dbc0228d7a59db5", "13922a017862be38936f9a28", "020b0808cb99b063a8b8f6ad", "b02561a2d4aef4e90ff1b77b" ], "canvasVersion": 3, "_id": "1a799892-21bd-7479-6b0f-41e6b3fd1e9f", "uuid": "987b05d8-7175-68f4-4809-ccd88bb9867b", "namespace": { "type": "project", "name": "sunt id", "accessControl": { "read": [ "Excepteur exercitation non", "est", "voluptate nostrud", "nisi", "Lorem" ], "write": [ "ex et aliquip", "do", "in elit", "laboris sint", "ipsum" ], "execute": [ "tempor", "aute eiusmod aliquip officia sunt", "in occaecat", "sint ut proident in in", "et aliquip proident" ], "manage": [ "enim fugiat amet anim", "eu non", "dolor labore", "et reprehenderit quis", "incididunt dolore ea nulla" ] } }, "description": null, "preAutomationTime": 250000, "sla": 47129746, "errorHandler": { "type": "tempor sunt", "name": "enim sunt cupidatat occaecat Duis" }, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "60bcef1413214a57ed9b5364", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "046ee1a0343cfec3ce5771f6", "lastUpdatedVersion": "4.69.69", "tags": [ "incididunt est proident" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~1" }, { "type": "encryption", "pointer": "/~1/ID6a" }, { "type": "encryption", "pointer": "/VYs-3ke0mwF/NGVrlm/~1/Z/~0/PiK/X6lEC/~1/o/~1" }, { "type": "encryption", "pointer": "/rG9hIgpMdi/~1/ASjetmIqj/D9jtBz8OupY/c8KVLT.vP./~1" }, { "type": "encryption", "pointer": "/~0/~0/bY9/~1/~1/~1/LI/~0" } ], "migrationVersion": 44763644 } }
{ "type": "object", "properties": { "update": { "title": "update", "description": "Complete workflow definition to replace the existing workflow document with.", "$ref": "workflowDocument" } }, "required": [ "update" ], "additionalProperties": false }
Return
| Name | Type | Description |
|---|---|---|
| response | object | Response object. |
{ "updated": { "name": "Command Template Runner", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "692699bdb853ac14e7f0b434", "2c9f5d48827d7f9140b8ddf3" ], "nodeLocation": { "x": 84277437.20257452, "y": 60931023.31210488 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "199771546cb627844f3d93e9", "9710ddb97fc97334e56aef20", "12a5b2678a486548905fb489" ], "nodeLocation": { "x": 16596130.158508822, "y": 20067949.86473079 } }, "error_handler": { "name": "childJob", "summary": "pariatur cupidatat", "description": "officia in laboris cupidatat", "app": "Excepteur tempor ad elit sed", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0" }, { "type": "encryption", "pointer": "/l/rD/Ogm" }, { "type": "encryption", "pointer": "/~0/Ru5ULw/mkMMxXm/~1/~1/~1/~1/~1/~0" }, { "type": "encryption", "pointer": "/~1/mv/~0/moK/U8tw/~0/jJzI9+x/wa/Wstk1df+a/~0/C975I-/~0" } ] }, "groups": [ "304158bcc41dfb0ce05383ab", "669a06c6fa4c05e6ce18ef05", "48940157de0d9de89b664879" ], "type": "operation", "nodeLocation": { "x": -77615072.3901683, "y": 72040890.45419034 }, "deprecated": false, "scheduled": true, "retrySettings": null } }, "transitions": {}, "groups": [ "6af0c853cb4cc105b61352b5", "f8337edbc9c342a92ae4cab3", "1d0e02f4122b00635753648b", "edcb0e95f3e17f74015fe0f4", "5c2dfad92e70d39c6ed75725" ], "canvasVersion": 3, "_id": "784a41bb-bbf5-7d2b-0927-2acf35d68cf9", "uuid": "fa37c0ea-0286-1bd5-34c6-7d9a3733cf17", "namespace": { "type": "project", "name": "aliqua consequat consectetur velit", "accessControl": { "read": [ "sed reprehenderit proident laborum", "mollit anim ex adipisicing", "do exercitation Lorem Duis" ], "write": [ "sint", "in Excepteur cillum velit consectetur", "nisi sit eu" ], "execute": [ "ullamco esse sint cillum" ], "manage": [ "veniam quis aliqua ullamco irure" ] } }, "description": null, "preAutomationTime": 250000, "sla": -80570386, "errorHandler": { "type": "irure est dolore", "name": "eu Excepteur culpa" }, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "3e69a9d0e7ce834394680628", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "ac3631ec41b7548217f67204", "lastUpdatedVersion": "4.69.69", "tags": [ "enim est culpa" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~1/~1/ZZ/x1XUF/VVa3HK/~0/jU/~0/zShnm+o/ILDu2Jf/" }, { "type": "encryption", "pointer": "/~0/B/~0" } ], "migrationVersion": 4965943 }, "edit": "tempor elit" }
{ "title": "response", "type": "object", "properties": { "updated": { "description": "Workflow document after applying the update.", "$ref": "workflowDocument" }, "edit": { "type": "string", "description": "URI to the edit page for the updated workflow." } }, "required": [ "updated", "edit" ] }