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": "b8f7eb5c1da5c552ed1b13b7",
"gbac": {
"write": [
"ea5d57209d279803381667df",
"71cd75137c594a0d70a7054c",
"13d89f8afa692750c8d34fac",
"c597f7b34b6d039a00fb3fd3",
"80d61dd6e200ff98fec1fbeb"
],
"read": [
"da15a3802204087761f57990"
]
},
"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": "3a1e5f7e1f1200d28b9dbdc7",
"name": "test",
"data": {
"gbac": {
"write": [
"59fb1ae5d1e52416ea443621",
"58a834968032de843a606231"
],
"read": [
"0e0aa69b0ecbe861c4f826ad"
]
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"description": "aliqua aute cillum non",
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "a26ccdfa169e522fc6445135"
},
"lastModifiedBy": "non voluptate",
"lastRunAt": "2019-11-25T22:51:39.201Z",
"nextRunAt": "2019-11-25T22:51:39.201Z",
"repeatInterval": "1 hour",
"migratedToOM": false,
"correspondingOMAutomationId": "3e146fb6df0876b71aaec87e"
}