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": 50, "order": 1, "sort": "name", "include": "name", "exclude": "description", "in": "voluptate consectetur", "not-in": "dolore officia aute Lorem qui", "equals": "culpa Excepteur nostrud", "contains": "id sit aliqua est", "starts-with": "dolor Lorem", "ends-with": "laborum Excepteur consequat" } }
{ "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": "1FEe11B2EbCA130E94bd78b5", "createdBy": "93b6B9DA7d218c1fDD1eBbBc", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "48cBFF919C5d0eec3Ddb8205", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "C9251183a6025E2DC9fD03ba", "name": "deserunt veniam amet", "description": "A user-defined object to help group documents." }, { "_id": "eB2aCC5DAC98179Add0C8D75", "name": "Duis mollit quis dolore", "description": "A user-defined object to help group documents." }, { "_id": "53413f901E7EcAa2b77c68dd", "name": "commodo proident", "description": "A user-defined object to help group documents." }, { "_id": "6f624abfC2e91E2ebDAF20dD", "name": "occaecat Excepteur", "description": "A user-defined object to help group documents." }, { "_id": "d3A77ecAFc5e1eF0c414a71D", "name": "exercitation nisi anim quis do", "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": "2d031Ddc7CdFd8Ae39CaD4d5", "createdBy": "aadeeD1cFfBe0A7cb35Fd48f", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "143aFfCB362faca9B4bCe001", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "87031dbfAB0C7D1Eea90A179", "name": "in dolor", "description": "A user-defined object to help group documents." }, { "_id": "3a932dD18444EB41eca9Efd3", "name": "Ut dolor incididunt cupidatat ex", "description": "A user-defined object to help group documents." }, { "_id": "A42033eAFBBC0a436EebF09f", "name": "non velit nulla commodo do", "description": "A user-defined object to help group documents." }, { "_id": "6d4f7fcBd91cFf0BBa1EbC07", "name": "ad consequat laborum fugiat occaecat", "description": "A user-defined object to help group documents." }, { "_id": "F41A7b7bff0beD5B6beF9BEa", "name": "aliquip culpa in enim Duis", "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": "eD7bbeeceEC7F0DD02fa07D1", "createdBy": "D9B48C26fCCEfe441BdD4eE2", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "59C557be99Fb3Adb33Fa8aD7", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "Caa00b1cDBee84Bdd82f8c01", "name": "anim elit", "description": "A user-defined object to help group documents." }, { "_id": "fffDeDBBf2ebA57531f1d0Ae", "name": "dolore culpa ut aliquip", "description": "A user-defined object to help group documents." } ] } ], "total": 21445013, "start": -5451436, "end": -56631045, "count": -16257545, "next": "do", "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." } } }