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": "a0fdc759d136a816217d22a0",
"gbac": {
"write": [
"a56038f25a66fb1b35da64cd",
"4acb3011113b54859d3a2dd9",
"7e77ac848cd44595480d2683",
"03d3c3f88e2fd37049238d8f",
"cb289b6bd10cf0dc31c6a10b"
],
"read": [
"d644facd47f41ef31ccf030b",
"2a2d532be735cd04780c8bdc"
]
},
"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": "30f4689ea10b46f222577937",
"name": "test",
"data": {
"gbac": {
"write": [
"e419918107d9c4158001d2bf",
"2a4ddb0812f33a9a707a5888",
"4ff83c7fdb562e139db7e1df"
],
"read": [
"0d6885fec39cf01518434c6e",
"95c516e8e8450047d5ea0bb2",
"154b44c41e6669fa0ecff0c7"
]
},
"lastUpdated": "2019-11-25T22:51:39.201Z",
"description": "eiusmod Excepteur proident voluptate",
"workflowId": "8e3695fe-c5bf-4286-ae83-186b3fea1c1a",
"formId": "bbc45223ae943149408cb513"
},
"lastModifiedBy": "quis laborum",
"lastRunAt": "2019-11-25T22:51:39.201Z",
"nextRunAt": "2019-11-25T22:51:39.201Z",
"repeatInterval": "1 hour",
"migratedToOM": true,
"correspondingOMAutomationId": "8c59e2ca4c6173dcf5ea204c"
}