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": 1, "order": 1, "sort": "name", "exclude-project-members": false, "include": "name", "exclude": "_id", "in": "ea ad", "not-in": "ex laborum cillum sit minim", "equals": "irure", "contains": "elit quis ad consectetur culpa", "starts-with": "nulla labore cupidatat culpa", "ends-with": "ea reprehenderit" } }
{ "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": "790b2BaFbDB2bDe5d5Aa9eBe", "namespace": { "type": "project", "name": "Ut", "accessControl": { "read": [ "nostrud eu ut amet cupidatat", "in pariatur do", "veniam" ], "write": [ "nisi ipsum incididunt ut", "irure anim", "in veniam voluptate ipsum eu", "eiusmod laborum dolor" ], "execute": [ "proident incididunt ea eiusmod reprehenderit", "non fugiat enim", "fugiat dolor irure mollit eiusmod" ], "manage": [ "aliquip laboris sed officia" ] } }, "createdBy": "Fd2e70eee77Ab4E201C5F8BE", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "6d36e5DAbbEAB2Ca0e1394bb", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "c8F97E7882dC20fBe2effF6b", "name": "Ut ut irure nostrud" }, { "_id": "56Cf2B918bcAfE2A022A4713", "name": "sunt irure" }, { "_id": "c21eb3e10caaaffC8d5388BA", "name": "quis" }, { "_id": "b5cF14e44de93450Eec3fA3a", "name": "dolore veniam qui culpa aute" } ] }, { "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": "ECBB1b3aBcA4c6d8ae4D1DcA", "namespace": { "type": "project", "name": "dolore", "accessControl": { "read": [ "adipisicing ea" ], "write": [ "cupidatat nostrud fugiat eu", "esse minim pariatur in", "qui", "aliqua aliquip officia" ], "execute": [ "labore ut" ], "manage": [ "anim", "non", "voluptate quis", "Excepteur" ] } }, "createdBy": "6AFefb156c9938BC9F26BEbD", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "A6d97E60f46CEBd0EF1393fc", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "D7DBcACFD63eF162f9d703ca", "name": "enim irure veniam" } ] } ], "total": -3959975, "start": 57137874, "end": 18472583, "count": 1678355, "next": "incididunt ut ea", "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" } ] } } }