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": "Command Template Runner", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "ad597b55f424b3617ae0f380", "14aafd60dd636e5fe63f2b9e", "a87fabe7b494d02b813f160d", "774567544399300710bb3b97" ], "nodeLocation": { "x": 54573235.497753054, "y": 66140747.88585186 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "4bae7d798f69fdd11b37a378", "b13b7c6ee50dc5f3e5a93994" ], "nodeLocation": { "x": -19239494.792905852, "y": -60206813.98229599 } }, "error_handler": { "name": "childJob", "summary": "non incididunt in", "description": "aute velit", "app": "exercitation quis id", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/F1/97NfPsT/~1/MI/~1/K2." }, { "type": "encryption", "pointer": "/yx7/eF3/O7lBFwSc/HPTjvbp/~1/tNqrQsL8rCf/~1/X/Uab7fYy/a,jIoeTVXI" }, { "type": "encryption", "pointer": "/Lsjg,Q/~1/~0" }, { "type": "encryption", "pointer": "/~0/~1/M/c57Yx,Gi/wwuImk1NgDP/YsrU/gINKZvhjIO/Qst/~0" } ] }, "groups": [ "12ab7bc53109fe13dc4b0b87", "f1783bdb144b31da5eb6a994", "a618a16e40da0c2e4429437c", "bd3196dde40345ca80bedf18" ], "type": "operation", "nodeLocation": { "x": -98999853.43398376, "y": 84063414.89537942 }, "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "error", "success", "failure", "error" ], "autoRetry": true, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "45af094859d612613f7732e6", "9eea16502058650dbecea750", "dfe250bf32ad3207d29355eb", "e97528f402d8ad823d5b0a76", "80f86044c3545097a1f0260c" ], "canvasVersion": 3, "_id": "4b7ec944-5885-539a-c88e-4a098d326a12", "uuid": "0e417a9a-1a79-7033-ab49-58d72205ab9b", "namespace": { "type": "project", "name": "tempor Duis laborum", "accessControl": { "read": [ "occaecat", "enim deserunt et", "quis in" ], "write": [ "mollit", "mollit ut nulla ad" ], "execute": [ "mollit Duis ex voluptate", "eiusmod minim dolore dolore", "minim esse occaecat aute", "sint nulla", "Excepteur aute ad velit" ], "manage": [ "laboris ex culpa Lorem", "aute minim", "eiusmod incididunt", "aliquip et", "sed sunt qui cupidatat" ] } }, "description": "Push Config to Device", "preAutomationTime": 5000, "sla": -23280462, "errorHandler": null, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "ed5223bc7a9fd210a68af858", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "af768bf8577f57b2f30090a8", "lastUpdatedVersion": "4.69.69", "tags": [ "nulla", "anim", "tempor dolore dolor amet nisi", "non reprehenderit" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/hZILqzivx" }, { "type": "encryption", "pointer": "/DQrn0/~0/~0" } ], "migrationVersion": 78756097 } }
{ "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": [ "61738584fe4ca837adb6a48e", "59db8b6530fede85433c6dc4", "bc5c83117ee48adac1f135d7" ], "nodeLocation": { "x": 35949364.873524696, "y": -22147587.877311677 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "dc78a6e328372d88b309a017", "6a575bf2256e5f3af98f9823" ], "nodeLocation": { "x": -16033139.71702817, "y": -16472070.608602077 } }, "error_handler": { "name": "childJob", "summary": "eiusmod mollit in", "description": "est laboris", "app": "id aute adipisicing dolore magna", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~0" }, { "type": "encryption", "pointer": "/~1/i/eXofy,sYZX/~1/sq3cO" } ] }, "groups": [ "81872ab4a5c6578e7fe9c29a", "3645d32a1e54a5abecfa2c62", "27d1141caab8762c9cee36f3", "2632d3f02ec140271868b105" ], "type": "operation", "nodeLocation": { "x": -38580844.59136375, "y": -44994841.829056665 }, "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "error" ], "autoRetry": true, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "804fd34289245d34937debbe", "0d62b01e94bb77b5a37ed374", "8759164b7d32c1d670694a92" ], "canvasVersion": 3, "_id": "0b10724f-205d-3576-5dd2-66320200dcfd", "uuid": "f8cde600-8bf4-f92e-1e3a-a9cf47d7fc79", "namespace": { "type": "project", "name": "elit voluptate nostrud ea aliquip", "accessControl": { "read": [ "nostrud incididunt Excepteur", "non", "in dolore esse laborum", "laborum dolore est ipsum" ], "write": [ "sint Ut laborum", "aute veniam", "dolore minim" ], "execute": [ "quis et veniam ullamco sint", "officia ea et", "minim voluptate cupidatat", "dolore fugiat", "exercitation Duis adipisicing" ], "manage": [ "sunt", "enim esse adipisicing", "pariatur deserunt", "do" ] } }, "description": "Push Config to Device", "preAutomationTime": 5000, "sla": -58007718, "errorHandler": null, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "cf84bf33748a389d94ca7f00", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "d2a1e0f8a37d4c5fcfe18d09", "lastUpdatedVersion": "4.69.69", "tags": [ "qui dolor ipsum" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/M8zCS/~1/YF,z/qe,/~0/~0/bobc" }, { "type": "encryption", "pointer": "/yWlEOG/fkACeQbc/~1/qlXi0TP/~1/~1/DUrCiCLl8q/NT/~1/~1" }, { "type": "encryption", "pointer": "/~1/~1/KN5aKor/fxtnX5khVt/~1/~1/s5Mo/IG3m6r,m/E8etO9jP/~1/lo6E" } ], "migrationVersion": 59579171 }, "edit": "aute pariatur velit" }
{ "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" ] }