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": 25, "skip": 50, "order": 1, "sort": "name", "include": "name", "exclude": "_id,description", "in": { "_id": "est nostrud ea nisi", "name": "aliqua consectetur adipisicing veniam amet", "group": "eu Excepteur nostrud", "command": "sunt exercitation officia quis", "description": "amet in proident dolor elit", "template": "id", "data": "labore in officia id", "type": "Ut sint", "createdBy": "esse dolor elit", "created": "anim consequat ut nulla aliqua", "lastModifiedBy": "nulla veniam ea in in", "lastUpdated": "officia ipsum non enim" }, "not-in": { "_id": "ex do ipsum incididunt veniam", "name": "culpa consectetur esse qui ut", "group": "ea ex", "command": "anim pariatur eu occaecat labore", "description": "esse qui eu in amet", "template": "voluptate sunt in", "data": "ea nostrud consequat", "type": "officia est occaecat sit ex", "createdBy": "tempor dolore sint dolor sunt", "created": "in irure Excepteur pariatur laborum", "lastModifiedBy": "do pariatur laborum sunt", "lastUpdated": "irure" }, "equals": { "_id": "dolor culpa Ut veniam", "name": "nisi non", "group": "nulla mollit consectetur proident", "command": "exercitation dolore ea consectetur deserunt", "description": "ad", "template": "ea cupidatat proident culpa aute", "data": "pariatur tempor aliquip dolor", "type": "elit in sunt", "createdBy": "Ut do", "created": "dolore incididunt ipsum aute", "lastModifiedBy": "deserunt Excepteur", "lastUpdated": "dolore" }, "contains": { "_id": "quis in", "name": "adipisicing", "group": "non culpa", "command": "nulla", "description": "officia consequat", "template": "deserunt labore", "data": "dolore Excepteur veniam voluptate occaecat", "type": "velit sunt aliqua", "createdBy": "enim pariatur dolor eu cillum", "created": "exercitation ut esse", "lastModifiedBy": "anim Duis deserunt esse enim", "lastUpdated": "sit cupidatat do dolor quis" }, "starts-with": { "_id": "tempor ex qui amet ipsum", "name": "commodo Lorem non elit", "group": "dolore voluptate nostrud cillum", "command": "sed", "description": "exercitation aliqua", "template": "adipisicing do non exercitation officia", "data": "ullamco sunt", "type": "aute dolor", "createdBy": "adipisicing veniam dolore in", "created": "esse laborum incididunt", "lastModifiedBy": "officia nulla", "lastUpdated": "exercitation sed" }, "ends-with": { "_id": "do", "name": "Excepteur sint ipsum mollit minim", "group": "irure ipsum non occaecat laboris", "command": "ad nulla id dolor ut", "description": "minim", "template": "fugiat mollit proident ea qui", "data": "eu sunt reprehenderit minim magna", "type": "amet consectetur eu reprehenderit", "createdBy": "non sit dolore sunt amet", "created": "Excepteur", "lastModifiedBy": "exercitation quis magna ad enim", "lastUpdated": "dolor elit ut deserunt aute" } } }
{ "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", "$ref": "template#/definitions/searchableFields" }, "not-in": { "description": "Search for fields not exactly matching one of the given list options", "$ref": "template#/definitions/searchableFields" }, "equals": { "description": "Returns results where the specified fields exactly match the given match string(s).", "$ref": "template#/definitions/searchableFields" }, "contains": { "description": "Returns results where the specified fields contain the given match string(s).", "$ref": "template#/definitions/searchableFields" }, "starts-with": { "description": "Returns results where the specified fields start with the given match string(s).", "$ref": "template#/definitions/searchableFields" }, "ends-with": { "description": "Returns results where the specified fields end in the given match string(s).", "$ref": "template#/definitions/searchableFields" } } } }, "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": "BdFB0acC6ac4dC35BE56AcDF", "createdBy": "671476DBbcDb67dCe397990c", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "Edce6f9DdbECEfD2d8FcB90F", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1 } ], "total": -82489479, "start": 44387748, "end": 40399168, "count": 39849216, "next": null, "previous": "cillum elit" }
{ "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." } } }