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": 10, "order": 1, "sort": "name", "exclude-project-members": false, "include": "name", "exclude": "_id,description", "in": "eiusmod deserunt", "not-in": "tempor Duis eu proident", "equals": "aute aliquip reprehenderit", "contains": "in", "starts-with": "incididunt", "ends-with": "ad" } }
{ "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": "C9e6e0cD0c8E73BcE51cDA89", "namespace": { "type": "project", "name": "quis in do cillum", "accessControl": { "read": [ "id ad consectetur mollit laborum", "Ut occaecat", "in mollit", "dolor voluptate" ], "write": [ "eiusmod deserunt dolore ullamco", "Excepteur aliqua minim", "sit" ], "execute": [ "laboris nulla" ], "manage": [ "aute" ] } }, "createdBy": "DCDFBf617A76000e1F9E3EAC", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "47b904c40F6Dd07AcAb7D203", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "fdfcfeefF6cbd6aEBF966E5f", "name": "cupidatat sed culpa dolor" }, { "_id": "80B176a5f42998e4d42C1FFC", "name": "consequat" } ] }, { "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": "D15e3E2AF644EDd4e4E6fbbd", "namespace": { "type": "project", "name": "aliquip dolore ut", "accessControl": { "read": [ "cillum ut", "non incididunt ad", "et aliquip veniam culpa tempor", "non", "ut occaecat magna" ], "write": [ "dolore", "aute", "ipsum nisi Ut", "elit esse id eiusmod ea" ], "execute": [ "amet labore est consectetur reprehenderit", "quis", "ea cillum est eiusmod exercitation", "officia in minim" ], "manage": [ "dolor", "dolor Excepteur culpa sit", "incididunt commodo in labore magna", "Excepteur nostrud", "et velit amet minim sit" ] } }, "createdBy": "0F0f0b4dCa251C1F35c1F95A", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "cde9A8B6DfD62BfbCbFaBcbC", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "9a9B97e167a75D4d1DbffE64", "name": "do" }, { "_id": "74fdd6e9D26A01c7BBbC4B09", "name": "Lorem voluptate veniam minim in" }, { "_id": "c9EBD9aDfff86BF99fae2d92", "name": "sit fugiat proident voluptate" }, { "_id": "AFB649eeDbA4fab6783B77a4", "name": "reprehenderit dolore aliquip ad exercitation" }, { "_id": "7996d2c9F89Dc3daEF0A9954", "name": "aliqua et ullamco in" } ] }, { "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": "d4CEa8d6CdC55eBaCc2Dd5B5", "namespace": { "type": "project", "name": "culpa", "accessControl": { "read": [ "qui", "nisi ad qui occaecat", "Lorem", "voluptate consequat" ], "write": [ "eiusmod", "ipsum consequat ex", "eu" ], "execute": [ "veniam nisi", "cupidatat nulla", "magna sed dolor mollit" ], "manage": [ "Lorem ullamco" ] } }, "createdBy": "bfC3bEA3B592f214e91596EF", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "3C18785b8bf252dE9e4fc9aD", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "58bAeac72e3Dee966cE9186B", "name": "Duis" } ] } ], "total": 8492514, "start": 50110778, "end": 88962526, "count": -41137355, "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" } ] } } }