schedule-trigger-api

Copied to Clipboard

{ "$id": "schedule-trigger-api", "title": "Schedule Triggers API Schema", "description": "Schema for a Schedule Trigger API representation", "type": "object", "required": [ "name", "type", "enabled", "actionType", "actionId", "firstRunAt", "processMissedRuns" ], "propertyNames": { "anyOf": [ { "$ref": "triggers-common-schema#/definitions/commonFieldNames" }, { "$ref": "triggers-api#/definitions/commonApiFieldNames" }, { "$ref": "schedule-trigger-common#/definitions/commonScheduleTriggerFieldNames" }, { "enum": [ "locked", "formId", "nextRunAt", "lastExecuted", "repeatInterval", "repeatUnit", "repeatFrequency" ] } ] }, "allOf": [ { "$ref": "triggers-common-schema#/definitions/commonFields" }, { "$ref": "triggers-api#/definitions/commonApiFields" }, { "$ref": "schedule-trigger-common#/definitions/commonScheduleTriggerFields" }, { "$ref": "schedule-trigger-common#/definitions/legacyCovariantProperties" }, { "$ref": "schedule-trigger-common#/definitions/legacyInvariantProperties" }, { "properties": { "locked": { "description": "backend use only", "type": "boolean" }, "formId": { "description": "The ID of a JSON Form used to provide inputs to a workflow from this trigger", "oneOf": [ { "$ref": "common-ops-schema#/definitions/ObjectId" }, { "type": "null" } ] }, "nextRunAt": { "description": "A timestamp in milliseconds for the next scheduled run of this job.", "oneOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "examples": [ 1648829216268, null ] }, "lastExecuted": { "description": "A timestamp in milliseconds of the time this job was last executed.", "oneOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] } } } ] }