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": [
"013abd1dadf69b7bf88d9425",
"759a54a9afe93989137220c2",
"ed996619234ed288e3fb7962",
"8a4a9730564fdeb420e9fd0e",
"fd66b0bfba8f74765c14f654"
],
"read": [
"188c8b0a97e1a2d0f79c7722",
"0a6cdae025f83d1d2a7bbe07"
]
},
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "2fbdf2c33251234c66f7b325"
}
}
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": "ee52fa522a1b4880f9b53f16",
"name": "test",
"data": {
"gbac": {
"write": [
"00ddf8fc7eebcbd6a8b7b406",
"9d096289e9313e83f29a8dcf",
"2c31291dad408c87336313bc",
"6bb25b4cd6ee3bf67709cc8c",
"52eacdc82b118f0b38447dfc"
],
"read": [
"bb838a97c0ba6c21168e4a0b",
"43b3cabebcbd5cce4df73885",
"4003185551c55180e38c7efc",
"b4196d6e39ae0b1e7f5e32b3",
"be47bd78d072ebc7be53c1bc"
]
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"description": "tempor",
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "2dc16411248610104a90fd62"
},
"lastModifiedBy": "incididunt",
"lastRunAt": "2019-11-25T22:51:39.201Z",
"nextRunAt": "2019-11-25T22:51:39.201Z",
"repeatInterval": "2 months"
}
