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
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": [
"fbdac2e0dd1253fdfc7193da",
"8f54ee2700d972fe3bb45fc1",
"bd5febf5a265a70a3ce63380",
"7c4c396c44026f3adc49894b"
],
"read": [
"896a26a7ae98d7404fe880b7",
"f9ee703d67d161f7ae0574f9",
"834071a1fa8de5773f1b94d8"
]
},
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "70efa7a850518fb935dc787b"
}
}
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": "b069ab093cbf984a151fa414",
"name": "test",
"data": {
"gbac": {
"write": [
"7b62531d5d41d9cdd06984e6",
"a48b585683f5b993f11893fc",
"a528ffbffa61cd8665d090c5"
],
"read": [
"8b413108a959e9441e0697dd",
"9bed7f26635ac57acd6234fc",
"d8c78e2fe7a5749f8c308f5e"
]
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"description": "nulla ut in",
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "3ef9b3b14ef986c3b0e6bc8f"
},
"lastModifiedBy": "velit pariatur aute",
"lastRunAt": "2019-11-25T22:51:39.201Z",
"nextRunAt": "2019-11-25T22:51:39.201Z",
"repeatInterval": "3 weeks"
}
