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,description", "in": "fugiat exercitation do in qui", "not-in": "enim", "equals": "ullamco qui exercitation eiusmod sunt", "contains": "nulla proident incididunt amet", "starts-with": "sed", "ends-with": "nostrud tempor sunt" } }
{ "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", "type": "string" }, "not-in": { "description": "Search for fields not exactly matching one of the given list options", "type": "string" }, "equals": { "description": "Returns results where the specified fields exactly match the given match string(s).", "type": "string" }, "contains": { "description": "Returns results where the specified fields contain the given match string(s).", "type": "string" }, "starts-with": { "description": "Returns results where the specified fields start with the given match string(s).", "type": "string" }, "ends-with": { "description": "Returns results where the specified fields end in the given match string(s).", "type": "string" } } } }, "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": "6aa5A6bD7F94D8da6eaf5e5D", "createdBy": "5d9Cff6Afae7ABcD6252CFE6", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "f57D1fEB131Fcf4dFa86bC49", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "cf5ff7cA0ceAfd1Ac956eAcC", "name": "incididunt", "description": "A user-defined object to help group documents." }, { "_id": "6aAa052FaCEd582e1e19bF9C", "name": "nulla", "description": "A user-defined object to help group documents." }, { "_id": "e0a3CCa24fFa991bA70a2D0e", "name": "adipisicing laboris dolore", "description": "A user-defined object to help group documents." } ] }, { "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": "6cb035f1D0c9ccbf4C8ca01f", "createdBy": "2792fACFce55eFfAa18cae3F", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "D990bC49eEA9CABBCC29d87E", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "B042ED4d444eedb03c1aaBAf", "name": "ut amet sit non", "description": "A user-defined object to help group documents." }, { "_id": "1FcDDAe3e5fE475f1FE363B6", "name": "ipsum culpa deserunt", "description": "A user-defined object to help group documents." }, { "_id": "398aC9303Fb0a9D9Cbd7Cd86", "name": "commodo ex dolor do", "description": "A user-defined object to help group documents." }, { "_id": "Fe4AF27BC1ebf1F45A6D5C5C", "name": "cillum do reprehenderit mollit", "description": "A user-defined object to help group documents." }, { "_id": "5E2552303b7E711D6002ed7F", "name": "ipsum", "description": "A user-defined object to help group documents." } ] }, { "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": "C38c2C22ec8Bd0bc62bE42cf", "createdBy": "4068a2DaaF1AfA8FA249300d", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "dBbb5Ec7dF24a7AbeABBECBF", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "2bcf9Ef8188ad112181D560F", "name": "officia", "description": "A user-defined object to help group documents." }, { "_id": "4e419CDBcc3FF8CaDE697f8e", "name": "occaecat amet cillum nulla voluptate", "description": "A user-defined object to help group documents." }, { "_id": "4aabe968AFaBCdF4Ef7Eff49", "name": "ea", "description": "A user-defined object to help group documents." } ] } ], "total": 58994041, "start": -15443893, "end": 96109883, "count": -15960619, "next": "consectetur", "previous": "sint magna 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." } } }