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": "name,description", "exclude": "description", "in": "nisi proident", "not-in": "minim ea veniam officia", "equals": "tempor ipsum", "contains": "ullamco sunt Lorem", "starts-with": "exercitation", "ends-with": "esse est ullamco occaecat" } }
{ "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": "b2F23c3E15a3AC3D02279eDf", "createdBy": "Ac42DBF38fBbED1CD20e6FaB", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "d214C7Ff658DceE2E5e5D234", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "0dAD6Bf28FEc7fb2064fb0c1", "name": "est", "description": "A user-defined object to help group documents." }, { "_id": "4D2ad04A8D36dB8ee650d25A", "name": "nisi velit Ut", "description": "A user-defined object to help group documents." }, { "_id": "AdEfbB56cB2E9bd30BaEAd7f", "name": "adipisicing", "description": "A user-defined object to help group documents." }, { "_id": "E37ad6cc0b5F24a0Dd7CBA6d", "name": "ad ut Ut", "description": "A user-defined object to help group documents." }, { "_id": "86Baa762A12CfaD098De28b9", "name": "qui ullamco", "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": "6fF4dA51A7E8Cf1fcB98fECa", "createdBy": "0C96B0cb3fCE9DEA90D5F1b9", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "378e5634A285777Be3bD5cC5", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "6Ac6eb96C66f8fa5E71cFCf1", "name": "laboris magna elit", "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": "Eb2Ae5F8C5fC73c4dD2A952c", "createdBy": "2CeDa415Bd7Eb2B39ae89bae", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "29A2739ceE0caa41Ff92EAec", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "Dcf6d5e96ef2C78F1DeAbade", "name": "reprehenderit", "description": "A user-defined object to help group documents." }, { "_id": "52Ec3B9Ec37aE9077b6A7c5F", "name": "irure amet fugiat Duis", "description": "A user-defined object to help group documents." }, { "_id": "4ed7d2D2F4bBC8C7a3F5E8dE", "name": "mollit", "description": "A user-defined object to help group documents." }, { "_id": "c106dAc9fdC33b0c8BaFDBC5", "name": "est", "description": "A user-defined object to help group documents." }, { "_id": "f60D8d57Da8Ead62Be70b0aE", "name": "qui dolore proident", "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": "50aA4Ca1C3BCd4FfCB2de4ff", "createdBy": "fda3a93Ea9a4adffDB58Fdfb", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "c723AFFeE00eCdcfd580859B", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "2094df4c3245dd9A7eBbEA7E", "name": "fugiat Duis aute", "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": "3DDfbD28f5E3438fec8dC76c", "createdBy": "4BD35964cEaEc151AE4cAecF", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "B1eFa88D3ac97C5D14B6Cd64", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "08BFe1fD09d3FB7dd90fEABD", "name": "non exercitation eu ipsum Excepteur", "description": "A user-defined object to help group documents." }, { "_id": "90f5e26B2eBdeeDE9173EA37", "name": "ex occaecat Ut", "description": "A user-defined object to help group documents." }, { "_id": "f0E8cF6Bc1A9301b881A6Bc6", "name": "exercitation eu in quis", "description": "A user-defined object to help group documents." }, { "_id": "16b393EBccCc282e6C3B817e", "name": "exercitation laborum in occaecat elit", "description": "A user-defined object to help group documents." } ] } ], "total": -83563482, "start": -49696973, "end": -65126944, "count": -34888114, "next": "in fugiat", "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." } } }