Summary
Updates an automation's attributes.
Description
Updates an automation's attributes (including scheduling data).
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": {
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "cd82ea4ab2e7c4b073d4797d",
"gbac": {
"write": [
"7fded3752edef41b4b0bc760",
"62a138c8ab8fe434d6169989",
"c66d2117f5a8eaaa0bc86258",
"3612eb0955aeaff8b605ccdd"
],
"read": [
"b46c33be76f1a4e3bb08be7c",
"845d5c5c62fdfeb1dc04a384",
"a834730e669c322d73fa82c3"
]
},
"nextRunAt": "2019-11-25T22:51:39.201Z",
"repeatInterval": "1 hour"
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"options": {
"title": "options",
"type": "object",
"description": "Custom data stored with an automation.",
"properties": {
"formData": {
"type": "object",
"properties": {},
"description": "An object containing a list of properties from the associated json-form, saved formData is only used when scheduling."
},
"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"
]
},
"nextRunAt": {
"oneOf": [
{
"type": "string",
"examples": [
"2019-11-25T22:51:39.201Z"
],
"format": "date-time",
"description": "Agenda property defining when the next run will process, stored in UTC."
},
{
"type": "null"
}
]
},
"repeatInterval": {
"oneOf": [
{
"type": "string",
"minLength": 1,
"description": "Agenda property defining how often an automation will repeat. Stored in human interval time format (https://github.com/agenda/human-interval).",
"examples": [
"1 hour",
"1 day",
"3 weeks",
"2 months"
]
},
{
"type": "null"
}
]
}
}
}
},
"required": [
"options"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
document |
object |
Updated document of requested automation |
Copied to Clipboard
{
"_id": "d3d860156ed0c4251c170662",
"name": "test",
"data": {
"gbac": {
"write": [
"418b405661caf430cc528e6f",
"176c605d1d6529265e25c28a"
],
"read": [
"4ebb984be7c703107f0445b2",
"95839f937f90f08a7d878a1e",
"64c2bf2676f951ac5e331ecd",
"540f4c9041f43ad9db07b126"
]
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"description": "in nostrud dolor",
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "b214e4ca5f5a813d0c8d62eb"
},
"lastModifiedBy": "do est",
"lastRunAt": "2019-11-25T22:51:39.201Z",
"nextRunAt": "2019-11-25T22:51:39.201Z",
"repeatInterval": "1 hour",
"migratedToOM": true,
"correspondingOMAutomationId": "d0db1fb6fff92180aaa1d2a8"
}