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": 1, "skip": 0, "order": 1, "sort": "name", "exclude-project-members": true, "include": "name,description", "exclude": "_id,description", "in": "veniam in", "not-in": "eiusmod amet culpa anim proident", "equals": "veniam aliqua mollit cillum", "contains": "aute proident deserunt dolore", "starts-with": "commodo et incididunt irure", "ends-with": "sunt eu esse dolor sed" } }
{ "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": "f8bAa17c1D3bFbec95e3ced6", "namespace": { "type": "project", "name": "eiusmod enim commodo pariatur", "accessControl": { "read": [ "incididunt Ut consectetur", "quis dolore id tempor", "sed ut do commodo", "occaecat nisi aliquip", "cillum Ut in" ], "write": [ "irure nisi esse", "dolor enim dolor esse", "Lorem eu incididunt" ], "execute": [ "eiusmod aliquip culpa", "incididunt proident" ], "manage": [ "est ea occaecat quis", "enim Lorem", "culpa pariatur aliquip magna", "aute", "non Excepteur ut dolor" ] } }, "createdBy": "BeD0c3AFaE5DaD2Ee2a6F8a9", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "8e94BfdAC0d7acddd46faeB9", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "ECC7B8AfDedaD02A7C46d001", "name": "magna commodo Lorem sed" }, { "_id": "72dDCd7Fd3eE0B2AbADe398B", "name": "proident" }, { "_id": "Fd7CbDFFA2dD90057eC5e3c7", "name": "Ut" }, { "_id": "dAEe2dDEca5DDb65A5b8E3Ea", "name": "do occaecat reprehenderit" }, { "_id": "CDa7f381effb3B7d83ffC08b", "name": "nulla irure ipsum" } ] }, { "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": "fAa10D31C72f1F3EeB8CC76e", "namespace": { "type": "project", "name": "quis velit irure sed", "accessControl": { "read": [ "consectetur", "minim irure ullamco nulla", "elit commodo anim occaecat cupidatat", "cupidatat" ], "write": [ "Duis Excepteur nulla nostrud Lorem" ], "execute": [ "mollit commodo esse Duis" ], "manage": [ "id" ] } }, "createdBy": "91CfbBE96BaACd8EfdCBAd10", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "008D37c39e58FaCaFD1A6349", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "affc3A91F4d5aBFDCAD6aBfb", "name": "ullamco mollit culpa sint" }, { "_id": "cDE1ad141e3c0e4FD2AAeb16", "name": "in sit" }, { "_id": "D74718E1acab15568DB3bE22", "name": "in ex exercitation" }, { "_id": "aC7f19d33FFB3b0aD3DEA1C0", "name": "dolor minim id pariatur deserunt" }, { "_id": "Ba5EDadbc1D0b2AeEaa81EbE", "name": "velit tempor consectetur labore" } ] }, { "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": "c2ba604eae6eA02cD989fD58", "namespace": { "type": "project", "name": "ad Excepteur", "accessControl": { "read": [ "sed sunt aute occaecat", "pariatur" ], "write": [ "incididunt ullamco id", "fugiat consectetur" ], "execute": [ "nisi", "irure", "velit", "proident elit culpa fugiat dolor" ], "manage": [ "sint cupidatat", "labore officia", "aliquip dolor" ] } }, "createdBy": "773ADd4735b3A5AeF734Bb92", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "F7eE6d8287e01A7e75CDA46C", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "ae0DbD9DBB4A40e52574e8D5", "name": "Lorem et id quis ad" }, { "_id": "aeAd62EFF96d7fBef63Faae2", "name": "commodo exercitation aute eiusmod reprehenderit" }, { "_id": "baA2ffEAB70f6CD59f74a42f", "name": "elit cupidatat Excepteur sint laborum" }, { "_id": "d0bf7AEAA247f8FDAcc5eD01", "name": "velit reprehenderit ullamco" }, { "_id": "B6f7208ab12882adf2379dbc", "name": "quis Lorem" } ] } ], "total": 72335840, "start": -95094552, "end": 16188607, "count": -69283365, "next": null, "previous": "nisi esse ipsum" }
{ "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" } ] } } }