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": 50, "skip": 1, "order": 1, "sort": "name", "include": "name", "exclude": "_id,description", "in": "consequat", "not-in": "laborum eu culpa", "equals": "esse", "contains": "voluptate id", "starts-with": "minim irure dolor deserunt", "ends-with": "eiusmod dolor magna" } }
{ "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": "a18c88B0120bCFb7de06BCcc", "createdBy": "f6B8Ae7Fcd2e3CE483e8cEfc", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "DeAa016084AFD544f13A74Ae", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "2Ae6C65881abEf9C7D0CFf48", "name": "culpa", "description": "A user-defined object to help group documents." }, { "_id": "3Fd980476bd7Eecedf4B1Df5", "name": "cupidatat fugiat", "description": "A user-defined object to help group documents." }, { "_id": "0Bc217FDA459BE3Ae7e380c9", "name": "in et id occaecat", "description": "A user-defined object to help group documents." }, { "_id": "a425ACEedfa4c6698AFf4AE9", "name": "exercitation velit ut", "description": "A user-defined object to help group documents." }, { "_id": "8a98b932Afbb72da6CA6B7E3", "name": "proident elit pariatur", "description": "A user-defined object to help group documents." } ] }, { "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": "Fcd4eeC8Fabddb16aB7A814E", "createdBy": "5a088dB7b5Cb059B1cf0CFf7", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "d3CBf1E0CB2e60DdF7bD8Ce1", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "18a16d8CE28Fb4A88Da89ec3", "name": "cupidatat velit nulla aliqua", "description": "A user-defined object to help group documents." } ] }, { "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": "9216d1FD7DA6CAaeBf594acf", "createdBy": "9c221adB6c262Cf61b211ffe", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "74DaFd8F8065B6f0E804CaEB", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "255433699d6a240aFc15DcF4", "name": "in ipsum nostrud incididunt adipisicing", "description": "A user-defined object to help group documents." } ] }, { "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": "7d238c2d1E69562Cc2c7BF3A", "createdBy": "a9EfadBBc2775a4AeEa78687", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "876E277f247d13FdacCd8BA9", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "72cEfaEFd90EBe15F4f8c6CC", "name": "Lorem", "description": "A user-defined object to help group documents." }, { "_id": "8AEfFA0b9746A80aA4C45344", "name": "occaecat aliquip enim", "description": "A user-defined object to help group documents." } ] }, { "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": "41dd05449da13BcFa7Bfc9Cd", "createdBy": "Ac67A7B2a8DaBf756c64F42a", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "e73fc119A68aE270C70A92d7", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "1cebc4a0bd3AF2DcAf4Adfc6", "name": "minim", "description": "A user-defined object to help group documents." }, { "_id": "E9DC42227c6Def63bEBbAbaA", "name": "labore", "description": "A user-defined object to help group documents." }, { "_id": "4814defbF2cc696c4CEA142b", "name": "est", "description": "A user-defined object to help group documents." }, { "_id": "6dfAcF74cB8Bb80EC55Fa029", "name": "labore ut Ut do", "description": "A user-defined object to help group documents." }, { "_id": "a614cBE8D3fFCDafe83ba2Ae", "name": "et", "description": "A user-defined object to help group documents." } ] } ], "total": 30001796, "start": 4647052, "end": -30090105, "count": -8155277, "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." } } }