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": 50, "order": 1, "sort": "name", "include": "name,description", "exclude": "_id,description", "in": "aliquip fugiat esse nisi in", "not-in": "sed", "equals": "reprehenderit do id", "contains": "cupidatat laboris nisi", "starts-with": "consectetur", "ends-with": "commodo non sint in" } }
{ "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": "d145dCc91bE3d1Af95b7fbf9", "createdBy": "b54FaBFDc9E46c87D0e81bEE", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "cb0fDfC2503eC85eD8986eCf", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "d0f5feEA7eDd14eA5e3a0eDC", "name": "elit" }, { "_id": "AaeE7EDAde6dE600d8e70Da6", "name": "voluptate culpa elit eiusmod esse" }, { "_id": "c594Cd71715E9B6A4CB799B5", "name": "elit pariatur reprehenderit ut nostrud" }, { "_id": "6faFfADbaaef5cD496AE84b1", "name": "pariatur aliquip in nisi non" }, { "_id": "8E26CB98f9b8cEdA32FFFD7e", "name": "veniam ad" } ] }, { "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": "3D5a87fAee4d68c73bC142D1", "createdBy": "dc6a7d5be63d303d5d569cbF", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "39fcef2ea4940DF1BDdca39A", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "Faaaf50F4683c316686ce701", "name": "in tempor elit ad" }, { "_id": "c2D0A3e6473f1EBeFD1DDbaD", "name": "ut" }, { "_id": "72bbbbCa7B1aCBAD9acbF3dC", "name": "consectetur ipsum aliqua elit" } ] }, { "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": "6CEe7e871216E21212B8fC1b", "createdBy": "Daf3DAFEEaef20Cfe71E24e5", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "34D312F7056fAD26BF96Cdf2", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "F3d04d6F9d1d514BEABAD0D6", "name": "est ut sunt nisi reprehenderit" }, { "_id": "77f7C5e977DFfa38b6c7DE6A", "name": "reprehenderit eu ea" }, { "_id": "Ba24b01fCa5115F4c7F65D5A", "name": "occaecat nisi" } ] }, { "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": "68940Ba3e4c6bf810FCd661C", "createdBy": "09D96F5bc7A0AeAdbCd378C2", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "Ad3d3Db1d04045C76Daf997A", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "58eb3DCBEd9E29eB55BC055E", "name": "reprehenderit voluptate" }, { "_id": "6E3B60e8B0FDBe5e0f71EDCd", "name": "cupidatat non cillum mollit pariatur" }, { "_id": "D2BA5cE35C838592Aded66bd", "name": "nisi aliquip enim laboris" }, { "_id": "bCd7bDBDf7fa7f03D35dDe2D", "name": "ex adipisicing non sunt" }, { "_id": "92E5CBccf9ABa2ebcEE00367", "name": "laborum sit" } ] } ], "total": 13852902, "start": -25439014, "end": -18801912, "count": -90727139, "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": { "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" } ] } } }