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": 25, "skip": 10, "order": 1, "sort": "name", "exclude-project-members": false, "include": "description", "exclude": "_id", "in": "Excepteur commodo cupidatat consectetur", "not-in": "non magna nisi dolore", "equals": "cillum", "contains": "magna in incididunt nostrud esse", "starts-with": "reprehenderit eu dolore proident", "ends-with": "Excepteur nulla quis consequat" } }
{ "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": "44Ac6a78A849F5B9cddA254a", "namespace": { "type": "project", "name": "mollit dolore exercitation aute", "accessControl": { "read": [ "esse incididunt anim", "laborum ut culpa", "proident quis" ], "write": [ "irure culpa nostrud proident sunt", "nulla incididunt exercitation consequat", "nulla", "sed" ], "execute": [ "adipisicing", "anim tempor sunt aliqua laboris", "Ut culpa in", "id minim anim" ], "manage": [ "consequat cupidatat reprehenderit", "dolor ad quis" ] } }, "createdBy": "2878bb5eB17083BBeBCc2DCc", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "eFCe82dFdf578EDA11D297a8", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "6b9fc5fBb9e1f86CE24FdcD8", "name": "dolore veniam laborum" }, { "_id": "Ac9d71609A6362aF11Ebd812", "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": "E1abECaB70D1CdDdC09c3d40", "namespace": { "type": "project", "name": "Excepteur sint in", "accessControl": { "read": [ "Lorem sunt", "Duis culpa qui" ], "write": [ "deserunt", "in Excepteur dolor", "dolore dolore Ut veniam", "culpa consequat dolore ut sed" ], "execute": [ "sint consequat ut id", "Duis laborum amet aliquip", "aliqua enim officia" ], "manage": [ "voluptate" ] } }, "createdBy": "eb3cc2c2aFF3B1B2f3acFd3f", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "38Edb8c4F1Bc0D26313cBD0e", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "2B7D60eea0F2B15D1BfcF9E3", "name": "deserunt in cillum ut ad" } ] } ], "total": 37719519, "start": 28281278, "end": -97833203, "count": 88784012, "next": null, "previous": "ullamco qui anim in eiusmod" }
{ "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" } ] } } }