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": 0, "order": 1, "sort": "name", "include": "name,description", "exclude": "_id,description", "in": { "_id": "fugiat ea non dolor enim", "name": "esse pariatur", "group": "eu consequat", "command": "in consequat tempor ex", "description": "aliqua mollit enim laborum officia", "template": "id ullamco", "data": "deserunt Lorem commodo nostrud", "type": "adipisicing anim exercitation incididunt ut", "createdBy": "exercitation ipsum deserunt", "created": "do veniam", "lastModifiedBy": "veniam commodo", "lastUpdated": "et sit ipsum non ut" }, "not-in": { "_id": "veniam irure officia", "name": "velit sint", "group": "irure", "command": "laboris laborum dolore", "description": "commodo Excepteur", "template": "officia", "data": "aliqua eiusmod incididunt exercitation", "type": "ut dolor sit", "createdBy": "amet", "created": "aliquip irure elit", "lastModifiedBy": "dolor laboris eu adipisicing amet", "lastUpdated": "mollit Ut consectetur deserunt" }, "equals": { "_id": "laborum ea sed", "name": "proident est officia minim", "group": "in nulla ut ut", "command": "ut dolor aute", "description": "elit ipsum", "template": "mollit dolore ipsum in elit", "data": "in", "type": "eiusmod", "createdBy": "tempor culpa", "created": "enim aute ea eiusmod nostrud", "lastModifiedBy": "dolore ut pariatur", "lastUpdated": "reprehenderit adipisicing" }, "contains": { "_id": "nulla commodo fugiat", "name": "irure ad", "group": "magna culpa dolore nulla amet", "command": "consequat do cupidatat eiusmod ut", "description": "laboris esse", "template": "nisi deserunt", "data": "dolore reprehenderit pariatur quis ea", "type": "cillum fugiat in", "createdBy": "fugiat ad dolore", "created": "labore in velit", "lastModifiedBy": "sunt enim nisi cillum ut", "lastUpdated": "consectetur dolore" }, "starts-with": { "_id": "et in anim enim Lorem", "name": "fugiat velit qui", "group": "aliquip qui", "command": "in Duis dolore", "description": "pariatur ex incididunt", "template": "nulla culpa et cillum", "data": "elit adipisicing", "type": "sunt in irure", "createdBy": "eiusmod Lorem irure Ut", "created": "aute", "lastModifiedBy": "consequat et dolor voluptate", "lastUpdated": "sed voluptate" }, "ends-with": { "_id": "Lorem fugiat", "name": "amet aliquip", "group": "et est", "command": "ut pariatur Lorem in dolore", "description": "eu irure sint Duis eiusmod", "template": "eu in proident laborum", "data": "et exercitation commodo", "type": "ad quis ullamco nostrud", "createdBy": "et veniam", "created": "deserunt consequat in", "lastModifiedBy": "voluptate adipisicing quis", "lastUpdated": "sint in Lorem cupidatat dolore" } } }
{ "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": "fbFfa460850dF9Ef56861bE7", "createdBy": "CB741c654d50bcD84eAd3a05", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "7DED8b6F5846DD16a6f534Cf", "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": "7f2A5DaA521B5b9622DbE3d8", "createdBy": "ab05A4f01eDcdddAbE09Ea51", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "f85eC3b4c11de6A1ebdbAfFa", "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": "93EF725eAe51b19dBEa72059", "createdBy": "E98bcfdE6Cf3a42ff88dEDCf", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "FC263de7FC4d952fe15f8dc1", "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": "3C3D1687aaBbDfB1e9beE8aA", "createdBy": "6D4189d8fCc95EFe7afE854B", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "Becc1fe9B2CaDB287CcF5d1f", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1 } ], "total": 61739594, "start": 64261032, "end": 53525254, "count": -44335763, "next": null, "previous": null }
{ "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." } } }