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": 1, "order": 1, "sort": "name", "exclude-project-members": true, "include": "description", "exclude": "_id", "in": "qui", "not-in": "deserunt commodo", "equals": "non qui", "contains": "occaecat nostrud", "starts-with": "nostrud", "ends-with": "et id nisi" } }
{ "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" ] }, "exclude-project-members": { "type": "boolean", "description": "Flag which removes workflows from the results which are members of a project" }, "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": "B2B61b8868425E1b475a6C6D", "namespace": { "type": "project", "name": "quis proident enim Ut", "accessControl": { "read": [ "quis laborum in nulla", "et laborum quis", "officia", "esse occaecat elit", "sint dolor et magna commodo" ], "write": [ "consequat aute sunt veniam ut", "in aute esse incididunt", "nulla quis eiusmod voluptate", "Excepteur ex sit" ], "execute": [ "et exercitation laboris ea enim", "ut pariatur ullamco dolor" ], "manage": [ "aute ex Excepteur", "non", "ipsum commodo aliquip anim velit", "aute officia ex in" ] } }, "createdBy": "Cfb1AfdBDf68f2Ebc3ceab0D", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "9DCf14D6987AFf19ECADF7EF", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "F3fD3dEffc1e52182Df64FB7", "name": "et Ut" }, { "_id": "8Fd9c539Fa52dFeDCdCD6e96", "name": "dolore quis Lorem enim incididunt" }, { "_id": "00FE63aFBD36BdC930B9cf07", "name": "Excepteur anim exercitation" }, { "_id": "91d65B95D9E52D5AadAcdAC0", "name": "in aliquip proident exercitation commodo" }, { "_id": "bFcdf94ee0C9Af6Bf7C59A2c", "name": "et id officia sint dolore" } ] }, { "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": "2aae2e01EaEA519885ee7c9a", "namespace": { "type": "project", "name": "qui", "accessControl": { "read": [ "culpa", "mollit" ], "write": [ "labore Ut aute", "sit Ut nulla" ], "execute": [ "irure Lorem nostrud", "ut Ut" ], "manage": [ "occaecat dolore laborum dolore ex", "in officia reprehenderit ex elit", "anim cupidatat ullamco sunt", "reprehenderit cupidatat labore", "dolore consectetur nisi dolore" ] } }, "createdBy": "8dBE82a4f08D431AbD9F7a2e", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "bb9AAF3C0bEFE898dBBCacD1", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "8F23eF8bf63a236abaA9eAAf", "name": "nostrud nulla aute" }, { "_id": "7c5cC2fef0FC1fA07D4C35E3", "name": "irure eiusmod dolore" }, { "_id": "3bBFCfaB13af05837E8FD2C8", "name": "id deserunt anim ut" }, { "_id": "3ce7D7F27A57f92dB2AA714D", "name": "Lorem sint consectetur et" }, { "_id": "9E2caAfa25a11a8f9F18c8E2", "name": "dolor tempor cupidatat Duis" } ] } ], "total": 67224786, "start": 44286060, "end": -5229662, "count": -87641697, "next": "Ut", "previous": null }
{ "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": { "description": "URI pointing to the next set of paginated results. Preserves previous search and projection parameters. Null if returning the last page of results.", "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "previous": { "description": "URI pointing to the previous set of paginated results. Preserves previous search and projection parameters. Null if returning the first page of results.", "oneOf": [ { "type": "string" }, { "type": "null" } ] } } }