app-automation_studio Schemas

On this page:

template

{ "$id": "template", "title": "Template Document", "description": "An entity representing a data template.", "type": "object", "definitions": { "ObjectId": { "type": "string", "pattern": "^[0-9a-fA-F]{24}$", "description": "Unique identifier of the automation" }, "tag": { "type": "object", "description": "A user-defined object to help group documents.", "properties": { "_id": { "$ref": "#/definitions/ObjectId" }, "name": { "type": "string", "description": "user-given, unique string to ID tag" } } }, "searchableFields": { "type": "object", "additionalProperties": false, "properties": { "_id": { "type": "string" }, "name": { "type": "string" }, "group": { "type": "string" }, "command": { "type": "string" }, "description": { "type": "string" }, "template": { "type": "string" }, "data": { "type": "string" }, "type": { "type": "string" }, "createdBy": { "type": "string" }, "created": { "type": "string" }, "lastModifiedBy": { "type": "string" }, "lastUpdated": { "type": "string" }, "tags": { "type": "array", "items": { "$ref": "#/definitions/tag" } } } } }, "properties": { "_id": { "$ref": "#/definitions/ObjectId" }, "name": { "type": "string", "examples": [ "test" ], "minLength": 1, "pattern": "^(?!\\s)[\\w\\s]+(?"group": { "type": "string", "examples": [ "Sample group" ], "minLength": 1 }, "command": { "type": "string", "examples": [ "show ip br" ], "minLength": 1 }, "description": { "type": "string", "examples": [ "description" ], "minLength": 1 }, "template": { "type": "string", "examples": [ "Value FIRST_WORD (S+)\n\nStart\n ^FIRST_WORD.* -> Record" ], "minLength": 1 }, "data": { "type": "string", "examples": [ "some sample text to match against" ], "minLength": 1 }, "type": { "type": "string", "examples": [ "test" ], "enum": [ "textfsm", "jinja2" ] }, "createdBy": { "$ref": "#/definitions/ObjectId" }, "created": { "type": "string", "examples": [ "2019-11-25T22:51:39.201Z" ], "format": "date-time" }, "lastUpdatedBy": { "$ref": "#/definitions/ObjectId" }, "lastUpdated": { "type": "string", "examples": [ "2019-11-25T22:51:39.201Z" ], "format": "date-time" }, "version": { "type": "number", "examples": [ 1 ], "minimum": 1 }, "tags": { "type": "array", "items": { "$ref": "#/definitions/tag" } } }, "required": [ "name", "group", "command", "description", "template", "data", "type" ], "additionalProperties": false }