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", "in": { "_id": "cupidatat et ipsum", "name": "ut incididunt do", "group": "irure incididunt", "command": "anim irure sint", "description": "sit", "template": "dolor aliqua eu", "data": "ex", "type": "laboris", "createdBy": "ex incididunt pariatur in", "created": "incididunt quis Duis culpa laboris", "lastModifiedBy": "sed aute id enim", "lastUpdated": "nisi" }, "not-in": { "_id": "elit cupidatat cillum proident mollit", "name": "consectetur quis", "group": "culpa nulla labore tempor", "command": "in qui", "description": "qui", "template": "eiusmod est fugiat consequat incididunt", "data": "nulla occaecat Lorem", "type": "ullamco do mollit sed consectetur", "createdBy": "voluptate", "created": "minim culpa sunt ut consectetur", "lastModifiedBy": "ullamco mollit", "lastUpdated": "veniam dolore ut sunt" }, "equals": { "_id": "eu enim minim do ut", "name": "labore qui", "group": "et exercitation commodo est in", "command": "Lorem proident cillum", "description": "magna ea", "template": "sunt sint consectetur", "data": "nisi minim in dolor eiusmod", "type": "sint non ad veniam", "createdBy": "sunt", "created": "qui aute ex Duis ullamco", "lastModifiedBy": "minim ipsum nostrud", "lastUpdated": "aliqua laborum" }, "contains": { "_id": "tempor reprehenderit consequat aliqua", "name": "reprehenderit ullamco qui", "group": "quis officia exercitation", "command": "dolor anim", "description": "ut ad culpa ex", "template": "ipsum", "data": "cupidatat elit consectetur ipsum", "type": "elit voluptate", "createdBy": "veniam mollit", "created": "Excepteur aliqua", "lastModifiedBy": "nostrud aute velit dolore Lorem", "lastUpdated": "amet exercitation in" }, "starts-with": { "_id": "tempor pariatur ad", "name": "Duis", "group": "enim minim", "command": "pariatur ipsum occaecat aliqua laborum", "description": "pariatur nisi quis ut ipsum", "template": "do voluptate dolore ut sunt", "data": "aliquip adipisicing sed", "type": "ea", "createdBy": "ullamco fugiat", "created": "dolor exercitation", "lastModifiedBy": "aliquip consequat", "lastUpdated": "exercitation aute Ut in dolore" }, "ends-with": { "_id": "sunt dolore et quis", "name": "cupidatat aliqua elit ullamco adipisicing", "group": "fugiat dolor", "command": "irure deserunt officia", "description": "non elit proident qui dolore", "template": "pariatur eu in in", "data": "Duis velit", "type": "enim qui commodo deserunt aute", "createdBy": "sunt", "created": "eu ea", "lastModifiedBy": "dolore adipisicing deserunt labore", "lastUpdated": "est aliqua qui" } } }
{ "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": "f3A3Fca1bAA82e56DeA4Dde3", "createdBy": "8ae2bE8f0Cef32D5c81e6cF9", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "554d5fDd0Ed14fdC187d3e76", "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": "cae9E1afADC72fa8AD71dFE6", "createdBy": "c929A32C20B6fe9340BEBCb6", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "cb5EE2B8EAB8180253c68F42", "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": "9a5c2c3124edD06E3be8bCf1", "createdBy": "BB3AACbafAd11C321aB73cfc", "created": "2019-11-25T22:51:39.201Z", "lastModifiedBy": "a98FFc7acfba1CbF8B1EddFF", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1 } ], "total": 81959610, "start": -39623942, "end": -87141933, "count": 11427601, "next": "dolor anim", "previous": "minim consequat esse adipisicing tempor" }
{ "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." } } }