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": 1, "skip": 50, "order": 1, "sort": "name", "include": "name", "exclude": "_id", "in": { "_id": "exercitation", "name": "incididunt magna fugiat eu", "group": "officia", "command": "nostrud", "description": "Excepteur cupidatat culpa voluptate dolore", "template": "do sed", "data": "sint exercitation occaecat voluptate", "type": "labore", "createdBy": "ad ipsum culpa reprehenderit consectetur", "created": "fugiat nisi sed", "lastModifiedBy": "ullamco", "lastUpdated": "deserunt aute id" }, "not-in": { "_id": "esse dolore quis sint", "name": "incididunt", "group": "fugiat velit", "command": "nostrud laboris cillum voluptate mollit", "description": "in ipsum eiusmod", "template": "dolore ad tempor nostrud nulla", "data": "eiusmod proident sed", "type": "culpa ut", "createdBy": "pariatur proident nostrud Excepteur", "created": "sunt mollit", "lastModifiedBy": "nostrud sit", "lastUpdated": "veniam incididunt consectetur in" }, "equals": { "_id": "est occaecat anim aliquip", "name": "laboris non occaecat ut nisi", "group": "aute cillum dolor ut", "command": "in", "description": "aute aliqua ipsum aliquip", "template": "ad", "data": "in", "type": "sint", "createdBy": "sint ad exercitation dolore amet", "created": "irure", "lastModifiedBy": "do aute occaecat veniam", "lastUpdated": "in" }, "contains": { "_id": "exercitation", "name": "Lorem et", "group": "irure", "command": "mollit", "description": "quis et Excepteur magna reprehenderit", "template": "ut", "data": "reprehenderit", "type": "exercitation Ut dolor ullamco", "createdBy": "consectetur nisi fugiat", "created": "dolor adipisicing ad sunt", "lastModifiedBy": "mollit", "lastUpdated": "aliquip qui officia et in" }, "starts-with": { "_id": "labore amet proident Lorem", "name": "ullamco", "group": "quis sunt labore", "command": "labore nostrud", "description": "qui consectetur", "template": "est quis officia aliquip in", "data": "ea ut adipisicing", "type": "ex ullamco sit proident", "createdBy": "anim Excepteur velit", "created": "est esse labore dolore", "lastModifiedBy": "sunt voluptate", "lastUpdated": "non sunt occaecat est Ut" }, "ends-with": { "_id": "exercitation", "name": "ex nisi magna velit in", "group": "nostrud pariatur nisi et irure", "command": "ut magna veniam quis", "description": "qui Duis", "template": "enim do ullamco et aliqua", "data": "in ea", "type": "occaecat est consectetur", "createdBy": "dolor enim", "created": "Excepteur", "lastModifiedBy": "mollit enim nisi reprehenderit dolor", "lastUpdated": "ex dolor" } } }
{ "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": "CDb1c30f6Ef1BC1Aaf7F477F", "createdBy": "AEEDaa3DC7546ba39cd3D20e", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "ebC3EDAF10040c5e82b2Da0d", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1 }, { "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": "5F94A64F5dE3baF7fcC1A596", "createdBy": "c1e98436c4aAbBA0ffA8DAEe", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "CaE6bb2D757dD9c14D4bEDC8", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1 }, { "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": "8E6C3f11AdBe8aAAAE7CcbDB", "createdBy": "06325d9bC502f7AD35ed0718", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "bE8B327D835FAaf176C634bC", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1 }, { "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": "aa2D8bAE056Beb7eCF6ebd37", "createdBy": "f138dEeC5FDACDEEeba829e7", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "9ffaDb691bFcD43b58cbbAA8", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1 }, { "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": "1b7AbeeAAd6E2a46BAdb6DfA", "createdBy": "DF4F8CB299DA6CeAA3AccFAa", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "bEeFc8dab4D2cFA746ecce0b", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1 } ], "total": 65605881, "start": 92087829, "end": 67819936, "count": 18832971, "next": "aliqua occaecat", "previous": "proident tempor" }
{ "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." } } }