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": "581007c6b6b9497496673b7c",
"gbac": {
"write": [
"6ed4161911a74bffaf4cc476",
"40f9bed411ca9db549a5162f"
],
"read": [
"3db0fb54f29600b1d360113a"
]
},
"nextRunAt": null,
"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": "7cddbe20422d32b6228fcc24",
"name": "test",
"data": {
"gbac": {
"write": [
"c7b4dafef8cf05d3ef1d95ac",
"a970edd832f2377ca1f71afd",
"2b21efeca82b795072925876",
"fb988516d7d4ad56380434a2"
],
"read": [
"53cf07af0b43fa7403f140d1",
"0375488080ef8679072e491b",
"38c3839ce955833ddc9fb7b4",
"2553c4174ec9a4254052eab6"
]
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"description": "irure",
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "28e8ee2bdacd505d948ccff6"
},
"lastModifiedBy": "laborum",
"lastRunAt": "2019-11-25T22:51:39.201Z",
"nextRunAt": "2019-11-25T22:51:39.201Z",
"repeatInterval": "1 hour",
"migratedToOM": true,
"correspondingOMAutomationId": "d4261b9cea259c2a7eb61c44"
}