Summary
Updates non-scheduling data for an automation
Description
Updates custom data for an automation. For scheduling data please use updateAutomationSchedule
Route
PUT /automation_catalog/automations/:id
Roles
admin
other
readonly
apiread
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| id |
string |
yes |
Unique id of the automation |
| options |
object |
yes |
Object containing the fields to be updated |
Copied to Clipboard
{
"options": {
"gbac": {
"write": [
"e3d52c480a9a621a8d10902f",
"a11de831088a17b3fd5ae046",
"de98a87a1607aed4bb6bea4b",
"b96ad09100a4dccc36f4789c",
"19b5c4cdde1f0d1b9340841d"
],
"read": [
"80416f309c17b24fedd998b5",
"6410a4b60bfa37cf277ca0fd"
]
},
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "2db9958a19a62066df4aa4a0"
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"options": {
"title": "options",
"type": "object",
"description": "Custom data stored with an automation.",
"properties": {
"formData": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": true
},
"workflowId": {
"type": "string",
"examples": [
"8e3695fe-c5bf-4286-ae83-186b3fea1c1a"
],
"format": "uuid"
},
"formId": {
"$ref": "automationDocument#/definitions/ObjectId"
},
"gbac": {
"type": "object",
"description": "Sets of group Ids that are allowed to access this automation.",
"properties": {
"write": {
"type": "array",
"description": "Group ids that have write access to the automation document.",
"items": {
"$ref": "automationDocument#/definitions/ObjectId"
}
},
"read": {
"type": "array",
"description": "Group ids that have read access to the automation document.",
"items": {
"$ref": "automationDocument#/definitions/ObjectId"
}
}
},
"required": [
"write",
"read"
]
}
},
"required": [
"gbac"
]
}
},
"required": [
"options"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| document |
object |
Updated document of requested automation |
Copied to Clipboard
{
"_id": "de9596aca3a3977736d6957b",
"name": "test",
"data": {
"gbac": {
"write": [
"eebbb526a294b40e9b6e3edc",
"bc25b0042569bdc741e628a8"
],
"read": [
"a8beb7ecbe8a0d9f2d6403ed",
"153b66dbab0f27c4e71dc3eb",
"b7839cda11ae3b42feca8e0a"
]
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"description": "consectetur commodo do reprehenderit sunt",
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "5cc3bb74d41fab38b2361726"
},
"lastModifiedBy": "pariatur ullamco fugiat quis laboris",
"lastRunAt": "2019-11-25T22:51:39.201Z",
"nextRunAt": "2019-11-25T22:51:39.201Z",
"repeatInterval": "3 weeks"
}
