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": 10, "order": 1, "sort": "name", "include": "name,description", "exclude": "_id,description", "in": { "_id": "tempor", "name": "officia exercitation labore", "group": "velit", "command": "labore tempor amet magna ut", "description": "ipsum aliqua anim incididunt", "template": "pariatur quis", "data": "ut ex proident exercitation et", "type": "quis", "createdBy": "deserunt non id", "created": "incididunt ullamco occaecat", "lastModifiedBy": "ea amet aute laborum", "lastUpdated": "Ut occaecat veniam ipsum esse" }, "not-in": { "_id": "proident id amet", "name": "sint laborum id culpa ea", "group": "fugiat officia adipisicing velit", "command": "ut labore anim qui consectetur", "description": "velit", "template": "mollit eu incididunt", "data": "do sint incididunt deserunt", "type": "deserunt dolore dolore", "createdBy": "aute", "created": "Excepteur magna", "lastModifiedBy": "est adipisicing dolore", "lastUpdated": "laborum veniam" }, "equals": { "_id": "est aliquip", "name": "sint Excepteur", "group": "id culpa ipsum", "command": "in consequat sit non", "description": "dolor voluptate laboris veniam ut", "template": "ea in", "data": "velit nulla reprehenderit", "type": "nisi enim culpa reprehenderit", "createdBy": "nostrud occaecat anim", "created": "tempor pariatur aute do", "lastModifiedBy": "anim fugiat sint", "lastUpdated": "occaecat voluptate anim Excepteur" }, "contains": { "_id": "nulla in id eu", "name": "eiusmod", "group": "eiusmod et labore cillum mollit", "command": "anim quis", "description": "qui Lorem magna", "template": "reprehenderit in incididunt", "data": "ullamco dolor sed", "type": "dolor anim reprehenderit", "createdBy": "dolore dolore non", "created": "velit incididunt", "lastModifiedBy": "consectetur minim velit laboris culpa", "lastUpdated": "laborum" }, "starts-with": { "_id": "qui", "name": "nostrud dolore in non amet", "group": "laborum laboris elit occaecat", "command": "sint in quis", "description": "Lorem sint", "template": "cillum veniam eiusmod commodo", "data": "in minim nisi laborum consequat", "type": "ullamco ut dolore id occaecat", "createdBy": "veniam", "created": "et id nulla", "lastModifiedBy": "officia dolor reprehenderit aliqua", "lastUpdated": "est" }, "ends-with": { "_id": "ut consequat cupidatat", "name": "sint ut tempor irure fugiat", "group": "fugiat est aute exercitation in", "command": "pariatur dolor exercitation Ut", "description": "dolore in pariatur reprehenderit fugiat", "template": "non ipsum velit", "data": "ullamco culpa do", "type": "tempor velit proident enim consequat", "createdBy": "consectetur", "created": "eu Duis in", "lastModifiedBy": "quis", "lastUpdated": "incididunt aliqua do" } } }
{ "type": "object", "properties": { "queryParameters": { "title": "queryParameters", "type": "object", "additionalProperties": true, "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": "28bc4c6e4eaF111a289Bc4E5", "createdBy": "0BBe97da8BA97ec751FdEC17", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "aca49A1345C7cf0a6CADd1e1", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1 } ], "total": 21626094, "start": -64046256, "end": 32711964, "count": -38937546, "next": null, "previous": "in dolore reprehenderit" }
{ "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." } } }