importTriggers

{ "triggers": [ { "$id": "eventSystem-trigger-common", "title": "EventSystem Triggers Schema Common Definitions", "description": "Common elements in the schema for a EventSystem Trigger", "definitions": { "commonEventSystemTriggerFieldNames": { "enum": [ "lastExecuted", "source", "topic", "schema", "jst" ] }, "commonEventSystemTriggerFields": { "type": "object", "properties": { "type": { "const": "eventSystem" }, "lastExecuted": { "description": "A timestamp in milliseconds of the time this job was last executed.", "oneOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "source": { "type": "string" }, "topic": { "type": "string" }, "schema": { "oneOf": [ { "$ref": "http://json-schema.org/draft-07/schema#" }, { "type": "null" } ] }, "jst": { "oneOf": [ { "title": "MongoDB ObjectID", "description": "String representation of a MongoDB ObjectId", "examples": [ "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c" ], "oneOf": [ { "type": "object" }, { "type": "string", "pattern": "^[0-9a-f]{24}$" } ] }, { "type": "null" } ] } } } } }, { "$id": "eventSystem-trigger-common", "title": "EventSystem Triggers Schema Common Definitions", "description": "Common elements in the schema for a EventSystem Trigger", "definitions": { "commonEventSystemTriggerFieldNames": { "enum": [ "lastExecuted", "source", "topic", "schema", "jst" ] }, "commonEventSystemTriggerFields": { "type": "object", "properties": { "type": { "const": "eventSystem" }, "lastExecuted": { "description": "A timestamp in milliseconds of the time this job was last executed.", "oneOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "source": { "type": "string" }, "topic": { "type": "string" }, "schema": { "oneOf": [ { "$ref": "http://json-schema.org/draft-07/schema#" }, { "type": "null" } ] }, "jst": { "oneOf": [ { "title": "MongoDB ObjectID", "description": "String representation of a MongoDB ObjectId", "examples": [ "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c" ], "oneOf": [ { "type": "object" }, { "type": "string", "pattern": "^[0-9a-f]{24}$" } ] }, { "type": "null" } ] } } } } }, { "title": "Manual Triggers Schema Common Definitions", "description": "Common elements in the schema for a Manual Trigger", "definitions": { "commonManualTriggerFieldNames": { "enum": [ "formData", "formSchemaHash", "lastExecuted" ] }, "commonManualTriggerFields": { "type": "object", "properties": { "type": { "const": "manual" }, "formData": { "description": "A pre-filled JSON object created by filling out the associated JSON Form.", "type": [ "object", "null" ], "examples": [ { "deviceName": "ATL-123", "action": "SYNC" }, { "deviceName": "XYZ-987", "action": "SHUTDOWN" } ] }, "formSchemaHash": { "type": [ "string", "null" ] }, "lastExecuted": { "description": "A timestamp in milliseconds of the time this job was last executed.", "oneOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] } } } } }, { "$id": "endpoint-trigger-common", "title": "Endpoint Triggers Schema Common Definitions", "description": "Common elements in the schema for a Endpoint Trigger", "definitions": { "commonEndpointTriggerFieldNames": { "enum": [ "lastExecuted", "routeName", "verb", "schema", "jst" ] }, "commonEndpointTriggerFields": { "type": "object", "properties": { "type": { "const": "endpoint" }, "lastExecuted": { "description": "A timestamp in milliseconds of the time this job was last executed.", "oneOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "verb": { "description": "HTTP verb in uppercase", "type": "string", "enum": [ "POST" ] }, "routeName": { "description": "User defined route name", "type": "string", "pattern": "^([a-zA-Z0-9_-]+)$" }, "schema": { "oneOf": [ { "$ref": "http://json-schema.org/draft-07/schema#" }, { "type": "null" } ] }, "jst": { "oneOf": [ { "title": "MongoDB ObjectID", "description": "String representation of a MongoDB ObjectId", "examples": [ "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c" ], "oneOf": [ { "type": "object" }, { "type": "string", "pattern": "^[0-9a-f]{24}$" } ] }, { "type": "null" } ] } } } } }, { "$id": "schedule-trigger-common", "title": "Schedule Triggers Schema Common Definitions", "description": "Common elements in the schema for a Schedule Trigger", "definitions": { "commonScheduleTriggerFieldNames": { "enum": [ "formData", "formSchemaHash", "firstRunAt", "processMissedRuns" ] }, "commonScheduleTriggerFields": { "type": "object", "properties": { "type": { "const": "schedule" }, "formData": { "description": "A pre-filled JSON object created by filling out the associated JSON Form.", "type": [ "object", "null" ], "examples": [ { "deviceName": "ATL-123", "action": "SYNC" }, { "deviceName": "XYZ-987", "action": "SHUTDOWN" } ] }, "formSchemaHash": { "type": [ "string", "null" ] }, "firstRunAt": { "description": "A timestamp in milliseconds for the first scheduled run of this job.", "type": "integer", "minimum": 0, "examples": [ 1648829216268 ] }, "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" } ], "examples": [ 1648829216268, 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" } ], "examples": [ 1648829216268, 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" ] } } }, "legacyInvariantProperties": { "properties": { "repeatInterval": { "description": "The interval between repeated jobs in milliseconds. This is calculated from repeatUnit and repeatFrequency.", "oneOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "examples": [ 10000, 30000, 120000 ] } } }, "legacyCovariantProperties": { "type": "object", "additionalProperties": true, "oneOf": [ { "properties": { "repeatUnit": { "type": "null" }, "repeatFrequency": { "type": "null" } } }, { "properties": { "repeatUnit": { "type": "string", "enum": [ "minute", "hour", "day", "week" ] }, "repeatFrequency": { "oneOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] } }, "required": [ "repeatUnit" ] }, { "properties": { "repeatUnit": { "const": "second" }, "repeatFrequency": { "oneOf": [ { "type": "integer", "minimum": 0, "multipleOf": 10 }, { "type": "null" } ] } }, "required": [ "repeatUnit", "repeatFrequency" ] } ] }, "dimensionedQuantitySeconds": { "type": "object", "properties": { "unit": { "const": "second" }, "quantity": { "type": "number", "minimum": 0, "multipleOf": 10, "examples": [ 30, 140, 2000 ] } } }, "dimensionedQuantityOther": { "type": "object", "properties": { "unit": { "enum": [ "minute", "hour", "day", "week" ] }, "quantity": { "type": "number", "minimum": 0, "examples": [ 1, 3, 5, 10 ] } } }, "implicitMsQuantity": { "$comment": "Implicit unit of milliseconds", "type": "number", "minimum": 0, "multipleOf": 10000, "examples": [ 10000, 30000, 100000 ] }, "intervalDuration": { "oneOf": [ { "type": "object", "properties": { "unit": { "const": "second" }, "quantity": { "type": "number", "minimum": 0, "multipleOf": 10, "examples": [ 30, 140, 2000 ] } } }, { "type": "object", "properties": { "unit": { "enum": [ "minute", "hour", "day", "week" ] }, "quantity": { "type": "number", "minimum": 0, "examples": [ 1, 3, 5, 10 ] } } }, { "$comment": "Implicit unit of milliseconds", "type": "number", "minimum": 0, "multipleOf": 10000, "examples": [ 10000, 30000, 100000 ] } ] }, "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": [ { "type": "object", "properties": { "action": { "enum": [ "execute", "wait" ] } }, "required": [ "action" ] }, { "$ref": "#/definitions/intervalComponents" } ] }, "standardInterval": { "allOf": [ { "type": "object", "properties": { "type": { "enum": [ "repeating", "terminating" ] }, "duration": { "oneOf": [ { "type": "object", "properties": { "unit": { "const": "second" }, "quantity": { "type": "number", "minimum": 0, "multipleOf": 10, "examples": [ 30, 140, 2000 ] } } }, { "type": "object", "properties": { "unit": { "enum": [ "minute", "hour", "day", "week" ] }, "quantity": { "type": "number", "minimum": 0, "examples": [ 1, 3, 5, 10 ] } } }, { "$comment": "Implicit unit of milliseconds", "type": "number", "minimum": 0, "multipleOf": 10000, "examples": [ 10000, 30000, 100000 ] } ] } } }, { "$ref": "#/definitions/anyIntervalDirective" } ] }, "countShorthandInterval": { "allOf": [ { "type": "object", "properties": { "type": { "const": "count" }, "duration": { "oneOf": [ { "type": "object", "properties": { "unit": { "const": "second" }, "quantity": { "type": "number", "minimum": 0, "multipleOf": 10, "examples": [ 30, 140, 2000 ] } } }, { "type": "object", "properties": { "unit": { "enum": [ "minute", "hour", "day", "week" ] }, "quantity": { "type": "number", "minimum": 0, "examples": [ 1, 3, 5, 10 ] } } }, { "$comment": "Implicit unit of milliseconds", "type": "number", "minimum": 0, "multipleOf": 10000, "examples": [ 10000, 30000, 100000 ] } ] }, "count": { "type": "integer", "minimum": 0, "examples": [ 2, 5, 10, 25 ] } } }, { "$ref": "#/definitions/anyIntervalDirective" } ] }, "dateRangeShorthandInterval": { "allOf": [ { "type": "object", "properties": { "type": { "const": "date-range" }, "start": { "description": "", "type": "string", "format": "date-time", "examples": [ "2019-04-16T00:43:22.038Z" ] }, "end": { "description": "", "type": "string", "format": "date-time", "examples": [ "2019-04-16T00:43:22.038Z" ] } } }, { "$ref": "#/definitions/intervalComponents" } ] }, "anyInterval": { "oneOf": [ { "$ref": "#/definitions/standardInterval" }, { "$ref": "#/definitions/dateRangeShorthandInterval" }, { "$ref": "#/definitions/countShorthandInterval" } ] } } } ] }

{ "type": "object", "properties": { "triggers": { "title": "trigger", "type": "array", "items": { "oneOf": [ { "$ref": "endpoint-trigger-common" }, { "$ref": "eventSystem-trigger-common" }, { "$ref": "manual-trigger-common" }, { "$ref": "schedule-trigger-common" } ] } }, "options": { "title": "options", "type": "object", "properties": {} } }, "required": [ "triggers", "options" ], "additionalProperties": false }

{}

{ "title": "createdTrigger", "type": "object", "oneOf": [ { "$ref": "endpoint-trigger-common" }, { "$ref": "eventSystem-trigger-common" }, { "$ref": "manual-trigger-common" }, { "$ref": "schedule-trigger-common" } ] }