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": 10, "skip": 50, "order": 1, "sort": "name", "include": "description", "exclude": "description", "in": { "_id": "consectetur", "name": "commodo", "group": "deserunt id dolor fugiat", "command": "ullamco commodo nostrud deserunt aute", "description": "laborum reprehenderit culpa", "template": "consequat", "data": "labore irure", "type": "voluptate", "createdBy": "nulla dolor", "created": "laboris deserunt", "lastModifiedBy": "irure", "lastUpdated": "id qui ipsum anim" }, "not-in": { "_id": "eu officia commodo do non", "name": "eiusmod adipisicing irure", "group": "pariatur ea eu Excepteur", "command": "laboris do cillum nostrud adipisicing", "description": "non ad", "template": "anim ut eiusmod", "data": "proident", "type": "eu commodo elit pariatur ipsum", "createdBy": "laborum", "created": "magna ad velit", "lastModifiedBy": "sed", "lastUpdated": "in velit voluptate minim elit" }, "equals": { "_id": "reprehenderit dolore Duis proident velit", "name": "nostrud ex aliquip", "group": "adipisicing sed Duis", "command": "in dolor ut cupidatat adipisicing", "description": "Lorem voluptate occaecat proident", "template": "culpa", "data": "id commodo adipisicing reprehenderit pariatur", "type": "Duis Lorem Ut dolore", "createdBy": "in magna minim", "created": "exercitation et nulla", "lastModifiedBy": "proident incididunt in aliqua cupidatat", "lastUpdated": "velit" }, "contains": { "_id": "minim sint", "name": "ut esse", "group": "in in pariatur amet exercitation", "command": "occaecat qui Excepteur in", "description": "Duis", "template": "cillum ipsum", "data": "in", "type": "enim cupidatat", "createdBy": "dolor", "created": "non veniam qui", "lastModifiedBy": "dolore veniam aute sit", "lastUpdated": "non officia esse" }, "starts-with": { "_id": "officia labore sunt dolor", "name": "officia", "group": "occaecat mollit dolore ex", "command": "dolore Excepteur", "description": "tempor", "template": "veniam Lorem cupidatat", "data": "cupidatat", "type": "amet cillum mollit sint", "createdBy": "esse", "created": "Excepteur fugiat exercitation", "lastModifiedBy": "sit", "lastUpdated": "sit" }, "ends-with": { "_id": "dolore", "name": "eiusmod Lorem", "group": "in", "command": "ut elit pariatur reprehenderit aliqua", "description": "id cupidatat", "template": "quis nulla tempor", "data": "magna dolore consectetur", "type": "aute pariatur in", "createdBy": "pariatur et nostrud", "created": "dolor est non exercitation", "lastModifiedBy": "et minim elit", "lastUpdated": "qui sint elit aliquip" } } }
{ "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": "bFf523d0C451Da985cd2cB18", "createdBy": "cBFb1d9aB6DcBB36b5FC47Ea", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "b96D5CEd508Daaf1FeBa7fA9", "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": "f6BDC6335c66aEB86ba85B5C", "createdBy": "c27F0CFBCc28Dd5f4cb719e5", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "f4e03E9433d1881e8dCD9eec", "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": "90ee5979a12f987fbbA3Fc1D", "createdBy": "1Fb8F13E553E59adeF1deEaF", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "CdC0eCfdF8fcFBffFECddF4b", "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": "680f9c46ae433c01b2Ae5D74", "createdBy": "DBdf83DBC0F80cB049fabE3F", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "0DBeFf5E9BcD285D03A36dF9", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1 } ], "total": -81220797, "start": -80743255, "end": 12859069, "count": 20064252, "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." } } }