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": [
"fe9356b8d93dee8239e11bfd",
"776fa77fb5e987086c10903c",
"47daf64f00e74a23b2321c9e",
"819fbb2888c5baedf31afe5a"
],
"read": [
"f54f2d9e07870320af448b8d",
"222e41a106ec7321c4d99446",
"8e043c3167e40cfb385e9cd0"
]
},
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "0ee9b47de6c5e0c7eb1b7576"
}
}
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": "aa2275675d4f3e90296baae1",
"name": "test",
"data": {
"gbac": {
"write": [
"612f6ab9cc26b0d39d101aed",
"28e70361258f1acb3dc87c04",
"5110afa9fcf3d21362deb1e5"
],
"read": [
"50e03b258767da7f962cfd17",
"7d5733999ef204e7b0d3e8d9",
"00b43457e0d61e4f55d930b1",
"2b3a15408cac2cec6675dac2"
]
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"description": "reprehenderit minim ad fugiat",
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "c8d80b585a5deef3d695ebb0"
},
"lastModifiedBy": "pariatur anim",
"lastRunAt": "2019-11-25T22:51:39.201Z",
"nextRunAt": "2019-11-25T22:51:39.201Z",
"repeatInterval": "1 day"
}
