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": false, "include": "name,description", "exclude": "_id,description", "in": "mollit laboris", "not-in": "sint ut Ut sit esse", "equals": "sint consectetur ut", "contains": "occaecat do ex ut cillum", "starts-with": "sint sit in nulla", "ends-with": "dolore incididunt sunt non" } }
{ "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": "AECBAA712f0bde0EBFeAc161", "namespace": { "type": "project", "name": "officia", "accessControl": { "read": [ "adipisicing nulla nisi Ut anim", "sed amet", "fugiat exercitation" ], "write": [ "ad do consequat nisi", "enim nisi", "veniam in in", "proident sunt qui magna" ], "execute": [ "amet consectetur laboris Duis enim", "aliqua mollit" ], "manage": [ "ipsum ea" ] } }, "createdBy": "F1a09Ac6B35AEba452edB0E0", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "DB12AF7CEfDceDfd5e35B001", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "0627E2A42C83b04790bBFDee", "name": "fugiat" }, { "_id": "e13f6C75Fa570540B6c2BfDE", "name": "voluptate commodo minim laboris" }, { "_id": "DaAfeeD80CDbaCB59d1C80B1", "name": "incididunt" }, { "_id": "2e3f4483D60445BbDDd90048", "name": "sunt mollit est deserunt ad" } ] }, { "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": "D5Ec82Eeff0E92d8B73eCa40", "namespace": { "type": "project", "name": "anim magna dolore", "accessControl": { "read": [ "nostrud", "proident" ], "write": [ "magna", "ex in quis", "id est dolore", "in aute pariatur" ], "execute": [ "velit sint mollit culpa tempor", "sed", "proident" ], "manage": [ "proident irure magna amet", "ex", "sint non", "in minim" ] } }, "createdBy": "98FD6C05e9F2A1d2A52a25eC", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "5D041a09d1dBcE46bBC001D4", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "Bb9FaAAbCF1Ee6d592cf3F77", "name": "aliquip" }, { "_id": "Ece7B1E2bDCbBEeeAFbeeE47", "name": "deserunt quis Excepteur est" }, { "_id": "FD47d3caAEc509AB4C00DC5e", "name": "aliqua" } ] } ], "total": 18988833, "start": 9810423, "end": -9344876, "count": -91744880, "next": "quis", "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" } ] } } }