schedule-schema

Copied to Clipboard

{ "$id": "schedule-schema", "title": "Schedule Triggers Schema", "description": "Schema for a Schedule Trigger", "allOf": [ { "$ref": "triggers-common-schema#/definitions/commonFields" }, { "$ref": "#/definitions/standardProperties" }, { "properties": { "locked": { "description": "backend use only", "type": "boolean" }, "formId": { "oneOf": [ { "$ref": "common-ops-schema#/definitions/ObjectId" }, { "type": "null" } ] } } } ], "required": [ "name", "type", "enabled", "actionType", "actionId", "firstRunAt", "processMissedRuns" ], "propertyNames": { "anyOf": [ { "$ref": "triggers-common-schema#/definitions/commonFieldNames" }, { "enum": [ "formId", "formData", "firstRunAt", "lastExecuted", "nextRunAt", "processMissedRuns", "locked", "repeat", "removeOnEnd" ] } ] }, "definitions": { "export": { "allOf": [ { "$ref": "triggers-common-schema#/definitions/commonFieldsExport" }, { "$ref": "#/definitions/standardProperties" }, { "properties": { "formId": { "type": [ "string", "null" ] } } } ], "propertyNames": { "anyOf": [ { "$ref": "triggers-common-schema#/definitions/commonFieldNames" }, { "enum": [ "formId", "formData", "firstRunAt", "lastExecuted", "nextRunAt", "processMissedRuns", "repeat", "removeOnEnd" ] } ] } }, "dimensionedQuantitySeconds": { "type": "object", "properties": { "unit": { "const": "second" }, "quantity": { "type": "number", "minimum": 0, "multipleOf": 10 } } }, "dimensionedQuantityOther": { "type": "object", "properties": { "unit": { "enum": [ "minute", "hour", "day", "week" ] }, "quantity": { "type": "number", "minimum": 0 } } }, "implicitMsQuantity": { "$comment": "Implicit unit of milliseconds", "type": "number", "minimum": 0, "multipleOf": 10000 }, "intervalDuration": { "oneOf": [ { "$ref": "#/definitions/dimensionedQuantitySeconds" }, { "$ref": "#/definitions/dimensionedQuantityOther" }, { "$ref": "#/definitions/implicitMsQuantity" } ] }, "intervalAction": { "type": "object", "properties": { "action": { "enum": [ "execute", "wait" ] } }, "required": [ "action" ] }, "intervalComponents": { "type": "object", "properties": { "components": { "type": "array", "items": { "$ref": "#/definitions/anyInterval" } } }, "required": [ "components" ] }, "anyIntervalDirective": { "oneOf": [ { "$ref": "#/definitions/intervalAction" }, { "$ref": "#/definitions/intervalComponents" } ] }, "standardInterval": { "allOf": [ { "type": "object", "properties": { "type": { "enum": [ "repeating", "terminating" ] }, "duration": { "$ref": "#/definitions/intervalDuration" } } }, { "$ref": "#/definitions/anyIntervalDirective" } ] }, "countShorthandInterval": { "allOf": [ { "type": "object", "properties": { "type": { "const": "count" }, "duration": { "$ref": "#/definitions/intervalDuration" }, "count": { "type": "integer", "minimum": 0 } } }, { "$ref": "#/definitions/anyIntervalDirective" } ] }, "dateRangeShorthandInterval": { "allOf": [ { "type": "object", "properties": { "type": { "const": "date-range" }, "start": { "$ref": "common-ops-schema#/definitions/ISODate" }, "end": { "$ref": "common-ops-schema#/definitions/ISODate" } } }, { "$ref": "#/definitions/intervalComponents" } ] }, "anyInterval": { "oneOf": [ { "$ref": "#/definitions/standardInterval" }, { "$ref": "#/definitions/dateRangeShorthandInterval" }, { "$ref": "#/definitions/countShorthandInterval" } ] }, "standardProperties": { "type": "object", "properties": { "_id": { "$ref": "common-ops-schema#/definitions/ObjectId" }, "created": { "$ref": "common-ops-schema#/definitions/ISODate" }, "createdBy": { "$ref": "common-ops-schema#/definitions/userAccount" }, "lastUpdated": { "$ref": "common-ops-schema#/definitions/ISODate" }, "lastUpdatedBy": { "$ref": "common-ops-schema#/definitions/userAccount" }, "name": { "$ref": "common-ops-schema#/definitions/name" }, "type": { "const": "schedule" }, "enabled": { "$ref": "common-ops-schema#/definitions/enabled" }, "actionType": { "$ref": "common-ops-schema#/definitions/actionType" }, "actionId": { "$ref": "common-ops-schema#/definitions/ObjectId" }, "formId": { "oneOf": [ { "$ref": "common-ops-schema#/definitions/ObjectId" }, { "type": "null" } ] }, "formData": { "oneOf": [ { "type": "object" }, { "type": "null" } ] }, "firstRunAt": { "description": "A timestamp in milliseconds for the first scheduled run of this job.", "type": "integer", "minimum": 0 }, "lastExecuted": { "description": "A timestamp in milliseconds of the time this job was last executed.", "oneOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "nextRunAt": { "description": "A timestamp in milliseconds for the next scheduled run of this job.", "oneOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "stopRunningAt": { "description": "A millisecond resolution timestamp denoting when to stop this schedule. This is calculated using repeatEnd and lastIntervalStart.", "oneOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "lastIntervalStart": { "description": "A millisecond resolution timestamp denoting when the current run interval started. This is calculated using repeatEnd.", "oneOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "processMissedRuns": { "description": "Describes how any missed job runs should be processed. A missed run is a job that was supposed to be ran at least 'n' seconds ago, but did not due to some issue with IAP (busy process, IAP was down, etc). 'none' means do not run any missed jobs. 'last' means only run the last missed job.", "type": "string", "enum": [ "none", "last" ] }, "repeat": { "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/anyInterval" } ] }, "removeOnEnd": { "type": [ "null", "boolean" ] } } } } }