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": 50, "order": 1, "sort": "name", "include": "description", "exclude": "description", "in": "dolor quis Excepteur cillum incididunt", "not-in": "commodo aute minim ad ipsum", "equals": "esse mollit sint officia", "contains": "in irure Excepteur aliquip nostrud", "starts-with": "minim adipisicing aliqua exercitation veniam", "ends-with": "ex sit" } }
{ "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", "type": "string" }, "not-in": { "description": "Search for fields not exactly matching one of the given list options", "type": "string" }, "equals": { "description": "Returns results where the specified fields exactly match the given match string(s).", "type": "string" }, "contains": { "description": "Returns results where the specified fields contain the given match string(s).", "type": "string" }, "starts-with": { "description": "Returns results where the specified fields start with the given match string(s).", "type": "string" }, "ends-with": { "description": "Returns results where the specified fields end in the given match string(s).", "type": "string" } } } }, "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": "BcF49eD296AAc42c5FFC3cB3", "createdBy": "3527fA7cEa166eCDc2b6aa7D", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "Deb0D6E59Dd691cccbaF54ed", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "643fFd7B7F4AE4ABA00Fe1D8", "name": "labore" }, { "_id": "9f6F69aaaDC82aFd82F8FcAf", "name": "pariatur do" } ] }, { "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": "381D8A430C8ffB3A8eCF8bc8", "createdBy": "3aaAeE7a3326CF1eF0910ae0", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "d5BBb4939CaAE7c35b0CDAAA", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "197a2F96a9E4eB1F4ab6aCeF", "name": "dolor" }, { "_id": "20DcbD966dcFBa6eAa0ac242", "name": "dolore" } ] }, { "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": "B3D123423bCd7bd4C7E3EDac", "createdBy": "4CB8372Df603e6dc8c3C317D", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "3Fb9Adae19191b26DFfc0DEB", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "e4DC3D04C237F21eF019aEFE", "name": "aute sed nulla dolore" }, { "_id": "ddb25dF4dEfa4a613E1d2DbD", "name": "anim amet" }, { "_id": "CFCD43CbDaAeabfB314D9eEe", "name": "Lorem" }, { "_id": "A6a2AbDFCdf2CA9C7DCecDca", "name": "et ex deserunt nostrud eu" }, { "_id": "55EEefEf1cA38cDAfD6BbC16", "name": "aliquip in tempor nisi Duis" } ] }, { "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": "c80cbE789F6f6F5A34C4D42e", "createdBy": "5D6cDf5eabAfdb9683ACA014", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "A9F9B22ECD4C70Ba512A8eBB", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "Bb8F6e75ceaCefD3a4f55760", "name": "Duis" }, { "_id": "8eAFD715FaCa1AdE011adbB1", "name": "amet" }, { "_id": "FcB432De748cD6cb3e62f3B2", "name": "ipsum nisi aliqua" }, { "_id": "e60936aCe476FDD68facf7D6", "name": "et veniam ad" } ] } ], "total": -50120131, "start": 38419250, "end": -31339816, "count": 14132511, "next": null, "previous": "esse laboris eu in officia" }
{ "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": { "description": "URI pointing to the next set of paginated results. Preserves previous search and projection parameters. Null if returning the last page of results.", "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "previous": { "description": "URI pointing to the previous set of paginated results. Preserves previous search and projection parameters. Null if returning the first page of results.", "oneOf": [ { "type": "string" }, { "type": "null" } ] } } }