Summary
Gets a page of template documents.
Description
Gets a page of template documents.
Route
GET /automation-studio/templates
Roles
Parameters
Name | Type | Required | Description |
---|---|---|---|
queryParameters | object | yes | Parameters for filtering, paginating, projecting, and sorting template documents. |
{ "queryParameters": { "limit": 25, "skip": 1, "order": 1, "sort": "name", "include": "description", "exclude": "_id", "in": { "_id": "consequat velit", "name": "Lorem laboris non Excepteur", "group": "Excepteur eu", "command": "commodo", "description": "ipsum", "template": "Lorem", "data": "in ut in exercitation", "type": "consequat mollit enim", "createdBy": "ut laboris laborum dolore", "created": "anim ut pariatur ad aute", "lastModifiedBy": "id", "lastUpdated": "mollit Excepteur do aute dolor" }, "not-in": { "_id": "Lorem ullamco magna occaecat", "name": "esse elit ad ipsum", "group": "Ut ipsum", "command": "ipsum reprehenderit in tempor nisi", "description": "velit", "template": "velit", "data": "quis exercitation", "type": "Lorem incididunt aliquip fugiat", "createdBy": "consectetur", "created": "velit reprehenderit", "lastModifiedBy": "amet elit Lorem", "lastUpdated": "ut irure" }, "equals": { "_id": "sed occaecat", "name": "ullamco", "group": "ea dolore ipsum commodo", "command": "enim officia Excepteur tempor nisi", "description": "ex", "template": "dolore proident commodo", "data": "eu laborum Ut consequat", "type": "dolor Ut", "createdBy": "voluptate nostrud occaecat", "created": "minim veniam dolor", "lastModifiedBy": "deserunt", "lastUpdated": "in consequat veniam in" }, "contains": { "_id": "amet cillum ut non", "name": "dolore nostrud reprehenderit culpa quis", "group": "ullamco", "command": "sed mollit in in", "description": "nulla magna consectetur velit", "template": "deserunt consequat aliqua", "data": "Excepteur commodo fugiat dolore", "type": "nostrud", "createdBy": "in reprehenderit Excepteur", "created": "aliquip ut", "lastModifiedBy": "ut", "lastUpdated": "elit exercitation deserunt" }, "starts-with": { "_id": "occaecat non magna sit", "name": "sit qui eiusmod", "group": "dolor reprehenderit", "command": "Lorem enim fugiat", "description": "non", "template": "proident fugiat eiusmod cillum", "data": "amet dolore ad ea do", "type": "in culpa irure mollit cupidatat", "createdBy": "nulla sint incididunt fugiat", "created": "irure", "lastModifiedBy": "pariatur enim consequat Ut ut", "lastUpdated": "aute sit sint Ut dolor" }, "ends-with": { "_id": "in sint proident", "name": "nulla consectetur", "group": "tempor cupidatat elit", "command": "sit", "description": "Ut id ad", "template": "adipisicing in", "data": "proident dolore quis sint nulla", "type": "aliquip non fugiat", "createdBy": "id exercitation ad dolor fugiat", "created": "labore aliqua et", "lastModifiedBy": "cillum", "lastUpdated": "ea eu aute elit" } } }
{ "type": "object", "properties": { "queryParameters": { "title": "queryParameters", "type": "object", "properties": { "limit": { "type": "integer", "description": "Number of results to return. Used for pagination.", "default": 25, "minimum": 0, "examples": [ 1, 10, 50 ] }, "skip": { "type": "integer", "description": "Number of results to skip. Used for pagination.", "default": 0, "minimum": 0, "examples": [ 1, 10, 50 ] }, "order": { "type": "integer", "description": "Sort direction, 1 for ascending and -1 for descending.", "default": 1, "enum": [ -1, 1 ] }, "sort": { "type": "string", "description": "Field to sort by", "default": "name", "enum": [ "name" ] }, "include": { "type": "string", "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", "examples": [ "name", "description", "name,description" ] }, "exclude": { "type": "string", "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", "examples": [ "_id", "description", "_id,description" ] }, "in": { "description": "Search for fields exactly matching one of the given list options", "$ref": "template#/definitions/searchableFields" }, "not-in": { "description": "Search for fields not exactly matching one of the given list options", "$ref": "template#/definitions/searchableFields" }, "equals": { "description": "Returns results where the specified fields exactly match the given match string(s).", "$ref": "template#/definitions/searchableFields" }, "contains": { "description": "Returns results where the specified fields contain the given match string(s).", "$ref": "template#/definitions/searchableFields" }, "starts-with": { "description": "Returns results where the specified fields start with the given match string(s).", "$ref": "template#/definitions/searchableFields" }, "ends-with": { "description": "Returns results where the specified fields end in the given match string(s).", "$ref": "template#/definitions/searchableFields" } } } }, "required": [ "queryParameters" ], "additionalProperties": false }
Return
Name | Type | Description |
---|---|---|
result | object | Results for the given search parameters. |
{ "items": [ { "name": "test", "group": "Sample group", "command": "show ip br", "description": "description", "template": "Value FIRST_WORD (S+)\n\nStart\n ^FIRST_WORD.* -> Record", "data": "some sample text to match against", "type": "test", "_id": "BAfd35A3dD4a996bD3aa76CA", "createdBy": "bBBCc69fC2d3bbB8C4a59Cb7", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "Ec5c6DdeAa5feD3E774cC954", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1 } ], "total": -94527870, "start": 76596909, "end": 8649101, "count": 8384422, "next": "est dolore", "previous": "sunt in culpa aute" }
{ "title": "result", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "template" } }, "total": { "type": "integer", "description": "Total number of documents matching the given query parameters." }, "start": { "type": "integer", "description": "Search index of first document in the items array." }, "end": { "type": "integer", "description": "Search index of the last document in the items array." }, "count": { "type": "integer", "description": "Length of the items array." }, "next": { "type": [ "string", "null" ], "description": "URI pointing to the next set of paginated results. Preserves previous search and projection parameters. Null if returning the last page of results." }, "previous": { "type": [ "string", "null" ], "description": "URI pointing to the previous set of paginated results. Preserves previous search and projection parameters. Null if returning the first page of results." } } }