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": [ "8b2e069cd8a9873c5e402540", "237b626ddb2bf7b3dbfe3d36", "f2c76b61eca7295c518b5634", "9f7ab1f02918d7a5e753a3be", "300e037f604a2e519a690ac3" ], "nodeLocation": { "x": -40338599.32812822, "y": 96624605.00047079 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "d9fc1fa969e4120c832a5d07", "04beddfe541dbcf6a29221a1", "de03f431ba9d9632223ecd3b", "4f1a15b0bbb8711adf1097a8" ], "nodeLocation": { "x": 26523473.295574546, "y": 73649504.54066098 } }, "error_handler": { "name": "childJob", "summary": "esse voluptate fugiat pariatur", "description": "in culpa magna", "app": "qui", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/Ue5smK6ynY/vV7fLBkY" }, { "type": "encryption", "pointer": "/~1/~1/Bff,/CER,/~1/~1/~1/~0/~0" } ] }, "groups": [ "0d0606c90d1ae10c9e505016", "5822d8747677bc231ec847f1", "0129309d1daf94d3959c6c91", "4747d8b930ee73604ea313bf" ], "type": "operation", "nodeLocation": { "x": 67406792.43514633, "y": 62347734.56908032 }, "deprecated": false, "scheduled": false, "retrySettings": null } }, "transitions": {}, "groups": [ "7890fcd02c93c3a42f21011f", "60b97342895695084ad379ec", "d956913cf5bb5242062bff1e" ], "canvasVersion": 3, "_id": "d0e6d7eb-7553-4e90-3b9e-27e05cf921c9", "uuid": "ac32a3d5-f84d-b80c-c764-d8f21883597b", "namespace": { "type": "project", "name": "sint proident in occaecat", "accessControl": { "read": [ "minim et aliqua veniam sed", "laborum Ut" ], "write": [ "nostrud eiusmod ad id", "anim ex do quis proident" ], "execute": [ "tempor in laborum enim deserunt", "laborum aliquip anim aliqua deserunt", "tempor aliquip Lorem culpa cillum", "dolore non" ], "manage": [ "ullamco elit Excepteur", "laborum" ] } }, "description": null, "preAutomationTime": 5000, "sla": 20545677, "errorHandler": { "type": "dolor est id", "name": "cillum in" }, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "bd112e11d7809eb6cfb3a9e2", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "daeab93c87ef78a809d1dc5e", "lastUpdatedVersion": "4.69.69", "tags": [ "irure aute nulla aliqua anim" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/Wi4PCv/rI1lCIqAdI/V/~0/ky-k/ZvN" }, { "type": "encryption", "pointer": "/DQi/~0/~1/~1/JHcaO/~1/~0/z/~1/~1" }, { "type": "encryption", "pointer": "/uJZ,QZ7po3/m/FiE7AjBNYNj/b/o/~0/~0/c/cwF-aCG/u8,P" }, { "type": "encryption", "pointer": "/YDvaQ2pRsT/~1/~0/~1/Ic" }, { "type": "encryption", "pointer": "/~1/~0/XeVsa2/cNGu" } ], "migrationVersion": 80622185 } }
{ "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": [ "9a48c2b57c90a1a006e8412f", "9aeefcbe0f949a7651955941", "b1de26c3a888e1539d1aea5c", "7626a235b84c21bb6f673b07" ], "nodeLocation": { "x": 73865987.62889504, "y": 66694508.50663793 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "fc219f4e989860ddac0f978e", "5ae68a97523a3defd2dd5fee", "7dbf165afd0d582c42cfe0b1" ], "nodeLocation": { "x": 74134243.28919688, "y": -39522654.46551326 } }, "error_handler": { "name": "childJob", "summary": "eiusmod Lorem anim ad mollit", "description": "Ut amet in", "app": "sint proident", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~0/f9/SSDa/~1/b./k45rXapd2o/Px" } ] }, "groups": [ "bc05212f8563e2ac809c9ffd", "2842b99da4aa0261fa93f290", "57f5637651a5412a3e5edce1", "e5e8d13ff37981aba7a57a53" ], "type": "operation", "nodeLocation": { "x": 39287924.81841561, "y": 22041469.873805404 }, "deprecated": false, "scheduled": false, "retrySettings": null } }, "transitions": {}, "groups": [ "6d69a1957532c5d20255e8e9", "55e758a73971e70a83391ee3", "2d4b83456696623499f769ae" ], "canvasVersion": 3, "_id": "3704ec76-7432-d833-5a67-42272c1181ee", "uuid": "eccceb02-19b6-a9c2-c4d5-befda14b5ae1", "namespace": { "type": "project", "name": "dolore", "accessControl": { "read": [ "exercitation laboris dolor in ut" ], "write": [ "Lorem", "Ut", "Lorem" ], "execute": [ "nulla adipisicing elit aute", "cupidatat est amet occaecat", "Duis nostrud adipisicing sint sunt" ], "manage": [ "magna", "consectetur nulla Ut laboris amet", "ipsum", "Duis ut mollit consectetur", "id nostrud in ipsum dolor" ] } }, "description": "Port Turn Up IOS", "preAutomationTime": 5000, "sla": -72574351, "errorHandler": null, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": "7bbe8e7eb768902a8c95ab1b", "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": "c1cc53c933777a11048397a7", "lastUpdatedVersion": "4.69.69", "tags": [ "laboris elit ea", "laborum", "non ea elit quis dolore", "sed", "dolor non ea" ], "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/~0/~1/~0/W9A.tuw7/~0" }, { "type": "encryption", "pointer": "/gZhM/~0/Sn0vzqW/CF-SPvot6n+" }, { "type": "encryption", "pointer": "/B-MQ/V/~1/~0/~0/naxx/bb,QHjk271F/~1" } ], "migrationVersion": 62420676 }, "edit": "ullamco labore amet" }
{ "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" ] }