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": 10, "order": 1, "sort": "name", "include": "name", "exclude": "_id", "in": { "_id": "est", "name": "elit deserunt id tempor", "group": "non sit", "command": "dolore dolor id velit aute", "description": "reprehenderit culpa officia", "template": "id ut quis Lorem in", "data": "dolore ut ut dolore irure", "type": "sit aute pariatur ea", "createdBy": "in velit Excepteur est aliquip", "created": "culpa ad ut", "lastModifiedBy": "elit", "lastUpdated": "proident" }, "not-in": { "_id": "cupidatat", "name": "ex", "group": "ea irure", "command": "sunt pariatur", "description": "adipisicing in in", "template": "aliqua ea non cupidatat", "data": "mollit veniam cupidatat ad", "type": "sunt fugiat culpa ea ullamco", "createdBy": "tempor aute dolore mollit proident", "created": "dolore nostrud Excepteur in", "lastModifiedBy": "ipsum consequat dolor", "lastUpdated": "do pariatur laborum in sed" }, "equals": { "_id": "nostrud fugiat", "name": "dolor esse officia occaecat", "group": "exercitation occaecat dolor mollit", "command": "commodo", "description": "dolore", "template": "ut", "data": "do ut", "type": "cupidatat id", "createdBy": "mollit voluptate", "created": "id nulla minim adipisicing nisi", "lastModifiedBy": "sunt consectetur dolore", "lastUpdated": "Duis Lorem" }, "contains": { "_id": "adipisicing pariatur id ullamco", "name": "dolor velit nostrud", "group": "pariatur", "command": "magna cupidatat nulla voluptate eiusmod", "description": "do culpa aliqua", "template": "elit enim ullamco cupidatat", "data": "ex adipisicing", "type": "Lorem cillum ex adipisicing", "createdBy": "exercitation", "created": "est irure", "lastModifiedBy": "voluptate id exercitation nostrud", "lastUpdated": "mollit veniam" }, "starts-with": { "_id": "veniam labore in voluptate fugiat", "name": "sed", "group": "labore occaecat sint", "command": "id est elit", "description": "nostrud", "template": "dolore irure fugiat commodo", "data": "Lorem ipsum tempor consectetur fugiat", "type": "esse sunt", "createdBy": "cillum Lorem non", "created": "consectetur laborum cupidatat", "lastModifiedBy": "ex", "lastUpdated": "nulla" }, "ends-with": { "_id": "dolore tempor enim proident", "name": "proident commodo quis reprehenderit minim", "group": "ea consequat", "command": "et", "description": "anim cupidatat in reprehenderit sit", "template": "incididunt", "data": "ea velit adipisicing Excepteur", "type": "adipisicing Duis in", "createdBy": "nisi dolor culpa veniam", "created": "sunt cupidatat tempor ad", "lastModifiedBy": "dolor occaecat adipisicing culpa ea", "lastUpdated": "laborum reprehenderit dolor" } } }
{ "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": "b4Ad2Fed9A8a5c2CafdeaC0f", "createdBy": "ccef5467E8C10918ba24Ea4d", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "f0E566211DADecad6f8FE54E", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1 } ], "total": -28048027, "start": 53603182, "end": -15736675, "count": -79479559, "next": "qui in do ipsum magna", "previous": "velit adipisicing 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." } } }