app-operations_manager Schemas

On this page:

common-ops-schema

{ "$schema": "http://json-schema.org/draft-07/schema", "$id": "common-ops-schema", "title": "Common Triggers Schema", "description": "Schema for the shared properties between Trigger types", "type": "object", "definitions": { "name": { "type": "string", "minLength": 1, "description": "The name of the document", "examples": [ "My document" ] }, "description": { "type": "string", "description": "The description of the document", "examples": [ "Some details describing the document and its purpose." ] }, "ISODate": { "description": "", "type": "string", "format": "date-time", "examples": [ "2019-04-16T00:43:22.038Z" ] }, "ObjectId": { "title": "MongoDB ObjectID", "description": "String representation of a MongoDB ObjectId", "examples": [ "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c" ], "oneOf": [ { "type": "object" }, { "type": "string", "pattern": "^[0-9a-f]{24}$" } ] }, "ObjectIdLikeString": { "title": "A string which is formatted like an ObjectId", "description": "Distinct from an actual ObjectId", "examples": [ "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c" ], "type": "string", "$comment": "The pattern from common-ops-schema#/definitions/ObjectId is used to identify fields which are actual MongoDB ObjectIds. This pattern makes a small change (inverts the order in the character class) to exclude any fields validated by it from being considered actual ObjectIds by the API logic.", "pattern": "^[a-f0-9]{24}$" }, "userAccount": { "oneOf": [ { "$ref": "#/definitions/ObjectId" }, { "const": "Pronghorn" } ] }, "enabled": { "type": "boolean", "description": "A flag to determine if a Trigger is enabled or not." }, "actionType": { "type": "string", "description": "The type of component a Trigger will invoke.", "enum": [ "automations" ] }, "decorators": { "type": "array", "items": { "type": "object", "properties": { "type": { "const": "encryption" }, "pointer": { "type": "string", "format": "json-pointer" } } } }, "uuidv4": { "type": "string", "pattern": "^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$", "examples": [ "6ffce28f-37f8-48a0-a026-5567120def79", "9f3a1fc3-5192-470e-bdcb-9a8ac978e1e5" ] }, "groupDocument": { "type": "object", "properties": { "_id": { "$ref": "#/definitions/ObjectId" }, "provenance": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "memberOf": { "type": "array", "items": { "type": "object", "properties": { "groupId": { "$ref": "#/definitions/ObjectId" }, "aaaManaged": { "type": "boolean" } } } }, "assignedRoles": { "type": "array", "items": { "type": "object", "properties": { "roleId": { "type": "string" } } } }, "inactive": { "type": "boolean" }, "_meta": { "created": { "$ref": "#/definitions/ISODate" }, "updated": { "$ref": "#/definitions/ISODate" }, "migrationVersion": { "type": "integer" } } } }, "accountObject": { "type": "object", "properties": { "_id": { "$ref": "#/definitions/ObjectId" }, "provenance": { "type": "string" }, "username": { "type": "string" }, "firstname": { "type": "string" }, "memberOf": { "type": "array", "items": { "type": "object", "properties": { "groupId": { "$ref": "#/definitions/ObjectId" }, "aaaManaged": { "type": "boolean" } } } }, "assignedRoles": { "type": "array", "items": { "type": "object", "properties": { "roleId": { "type": "string" } } } }, "inactive": { "type": "string" }, "lastLogin": { "$ref": "#/definitions/ISODate" }, "_meta": { "type": "object", "properties": { "created": { "$ref": "#/definitions/ISODate" }, "updated": { "$ref": "#/definitions/ISODate" }, "migrationVersion": { "type": "integer" } } }, "email": { "type": "string" } } } } }