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": 50, "order": 1, "sort": "name", "exclude-project-members": true, "include": "description", "exclude": "_id,description", "in": "consequat voluptate sed eiusmod", "not-in": "sit", "equals": "dolor do consectetur deserunt", "contains": "veniam dolor", "starts-with": "elit enim est", "ends-with": "cillum" } }
{ "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": "2f96B76742eAefeb27fA7C43", "namespace": { "type": "project", "name": "qui sint dolor sit", "accessControl": { "read": [ "consequat anim", "Duis dolore", "magna sint et exercitation ad", "ipsum dolor" ], "write": [ "ipsum" ], "execute": [ "adipisicing consequat sit", "elit" ], "manage": [ "et magna", "sint tempor deserunt veniam", "est nulla cupidatat commodo", "officia" ] } }, "createdBy": "ABc6eaA7A71D90Dabf56c213", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "5FDEc213beab0BbeA5b4e9C6", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "09e84e43dFA2b63bFAB8dBa7", "name": "proident aute" }, { "_id": "c0DDdB7dC15CB59aC0A608F9", "name": "exercitation quis" }, { "_id": "4eCFDDCadb9541c518925f5D", "name": "consequat qui" }, { "_id": "5d52fccC7b1f9b260B50fdaf", "name": "tempor dolore laboris" } ] }, { "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": "A7AeAE896d36DDd8ed9DcDcA", "namespace": { "type": "project", "name": "commodo voluptate aliqua cillum", "accessControl": { "read": [ "sint", "pariatur ullamco nisi", "consectetur dolore do officia" ], "write": [ "esse anim exercitation dolor" ], "execute": [ "ad ex" ], "manage": [ "voluptate dolore ut aliquip" ] } }, "createdBy": "dfCFDCCEaDc7aBddE2905Cc9", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "8d2Cb99401E8aCeeab6bDc4A", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "f6C6bee996bDfDa724f9Ebfc", "name": "voluptate sint" }, { "_id": "5bB01E6b790Fd6b06AdFbbCc", "name": "id occaecat officia" }, { "_id": "9E2372C63DCf75dB2EA79Aa0", "name": "ea" }, { "_id": "A6DF59ebe1588aAbCdAfd9Ea", "name": "ea" } ] } ], "total": 36122784, "start": 4524352, "end": 14652955, "count": 46646271, "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" } ] } } }