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": "de6207c3431c701bc4a88a72",
"gbac": {
"write": [
"4be417edf547e0ec0ce3e488",
"9c191d966a8f3fe54aa8a7e3",
"ce31a320956c14342738282b"
],
"read": [
"579e8939e152e907a26dc9b0",
"68bc1ed67df1a82b739035bb",
"7b97220bd36e62941f098b4a",
"a624c541c0737859b36c7c0b",
"4fc646274ea824d44d3905c5"
]
},
"nextRunAt": "2019-11-25T22:51:39.201Z",
"repeatInterval": null
}
}
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": "bb49526878d4964b067bf247",
"name": "test",
"data": {
"gbac": {
"write": [
"cb49f5d8e612f520fae8bd58",
"ae33b37c27aa9cc054259dc1",
"37a6426b3e9925daa7cd811a"
],
"read": [
"a487d686e15f97f44ad2da32",
"a152a494760226da525f92fd",
"e043008703bf6def6d8021cd",
"adb7c03316f8076214ed83b1",
"ab225148fe1ff0fc2045bf99"
]
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"description": "eu ut pariatur ea",
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "a9cfc82824b49da1a6df946a"
},
"lastModifiedBy": "laborum nostrud dolore",
"lastRunAt": "2019-11-25T22:51:39.201Z",
"nextRunAt": "2019-11-25T22:51:39.201Z",
"repeatInterval": "3 weeks"
}