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": "Push Config to Device", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "04c8b35dfa7b718e5468f86b", "b8a45161eb0d461e36d6205a", "ac2ee00ffea8d4ebfa145a43", "199f796ed4dafc6140d4001a" ], "nodeLocation": { "x": 42565777.80885857, "y": -8391726.472604737 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "35b2f1499f83bd09e8dac677", "9e361faaf27f4208506e6d54" ], "nodeLocation": { "x": 67950937.2441391, "y": -25827287.044070736 } }, "error_handler": { "name": "childJob", "summary": "cupidatat nostrud eiusmod id ea", "description": "et id ut magna", "app": "Ut elit", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/FR0k/~1/~1/~1/~1/yqE5OvQ/s" }, { "type": "encryption", "pointer": "/~0/WOHVp3x/Vu" }, { "type": "encryption", "pointer": "/~1/R22X,V/W3Fb8RJ/es/n0r4Xilx2" }, { "type": "encryption", "pointer": "/yv/~1/~1/~1/~0" } ] }, "groups": [ "7f012a23c9ce5919a55da52f" ], "type": "operation", "nodeLocation": { "x": 53364621.691459805, "y": 645437.5145938098 }, "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "error", "failure", "error", "success" ], "autoRetry": false, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "f0a33942cd3b6a2240809646", "ea9e1980cccaeffeffbb89c0", "f3f9e133164f44c432137687" ], "canvasVersion": 3, "_id": "cdc98469-2331-f82a-3564-e3c9cfa6055b", "uuid": "f937b7f7-7748-af83-ab6d-3e9b1c374331", "namespace": { "type": "project", "name": "sunt", "accessControl": { "read": [ "ea", "est sunt anim", "nulla reprehenderit et velit", "sint mollit in", "pariatur et do" ], "write": [ "occaecat amet magna aliquip est", "mollit esse sit", "nisi Excepteur sit", "sint veniam culpa", "dolor veniam laboris qui" ], "execute": [ "reprehenderit non nisi in", "occaecat ut dolore aute", "deserunt esse Duis eiusmod in", "elit veniam qui" ], "manage": [ "id proident laboris et", "mollit do enim", "sint" ] } }, "description": "Port Turn Up IOS", "preAutomationTime": 250000, "sla": 84068595, "errorHandler": null, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "21382c4227a193b82f45c612", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "d658a3b32f090cdcce599623", "lastUpdatedVersion": "4.69.69", "tags": [ "aliqua Duis", "magna reprehenderit", "proident adipisicing" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/mNxlo85A+5o/~1/Xj6WFCHDrD/wJvHp1vy4/eCHvNs/~0" }, { "type": "encryption", "pointer": "/~1/~1/In0MWR/p6/~0/~1/x6Y1ll5l8pL/pBK+X7" }, { "type": "encryption", "pointer": "/nH+CY" }, { "type": "encryption", "pointer": "/uVMQ/~1/R/~1/~1/myJ2W1/~1/F1G,Km5Ukt/~1/~1/~1" } ], "migrationVersion": 71974965 } }
{ "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": [ "f216d74a555dcfefe2ecc37b", "31a8662b434085e69eaf6df7", "9790f60d3c41a2a9c8ddb839" ], "nodeLocation": { "x": 53002250.39566207, "y": 46875840.03364286 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "1fe5cf62ed74298245d73303", "9b4d2b3a17a10dfe8832db30", "32e5ab8c40382dccd0074213", "c2543abaacb581ad07653c14" ], "nodeLocation": { "x": 88727174.59602618, "y": -86938798.48198093 } }, "error_handler": { "name": "childJob", "summary": "aliqua eiusmod do", "description": "ullamco ex est culpa dolor", "app": "sed", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/AFNk08LPJ/~0/IH-.D//~0/~1" }, { "type": "encryption", "pointer": "/zOP1f9eh2/~0/~1/~1/F2/m0j/~0/jtTKxG3w/~0" } ] }, "groups": [ "2ccac19cdef61b917d51a8cb", "f2c042397917aa41d8c51a6b", "90af9daa44aeac013cfe7cd0", "b8ae21107cb7a7c38c4d1301", "a256136e89a676710cb7577a" ], "type": "operation", "nodeLocation": { "x": -58305296.22432481, "y": 48110703.738681644 }, "deprecated": true, "scheduled": false, "retrySettings": null } }, "transitions": {}, "groups": [ "1a9d1dd7c77a5128c822eede", "fe1bf8a8b9719b541662f510", "9abe0f5165a2d66add07cea0" ], "canvasVersion": 3, "_id": "d24ed268-da24-4a3a-212b-fc19500683a0", "uuid": "7e7fb6f2-718b-b574-68b5-efe2fecb499a", "namespace": { "type": "project", "name": "mollit in", "accessControl": { "read": [ "eu cupidatat adipisicing ut est", "nisi", "adipisicing occaecat eiusmod in et", "do magna" ], "write": [ "qui sit ipsum Excepteur labore", "sint ullamco", "dolore Duis adipisicing consequat qui", "laboris minim in" ], "execute": [ "adipisicing consequat", "ea deserunt", "qui elit voluptate consectetur" ], "manage": [ "sint" ] } }, "description": "Port Turn Up IOS", "preAutomationTime": 5000, "sla": -80857271, "errorHandler": null, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "8fa4650adf5484fc0700a54f", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "c819add8d523f125dde62bec", "lastUpdatedVersion": "4.69.69", "tags": [ "irure dolore mollit aliqua eu", "deserunt eu laboris quis et", "culpa", "exercitation dolor quis", "et in" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/aU/GA/~1/~0/~0/w14AaQ" }, { "type": "encryption", "pointer": "/Qn4nkj.2guA/~0" }, { "type": "encryption", "pointer": "/~1/~1/~0/~1/~1/~0" }, { "type": "encryption", "pointer": "/~1/~1/Tr1qyjFA/~1/~0" }, { "type": "encryption", "pointer": "/F/L,ytgJN/~1/~1/JttXRi/~1/VcgUPvAW/GTCyeyZr/nv1" } ], "migrationVersion": 51081837 }, "edit": "officia occaecat ullamco nisi" }
{ "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" ] }