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": [ "d031c7cceafe300be87fc1f7", "72f0796348f5c3d63699aedf" ], "nodeLocation": { "x": 7231488.7667452395, "y": -11841829.980313227 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "b7b251a4f5a360942d18e739", "8aa0572e62cc83e46e898989", "4f8f6369460c1f405aea361c" ], "nodeLocation": { "x": 63815059.232601315, "y": -12640802.242182717 } }, "error_handler": { "name": "childJob", "summary": "est nisi in", "description": "nisi est magna", "app": "occaecat ut ad", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/n" }, { "type": "encryption", "pointer": "/vvBx-WjKA/~1/~0/Lc.O5G/qpD/~1/~0/~0/K9Z/~0/wGyU/SNjaaw1n" }, { "type": "encryption", "pointer": "/~1/~0/kWHmY.nucS/~1/FJENCRo+/~0/~1/qNuybFO-D/~1" } ] }, "groups": [ "9b4ad8859f84adcb609e35b4", "4b39fe2eee611794399753c5", "549e22fee88eaa40dea56dfd", "40cd6682056e25b927f2c220" ], "type": "operation", "nodeLocation": { "x": 90632451.37693888, "y": -64346227.321427874 }, "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "error", "failure", "success" ], "autoRetry": true, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "e51f294d08b2626d40210344", "cc035c55d5d9e6de251ef0bc", "a54d9a5ba0e408f740aae49b", "8b38a7cf812bd70f578dc7b9" ], "canvasVersion": 3, "_id": "cbe2c897-40ae-a0a4-c440-4a6fe32596ae", "uuid": "4955a5c6-cc64-b3e5-57fb-deb16caef52b", "namespace": { "type": "project", "name": "incididunt cupidatat aliqua in deserunt", "accessControl": { "read": [ "pariatur consequat", "ex mollit in sint", "irure Duis", "enim eu officia labore", "commodo" ], "write": [ "dolor", "Ut proident aute esse voluptate" ], "execute": [ "consequat", "culpa" ], "manage": [ "fugiat" ] } }, "description": "Push Config to Device", "preAutomationTime": 5000, "sla": 93438916, "errorHandler": { "type": "deserunt sed exercitation", "name": "enim dolore" }, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "2e8dd555206d94a4c9f55cda", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "7243ca44667a314920165600", "lastUpdatedVersion": "4.69.69", "tags": [ "ullamco sint sunt" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/mxtSy/D6/~0" }, { "type": "encryption", "pointer": "/uTq/WkLAcLgOe6/~0/~0/sYgT/~1" } ], "migrationVersion": 62598882 } }
{ "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": "Port Turn Up IOS", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "1f4a8cda2b7681e4329d39e4" ], "nodeLocation": { "x": -784993.82038486, "y": -77747098.80199242 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "5b15983cb3b969739927ce8d", "753854bbd6a240cac80f39e6", "6c6b99f7222a70e9de5fd8ef", "14e9db8767d9044da67054ae", "5bf5b4a026979215c0bae7ec" ], "nodeLocation": { "x": -40179140.35730121, "y": -60310496.99805564 } }, "error_handler": { "name": "childJob", "summary": "in esse incididunt do anim", "description": "Duis incididunt", "app": "aliqua nisi commodo Lorem", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~1/xL/~0/~1/c-7imSUcaZH/kPHCwaw6/laGbgzMp,S/LQJO7/zFy" }, { "type": "encryption", "pointer": "/OL--MYXPog/~0/RaCn9/~0/~0/~1" } ] }, "groups": [ "027ce6d85a4d1565e30dc1a6", "aa03db386e7fb3a1bee88429", "426779c1a013f7f2ed6b1736" ], "type": "operation", "nodeLocation": { "x": 18918684.8264046, "y": 8366851.387767136 }, "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "success", "success" ], "autoRetry": true, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "b18fe49e1991593ed5a6cfec", "0ff6b287a6dff2981e155058" ], "canvasVersion": 3, "_id": "a980b619-c97c-bd7b-ad8f-1eb177bbb5d8", "uuid": "e59941b6-77ec-518e-f433-bc5b340d5d4f", "namespace": { "type": "project", "name": "do exercitation Ut consequat", "accessControl": { "read": [ "Ut in incididunt in", "nisi commodo proident" ], "write": [ "eu dolore Lorem deserunt laborum", "Lorem sed exercitation Ut ea", "reprehenderit officia occaecat", "sunt aute est ut et" ], "execute": [ "do est qui cillum sit", "sint est", "non ex qui dolor", "enim" ], "manage": [ "do", "dolore Ut cillum", "et ullamco", "pariatur dolor commodo ipsum est", "nulla officia reprehenderit culpa" ] } }, "description": null, "preAutomationTime": 250000, "sla": -66789455, "errorHandler": { "type": "nulla dolore ut tempor", "name": "ullamco in" }, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "60f40b812078e38ec74813c9", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "a791d095f853f118965d50b8", "lastUpdatedVersion": "4.69.69", "tags": [ "nulla fugiat mollit officia tempor" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~1/yIG,HIby/P794q.HleVH/~0/~1/~1/~0/~0" }, { "type": "encryption", "pointer": "/t/~0/vcm/~1/hBfD/~1/~0/~0/~1/gCjCrksK3/a" }, { "type": "encryption", "pointer": "/daQhQn2qR/~1/~1/~1" }, { "type": "encryption", "pointer": "/vlc9gzUVxHa/~0/~0/H" } ], "migrationVersion": 45049761 }, "edit": "officia" }
{ "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" ] }