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": 1, "order": 1, "sort": "name", "exclude-project-members": true, "include": "name,description", "exclude": "_id,description", "in": "sunt nulla", "not-in": "ea culpa sed incididunt consectetur", "equals": "in", "contains": "elit officia nostrud cillum esse", "starts-with": "dolore", "ends-with": "esse" } }
{ "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": "690d6aF11f1E8f54eFCBea83", "namespace": { "type": "project", "name": "velit adipisicing labore et", "accessControl": { "read": [ "in ipsum laboris id labore" ], "write": [ "irure sint ad est in", "sit Excepteur amet cupidatat id", "dolore ut proident amet aliqua" ], "execute": [ "quis sint", "et", "Duis labore", "occaecat nulla" ], "manage": [ "officia do dolore quis occaecat", "eu et dolor culpa commodo", "velit aliquip pariatur", "cillum dolore proident", "amet" ] } }, "createdBy": "a2DA1aAcFFDcC6a0bBD4d273", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "1A01E0FAfAFfEAb0c36BfCBb", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "DfdFafcfbdFDa3BA4Fdc8a18", "name": "ex nostrud sit ea" }, { "_id": "c63F7527E1EeDFdb5afED85B", "name": "aliqua" } ] }, { "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": "bFB9B5A2f9Aa0BECE5c7DBDc", "namespace": { "type": "project", "name": "aliquip non voluptate", "accessControl": { "read": [ "sunt et qui", "labore", "do Lorem ad" ], "write": [ "aliquip", "nulla in anim enim sunt", "laboris", "deserunt consequat tempor do veniam", "culpa est ad enim nisi" ], "execute": [ "est cupidatat mollit", "magna cillum qui tempor", "Excepteur" ], "manage": [ "enim mollit adipisicing ut sunt", "cupidatat laboris quis", "dolore elit magna incididunt", "minim tempor" ] } }, "createdBy": "EC2a0f984DE20c000fcE0690", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "E9F0a87BBDeaEdCaA9bDaC1b", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "67C50bdf154d7e8B5e4bEF20", "name": "Ut" }, { "_id": "2EFff1520022e0bd47cc72D6", "name": "exercitation aliqua" } ] }, { "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": "c05ABdED72A6ef9C2e98c2e9", "namespace": { "type": "project", "name": "velit ut adipisicing eiusmod", "accessControl": { "read": [ "anim sunt", "Lorem eiusmod sint commodo", "aute ullamco", "cupidatat", "dolor eiusmod amet tempor do" ], "write": [ "adipisicing", "aliqua quis incididunt", "adipisicing enim cupidatat proident", "laborum in minim est" ], "execute": [ "labore cillum in mollit deserunt", "Lorem nisi", "velit ut sit Excepteur", "enim" ], "manage": [ "dolor cupidatat sit labore" ] } }, "createdBy": "D2aD12D1Ab86aAC38Ee856Ae", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "1a7b4A9DeA6dDa1159C02fBE", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "4553cCE9f19c609ba913fBBe", "name": "ut fugiat adipisicing occaecat sit" }, { "_id": "53dBf0D3b67bb54C84E0e8a0", "name": "adipisicing minim aliquip" }, { "_id": "dbb128cE406bF7CDe458bd3b", "name": "enim ipsum tempor Duis" } ] }, { "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": "fAeBE5Afc5bA604c867e0D9A", "namespace": { "type": "project", "name": "mollit veniam", "accessControl": { "read": [ "nulla Duis nisi commodo", "anim sit non proident tempor" ], "write": [ "labore consequat", "occaecat quis tempor eiusmod", "in culpa sunt", "tempor ea minim qui sunt" ], "execute": [ "reprehenderit", "officia dolore", "Duis in Ut" ], "manage": [ "elit", "in dolor non qui", "sunt culpa enim", "do", "Excepteur exercitation in" ] } }, "createdBy": "7eb7afFAfdEd3628f0cC2fE6", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "9d8DdCbE7D3dBcD0AC65adFa", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "3e1679be44081cC39EdFb84C", "name": "elit magna nisi" }, { "_id": "0f3f0cFEeefBECbeF3Ce0E09", "name": "nisi pariatur proident" }, { "_id": "E1dCB8EC9B07dd9CeCCAD854", "name": "magna tempor" }, { "_id": "F1CFd24bAcBFa6edC1CbADFE", "name": "elit" } ] }, { "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": "3aCe25e8f6230Cf1FEBe451a", "namespace": { "type": "project", "name": "irure nostrud", "accessControl": { "read": [ "est ad et in dolore", "aute minim nulla sit labore" ], "write": [ "ipsum amet Lorem labore", "anim amet minim reprehenderit aute" ], "execute": [ "fugiat", "officia magna sit irure", "pariatur officia id", "non tempor ex" ], "manage": [ "voluptate", "do", "adipisicing Lorem elit minim culpa", "exercitation cillum quis mollit", "minim in eiusmod pariatur" ] } }, "createdBy": "33B967c271F6B749d69E9c91", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "0DBb88cC2EF1081b6d0DB3fA", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "59e3A4C9AfCEC462AEF31070", "name": "amet mollit non" }, { "_id": "1Bec30c230DCCdBCfD3CDee8", "name": "ut laboris" }, { "_id": "BA3abbAf1BAFdaAcAE74b9af", "name": "sed est" }, { "_id": "fc83CAd588cD321ce2fAD8aE", "name": "reprehenderit ut" } ] } ], "total": -27192970, "start": -13274467, "end": 58310849, "count": 38689693, "next": null, "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" } ] } } }