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": [ "7d0ffc14f3e4f1694287fcae", "5954512972988c2f9fb12900", "d74677ac48fc2e888a8702fd", "f21ba61e001611452d3050ee", "fb764e3d194ff64687d41d06" ], "nodeLocation": { "x": -96464374.81742133, "y": -33011588.25004746 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "2099c3832f0e6cf2dbdef0da", "78782295ecea06d8e7b36f3c", "a73d9c9b0771d7b08e420c9f", "6fa89b99f866dce98487dcef" ], "nodeLocation": { "x": 2943202.280371085, "y": 12537133.281450212 } }, "error_handler": { "name": "childJob", "summary": "in", "description": "Ut quis", "app": "minim occaecat tempor sit", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~1/~1/bdD" }, { "type": "encryption", "pointer": "/O" } ] }, "groups": [ "3c6ea4f58ab8564d1ee207fe", "a6de9354f85d308678d582f5", "3cbc8b06a1c879116f63bb3a", "f3d601cce40fd7b6b4737c09" ], "type": "operation", "nodeLocation": { "x": 45547284.4717986, "y": 93738590.71767479 }, "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "error", "failure", "success", "success", "error" ], "autoRetry": true, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "a018bcd8c3a2c26dd3c292de", "0d742aea9ef6bf4163996422" ], "canvasVersion": 3, "_id": "11188de3-95e0-12d2-5c4b-beb6112f4809", "uuid": "f5f4e748-09d1-a933-af30-813726abc48d", "namespace": { "type": "project", "name": "minim voluptate adipisicing anim dolor", "accessControl": { "read": [ "enim sed", "commodo magna adipisicing in aliqua", "ipsum ad Ut", "occaecat ea reprehenderit", "incididunt sed" ], "write": [ "irure est fugiat Excepteur", "dolore et esse pariatur laboris", "exercitation fugiat", "voluptate", "laborum Duis cillum" ], "execute": [ "ut officia cupidatat anim", "mollit sint magna laborum id", "nisi quis officia anim", "esse", "et in ipsum" ], "manage": [ "est pariatur", "reprehenderit est incididunt cillum non", "amet aliqua Lorem sit" ] } }, "description": null, "preAutomationTime": 250000, "sla": -28458307, "errorHandler": null, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "ec9ca296fa4b24477c67ff88", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "40aeaff47c8f46dbe075396f", "lastUpdatedVersion": "4.69.69", "tags": [ "incididunt dolore", "laboris dolore", "sed", "cillum Ut" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/pMGtka4Wz" }, { "type": "encryption", "pointer": "/~1/~0/~1/XntPSLJXhFb/~0/nNLgQGk/~1/p/XcNm/~1" }, { "type": "encryption", "pointer": "/~1/~0/hF8IsQ6865/Q/duN+GAl/Yy/~0/~1" }, { "type": "encryption", "pointer": "/f2wqZPI4LjE/~1/nurMYpi9/~1/~1/~1/i/~1/qsXKuThU" } ], "migrationVersion": 80586104 } }
{ "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": [ "c2933437408e6f9b3ff8d49d", "79826296ba2900a8eed495b8" ], "nodeLocation": { "x": 37326559.028356075, "y": 28110564.146098718 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "359fffc7ff99f62e3cb2f8e8", "e6bd073278ec2c776e34acb1", "6045c15deb38abfa2829b7b6", "93d3af5475b68d6c916d3f9b" ], "nodeLocation": { "x": 96342425.3741084, "y": 99942303.70062304 } }, "error_handler": { "name": "childJob", "summary": "ipsum minim laboris dolore", "description": "minim est magna", "app": "officia est", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/QIKhY/~1/~0/w1M" }, { "type": "encryption", "pointer": "/IewHBiH1ZM1/xuYU/~0/~0/YLh-ikb8/FPR-PJsVZ/~1" }, { "type": "encryption", "pointer": "/pp2zj8I/p/~1/dYKPC0tn" } ] }, "groups": [ "02b43b784c6a769a1d63c10e" ], "type": "operation", "nodeLocation": { "x": -33953247.49513753, "y": -11958100.23712492 }, "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "error", "success", "failure", "failure" ], "autoRetry": true, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "5f7929b5ec68dc9a416a6a15", "d0ca978d8568f08e93de6c1a", "b56b5e708061215a95d20d08", "0e0b69048c25d3d506899e01", "2e6ec473730483eda385e43d" ], "canvasVersion": 3, "_id": "0fad6b13-63be-46dc-d1fb-c6d6a3b10c8c", "uuid": "479c36e6-7bbb-1911-001c-d37d4b167cf2", "namespace": { "type": "project", "name": "magna", "accessControl": { "read": [ "reprehenderit" ], "write": [ "dolore", "veniam Ut in", "ut magna amet in" ], "execute": [ "anim incididunt", "deserunt cupidatat esse eiusmod" ], "manage": [ "qui", "qui nisi in amet", "anim cupidatat", "ad velit ipsum" ] } }, "description": "Push Config to Device", "preAutomationTime": 5000, "sla": 51397787, "errorHandler": null, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "698ae3168d7518d3fcc0dce4", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "11cbb44c344f13b6a3069dcf", "lastUpdatedVersion": "4.69.69", "tags": [ "ullamco in sit deserunt", "aliquip anim veniam culpa", "eiusmod proident", "pariatur dolore sint", "exercitation veniam esse ex" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/sMLBjSeV/~0/SdtG,v0,R9P/~1/~1/~1/~1" } ], "migrationVersion": 62446041 }, "edit": "ex labore mollit enim" }
{ "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" ] }