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": 1, "order": 1, "sort": "name", "include": "description", "exclude": "description", "in": "amet sint consectetur adipisicing et", "not-in": "fugiat", "equals": "cillum", "contains": "exercitation ut eu", "starts-with": "amet quis", "ends-with": "occaecat dolor laboris ut laborum" } }
{ "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": "9FCBFa70BE1Bae14d6Bc41f4", "createdBy": "b326C4Cf3F7E6ABC727BB5A9", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "e3cda8eFE3B474d64B37F65f", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "Ab5D6c865501Dd3c2a9D8f3a", "name": "consectetur ad sunt", "description": "A user-defined object to help group documents." }, { "_id": "Ae53a440E4c6E20aDd7d239b", "name": "in non fugiat reprehenderit", "description": "A user-defined object to help group documents." }, { "_id": "E00Cabbc5E7298eCbbC05ed2", "name": "voluptate dolor enim dolore minim", "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": "8cEc5DE7A1BdEA65beFA5B9D", "createdBy": "B646F60c21Db96AFc96CaAe5", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "Aac3dc1eF9fb6e080b0eF495", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "A9AEba0Ca714A12DB0d9cEfa", "name": "do", "description": "A user-defined object to help group documents." }, { "_id": "7f3D6daFEa79afF9c28EB35e", "name": "pariatur consequat", "description": "A user-defined object to help group documents." }, { "_id": "ae4E126Ca31055f4Efa1fbc1", "name": "veniam sed", "description": "A user-defined object to help group documents." }, { "_id": "BF488FcEBfeDe3D74bb3bAF4", "name": "laboris in tempor consectetur", "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": "D59Ff1BC74C6d431F6f3b6b7", "createdBy": "CaC40Ca35caf8c62AD097365", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "2fFe4e6D4c865D19AC9CF728", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "16FddCBdba60F4084c915Eca", "name": "ut tempor qui dolor", "description": "A user-defined object to help group documents." }, { "_id": "532D89882fEf0ae83CE9AeB2", "name": "aliquip elit", "description": "A user-defined object to help group documents." }, { "_id": "86F3E4B071fcaCaeBdFFFC44", "name": "ullamco", "description": "A user-defined object to help group documents." }, { "_id": "B621d429bA29a6fC3Df52eDf", "name": "esse minim nisi cillum Lorem", "description": "A user-defined object to help group documents." }, { "_id": "6dC12DE9D5fabe219BD52511", "name": "ad id elit deserunt reprehenderit", "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": "1c7Cafc7d94e3dae3F9f670a", "createdBy": "6CEf373a0aC6DE7d6C8a7Ec6", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "CBEF2D00Eecbc1e4dfaa19Be", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "6eED410Dab1dA1ab431DA0E5", "name": "laboris culpa Ut ut ipsum", "description": "A user-defined object to help group documents." }, { "_id": "f42e0860A9AD5cAdCcfEf3Bb", "name": "voluptate", "description": "A user-defined object to help group documents." }, { "_id": "fF24dEABcE4da56A512A6C5A", "name": "tempor cupidatat magna", "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": "cCaeD82aF7fAa7eDe3D937fD", "createdBy": "5BeddFD0eCdac9fd5EAcB9d9", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "ff6E70d5FbC88CadbeD0A2E9", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "d4A1CF1Bfd6ABDE0FE665ADF", "name": "in", "description": "A user-defined object to help group documents." }, { "_id": "d53EC0eDa7Bf0EA39DeDCCBe", "name": "consequat ipsum elit", "description": "A user-defined object to help group documents." }, { "_id": "142Ed5FA0dbed19A90A3B7f7", "name": "est quis", "description": "A user-defined object to help group documents." }, { "_id": "DEC413D8AEF0A522febE5349", "name": "dolore", "description": "A user-defined object to help group documents." }, { "_id": "BFD4F7dD21d096aE46aE4e1d", "name": "in", "description": "A user-defined object to help group documents." } ] } ], "total": 97311718, "start": 41591802, "end": 540681, "count": -31571379, "next": null, "previous": "qui laboris cupidatat ullamco in" }
{ "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." } } }