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,description", "exclude": "description", "in": { "_id": "laboris aute", "name": "commodo tempor ipsum sit", "group": "nostrud Ut laboris", "command": "in ex fugiat", "description": "sint exercitation", "template": "ullamco consectetur amet aliqua exercitation", "data": "sint Duis", "type": "ut pariatur in minim", "createdBy": "aute Lorem sed", "created": "commodo", "lastModifiedBy": "enim", "lastUpdated": "reprehenderit velit" }, "not-in": { "_id": "nulla adipisicing", "name": "ut ut officia magna", "group": "adipisicing elit quis laboris", "command": "culpa", "description": "proident fugiat Lorem", "template": "et pariatur", "data": "est adipisicing dolore", "type": "fugiat", "createdBy": "dolor qui sint", "created": "consequat laborum Ut", "lastModifiedBy": "eu sunt enim id", "lastUpdated": "in eu exercitation" }, "equals": { "_id": "consectetur labore", "name": "Ut eu", "group": "ea", "command": "veniam culpa minim irure est", "description": "officia dolor do dolor velit", "template": "sunt Lorem laboris nulla", "data": "nostrud exercitation reprehenderit adipisicing", "type": "esse mollit nulla sed amet", "createdBy": "qui id", "created": "velit eu", "lastModifiedBy": "aliqua", "lastUpdated": "cillum est labore ut nostrud" }, "contains": { "_id": "non sint eu culpa adipisicing", "name": "magna aute", "group": "officia", "command": "nisi Duis irure", "description": "laboris elit", "template": "tempor", "data": "est sint aliqua", "type": "amet dolore esse", "createdBy": "ex commodo in esse qui", "created": "esse aliquip consequat", "lastModifiedBy": "laborum tempor id", "lastUpdated": "ullamco ea tempor in veniam" }, "starts-with": { "_id": "cillum", "name": "sint do ut occaecat exercitation", "group": "ex incididunt in", "command": "enim ex Excepteur mollit sint", "description": "pariatur in eiusmod labore cillum", "template": "amet nisi", "data": "eu fugiat", "type": "minim in", "createdBy": "Duis Lorem", "created": "do pariatur anim incididunt", "lastModifiedBy": "reprehenderit ut irure", "lastUpdated": "veniam et ullamco" }, "ends-with": { "_id": "minim et", "name": "ut", "group": "amet mollit", "command": "dolore fugiat sint Excepteur magna", "description": "velit Ut aliquip nulla ipsum", "template": "nulla ipsum in officia", "data": "Ut voluptate", "type": "Ut", "createdBy": "irure adipisicing do ad aute", "created": "cillum ullamco magna", "lastModifiedBy": "elit mollit exercitation ex", "lastUpdated": "sunt consectetur mollit" } } }
{ "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": "986Ead64Da4De8e9F5eDf88D", "createdBy": "4B62F4cD3d9edAAFeeEaf145", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "eCAC0ecFB28aa4Df6a4bfF4b", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1 }, { "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": "d06c6FDFE18C2d82a165B9B8", "createdBy": "d3BBAA36A88C4af96B6C28c0", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "c8EbaA55CCB4e05588Ece778", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1 } ], "total": 38356356, "start": -58256701, "end": 22934531, "count": -65013958, "next": "in", "previous": "amet nostrud aliquip consequat" }
{ "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." } } }