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": 1, "skip": 10, "order": 1, "sort": "name", "include": "name", "exclude": "_id,description", "in": "culpa ex dolore", "not-in": "elit eu sed", "equals": "id sunt sed velit est", "contains": "in", "starts-with": "est dolore dolore enim", "ends-with": "deserunt" } }
{ "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": "1Ee6f05EA1A4514F5cd2B9Ee", "createdBy": "420EA793EEb2fE4536E95f7f", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "51A6ef70Be920b7E4F80837E", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "b4411d5cA6d11a3a2c89DB6B", "name": "aute qui id commodo et", "description": "A user-defined object to help group documents." }, { "_id": "926EbC69CDCadCCd7ac24a2d", "name": "amet adipisicing dolore commodo aliqua", "description": "A user-defined object to help group documents." }, { "_id": "EF2d3b48ABd5fDb4C321f592", "name": "ut nulla", "description": "A user-defined object to help group documents." }, { "_id": "Bf93eEE20AB8aed8FEaBA086", "name": "dolor in ea", "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": "bce5C1c56F5DD462aa8D14AA", "createdBy": "FcF5CBAF5c2DdE2131D056BE", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "Ff0b9828acc79df1faC2e76A", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "7F75ADEac4d3E62a56Be7B0b", "name": "labore enim", "description": "A user-defined object to help group documents." }, { "_id": "D6a8Be4AaF1619691B5cfe2a", "name": "Lorem nostrud id", "description": "A user-defined object to help group documents." }, { "_id": "a52Ff9BcfCd791F06b8CefFF", "name": "dolore sunt Lorem", "description": "A user-defined object to help group documents." }, { "_id": "6dd8AfbcDAbC40B3A6c51A1e", "name": "officia 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": "bf39fDdEd17B46E7ba8F58bA", "createdBy": "E5cFeC6E9b92e8E0ba415CEc", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "2B1a1773DF720cd592A5ACDf", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "413FBD13ADCdfc4ABc3cDfC9", "name": "eu laborum est", "description": "A user-defined object to help group documents." }, { "_id": "A25B4B93d2Df44aD04AC78CA", "name": "ad eu ut dolor consectetur", "description": "A user-defined object to help group documents." }, { "_id": "F6a9A98Ff26A17803ea649db", "name": "veniam", "description": "A user-defined object to help group documents." }, { "_id": "CCdB11f81CAc636759Dbbb85", "name": "commodo Excepteur Lorem", "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": "96ffEF0feA7dFF126baD5f06", "createdBy": "09f74E0Ea7202D86e0dA7dD3", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "29E09AB4c95aA7b4faF2a9a2", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "B5B2e73248FaA46ECBc2bdD5", "name": "nisi mollit consequat", "description": "A user-defined object to help group documents." }, { "_id": "4cCEE9a7Cf08491bC9f142dC", "name": "qui occaecat", "description": "A user-defined object to help group documents." }, { "_id": "cCB068BC87eAaB8b75AC4ac9", "name": "Excepteur laborum ut dolor ullamco", "description": "A user-defined object to help group documents." }, { "_id": "6ab7eF54cA79D8743B244Fb2", "name": "commodo dolor", "description": "A user-defined object to help group documents." }, { "_id": "cDC76dFa8D34aD7Bdfc0eFD9", "name": "veniam 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": "140ddB3AeFc832cAE8D5C2d4", "createdBy": "2f5DF79773FD0393fDe27E2E", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "Bb2C7cca6a95C15fFF039Caf", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "72cb47E025c16F8C2eF0aFcE", "name": "minim", "description": "A user-defined object to help group documents." } ] } ], "total": 44406709, "start": 29920567, "end": 87204717, "count": 18819316, "next": "ullamco", "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." } } }