app-automation_catalog Schemas

On this page:

exportedAutomation

{ "$id": "exportedAutomation", "title": "Exported Automation Document", "description": "An automation document based modified for importing and exporting.", "type": "object", "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 objects that have write access to the document (in exported format).", "items": { "type": "object", "properties": { "provenance": { "type": "string", "examples": [ "Local AAA" ] }, "name": { "type": "string", "examples": [ "my admin group" ] }, "description": { "type": "string", "examples": [ "My short description" ] } }, "required": [ "provenance", "name" ], "additionalProperties": false } }, "read": { "type": "array", "description": "Agenda property defining how often an automation will repeat. Stored in human interval time format (https://github.com/agenda/human-interval).", "items": { "type": "object", "description": "An array of group objects that have read access to the document (in exported format).", "properties": { "name": { "type": "string", "examples": [ "Itential Artifact" ] }, "provenance": { "type": "string", "examples": [ "Pronghorn" ] }, "description": { "type": "string", "examples": [ "My short description" ] } }, "required": [ "name", "provenance" ], "additionalProperties": false } } }, "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" ] } }, "required": [ "name", "data" ], "additionalProperties": false, "definitions": { "ObjectId": { "type": "string", "pattern": "^[0-9a-f]{24}$", "description": "Unique identifier of the automation" } } }