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": [
"c6d75cfce3150d2b96a93e99",
"35ec7e55e62cabbca49b9e75"
],
"read": [
"b2a2a21e3e6c9e4391d9b922",
"e1bf778424792e7de5817655",
"6d7663540d817ffe8e90683f",
"266c1251781e21341255bb2d",
"1b226445358107ba91af1d86"
]
},
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "38a24a0ea60ba284b434ab5e"
}
}
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": "eca7c55e0b3f81482217d1a4",
"name": "test",
"data": {
"gbac": {
"write": [
"92137e313eb87ef7183f1057",
"0bac46aa492095eebe1c0296",
"24e0bf7c5703de625567eade"
],
"read": [
"260d65d448380a94e4c0ffa1",
"7317b8fa286d1dde1d2495ed",
"7613c49d41a201bd0dcae25a"
]
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"description": "amet in",
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "bf27d5a540d56d71b22ae599"
},
"lastModifiedBy": "exercitation ut",
"lastRunAt": "2019-11-25T22:51:39.201Z",
"nextRunAt": "2019-11-25T22:51:39.201Z",
"repeatInterval": "3 weeks"
}
