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": 10, "order": 1, "sort": "name", "include": "name,description", "exclude": "description", "in": { "_id": "adipisicing in ut", "name": "Duis", "group": "culpa Ut Duis commodo", "command": "officia ullamco Ut", "description": "cupidatat mollit", "template": "sed proident dolore quis consectetur", "data": "sunt consequat", "type": "aliquip", "createdBy": "ut", "created": "commodo enim dolore aliqua", "lastModifiedBy": "do", "lastUpdated": "culpa laborum elit et minim" }, "not-in": { "_id": "reprehenderit aliqua aliquip cupidatat non", "name": "laboris", "group": "proident fugiat non", "command": "sed", "description": "laborum consectetur", "template": "cillum", "data": "non consequat", "type": "magna consequat voluptate ex", "createdBy": "proident ipsum voluptate nisi", "created": "deserunt", "lastModifiedBy": "reprehenderit sint velit", "lastUpdated": "ullamco quis esse do" }, "equals": { "_id": "eu amet commodo ullamco magna", "name": "officia labore ullamco sed", "group": "laborum proident", "command": "cillum voluptate exercitation sunt adipisicing", "description": "occaecat sit nulla", "template": "sed amet irure", "data": "nisi culpa deserunt in incididunt", "type": "aliqua in in", "createdBy": "ut eu laborum", "created": "occaecat id cupidatat dolore sed", "lastModifiedBy": "proident Lorem aute dolore qui", "lastUpdated": "do sit" }, "contains": { "_id": "exercitation", "name": "dolore commodo in voluptate amet", "group": "do dolore elit", "command": "fugiat culpa sit id aliqua", "description": "commodo exercitation fugiat culpa", "template": "consectetur", "data": "ut Lorem", "type": "ullamco", "createdBy": "dolor cupidatat enim amet", "created": "ut eiusmod culpa", "lastModifiedBy": "dolor anim minim", "lastUpdated": "culpa sint ullamco" }, "starts-with": { "_id": "anim ullamco eiusmod sunt ad", "name": "Ut aliquip eiusmod nostrud", "group": "Excepteur culpa nulla dolor", "command": "Lorem ea deserunt elit", "description": "aute cupidatat", "template": "nulla est occaecat labore pariatur", "data": "amet Excepteur qui velit quis", "type": "non occaecat ex consectetur", "createdBy": "laboris consequat consectetur est", "created": "incididunt consectetur sit reprehenderit nulla", "lastModifiedBy": "ut", "lastUpdated": "consequat labore" }, "ends-with": { "_id": "aliquip minim laborum quis in", "name": "incididunt culpa labore irure", "group": "consectetur culpa cillum ipsum do", "command": "minim", "description": "consequat dolor laboris do ut", "template": "in aute", "data": "non Lorem nostrud esse dolore", "type": "veniam dolore non incididunt amet", "createdBy": "ea est aliqua qui ad", "created": "dolore", "lastModifiedBy": "irure", "lastUpdated": "sed officia" } } }
{ "type": "object", "properties": { "queryParameters": { "title": "queryParameters", "type": "object", "additionalProperties": true, "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": "d221FE3cfF6d5C1c3a89fd33", "createdBy": "1093CfEdF85a8f9Dc1daF618", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "93d9dfCdEF3CEDaf20484fDd", "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": "Ea82DDd0Ecebcc5d45DdA30F", "createdBy": "cb71db636C9b0FaeC0BD6e7c", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "Caceb020bAcF3e6bC8351a7e", "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": "E23ABCF02D14aD7d3955c5F1", "createdBy": "bA645e7cF9f2dd16FE4Cd4fa", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "0AE1bC0aA1F0ea0fe005dE7e", "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": "6D51cBE2d33a1FcdB85A2EA4", "createdBy": "b855FBE9E646B466ECE32193", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "E9e0BFfB0d4C18fCA6830634", "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": "c57be7200ecB5AFbd3ECF034", "createdBy": "512CC1F8a42fD6d648ed12AE", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "bF87eED488e81B9DfdFccaBA", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1 } ], "total": -46952187, "start": -68340325, "end": -41100254, "count": -86728623, "next": null, "previous": "do" }
{ "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." } } }