{ "$id": "automationDocument", "title": "Automation Document", "description": "An automation document based off the agendajs schema (http://agendajs.com) with all custom data residing in the 'data' property.", "type": "object", "definitions": { "ObjectId": { "type": "string", "pattern": "^[0-9a-f]{24}$", "description": "Unique identifier of the automation" }, "runWorkflowData": { "type": "object", "title": "options", "description": "Optional data when running an automation outside of a schedule (manually running an automation).", "properties": { "description": { "type": "string", "description": "Short description of the individual run of this automation. This data will be displayed in Job Manager." } } } }, "properties": { "_id": { "$ref": "#/definitions/ObjectId" }, "name": { "type": "string", "examples": [ "test" ], "minLength": 1 }, "data": { "type": "object", "properties": { "lastUpdated": { "type": "string", "examples": [ "2019-11-25T22:51:39.201Z" ], "format": "date-time" }, "formData": { "type": "object", "properties": {}, "required": [], "additionalProperties": true }, "description": { "type": "string" }, "workflowId": { "type": "string", "examples": [ "8e3695fe-c5bf-4286-ae83-186b3fea1c1a" ], "format": "uuid" }, "formId": { "$ref": "#/definitions/ObjectId" }, "gbac": { "type": "object", "description": "Object containing lists of unique levels of group based access. By default these lists are empty.", "properties": { "write": { "type": "array", "description": "An array of group ids that have write access to the document.", "items": { "$ref": "#/definitions/ObjectId" } }, "read": { "type": "array", "description": "An array of group ids that have read access to the document.", "items": { "$ref": "#/definitions/ObjectId" } } }, "required": [ "write", "read" ], "additionalProperties": false } }, "required": [ "gbac" ], "additionalProperties": false }, "lastModifiedBy": { "type": "string" }, "lastRunAt": { "type": "string", "examples": [ "2019-11-25T22:51:39.201Z" ], "format": "date-time", "description": "Agenda property defining when the last known run was process, stored in UTC. This does not include manually ran automations." }, "nextRunAt": { "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." }, "repeatInterval": { "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" ] }, "migratedToOM": { "type": "boolean", "description": "Property defining whether the automation has been migrated to app-operations_manager" }, "correspondingOMAutomationId": { "$ref": "#/definitions/ObjectId" } }, "required": [ "_id", "name", "data" ], "additionalProperties": false }
2022.1