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": 0, "order": 1, "sort": "name", "include": "description", "exclude": "_id", "in": "laborum tempor", "not-in": "Excepteur eu consequat voluptate esse", "equals": "minim ut elit", "contains": "magna", "starts-with": "adipisicing in", "ends-with": "sed" } }
{ "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": "EF128feD41Dbc72946Fde71A", "createdBy": "cE95Ba2FB4f4bBd1779cfBde", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "FDC0dD0ccFC26Fd8c4009Afe", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "E4a154A2A2e53Ae141Fc1ffa", "name": "exercitation dolore fugiat sit deserunt" } ] }, { "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": "6CaDc304660FB5E34e9CEFC8", "createdBy": "B9fEfdBdEcc8bFe349d57b8c", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "5DE649C2E4b044af65FCfe8F", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "DfB7FCbC07fbF0e1ccaf2c14", "name": "irure enim sint ex" }, { "_id": "b70Fbe8CFe07C04AE40dA6Cf", "name": "velit cillum" }, { "_id": "e63aaDb1cBFbaEc8AFd42221", "name": "nostrud pariatur proident" }, { "_id": "180d8F03187Ef5EBb54bAFf2", "name": "ut quis est enim dolor" } ] }, { "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": "f10C8eafF3ECf3125FAf8d69", "createdBy": "371044CF147F28EddebAba45", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "6ee8afDa15Cb71dF1AB6A6D3", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "7cAb1AAa1cA1b4EAf1d51D4f", "name": "dolor aute sed" }, { "_id": "825ebe5a0838578fE8D383fa", "name": "enim nostrud ullamco fugiat dolore" }, { "_id": "c62e7De4aEa80FA7c0Fa6c1a", "name": "aliquip nisi sit laborum" }, { "_id": "f1bBf0aec7f2Ba58C47CeBFa", "name": "in ullamco ea mollit proident" } ] }, { "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": "491d58BA25bE7fd3ddC7f6F5", "createdBy": "7Bbb4EbDAbaA35D24cC4CC7c", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "a3DE3F2b760C023eFcecacFf", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "97d051F88e00Aa7FDaEa07D0", "name": "velit sit ad dolor aliquip" }, { "_id": "1bDf59A9bb65cE5aBcBE3FD5", "name": "ad" }, { "_id": "e0bc3b9F7a5BA02dDD35EDbC", "name": "voluptate id do cillum" }, { "_id": "ef52D4D8dDAA85B41aA5bC4e", "name": "cupidatat id sed" } ] } ], "total": -80982968, "start": -63369699, "end": 65240342, "count": 72447924, "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": { "description": "URI pointing to the next set of paginated results. Preserves previous search and projection parameters. Null if returning the last page of results.", "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "previous": { "description": "URI pointing to the previous set of paginated results. Preserves previous search and projection parameters. Null if returning the first page of results.", "oneOf": [ { "type": "string" }, { "type": "null" } ] } } }