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": "name,description", "exclude": "_id", "in": "veniam aliqua cillum in aliquip", "not-in": "minim eiusmod ad", "equals": "amet", "contains": "amet cupidatat voluptate", "starts-with": "cupidatat magna ea", "ends-with": "in laboris exercitation" } }
{ "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": "AacDBF5935ed3D14aC0f21ce", "namespace": { "type": "project", "name": "Excepteur est officia", "accessControl": { "read": [ "eiusmod", "est incididunt magna", "elit", "anim in magna", "exercitation ut Excepteur pariatur ipsum" ], "write": [ "ut eu sunt enim dolor" ], "execute": [ "cupidatat qui officia aliquip", "esse", "commodo aliquip adipisicing sed", "nisi dolore laboris" ], "manage": [ "magna tempor", "ea", "amet velit do cupidatat mollit", "laborum", "fugiat Lorem laborum ex" ] } }, "createdBy": "ecd5158ebF18385E8B0dEdAC", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "8fCfAFDE7da1aB82211Bd779", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "3a21BCeBc571ad8956d243ae", "name": "do dolor deserunt" }, { "_id": "6DdFf3BD9CdDB8cE4Aab8aa3", "name": "Duis in dolor" }, { "_id": "f6EB7eFd4F6b7fE56FeDE0Ef", "name": "non ad pariatur voluptate" }, { "_id": "3A26dDFEBCC7f9A3ED19bEDb", "name": "do dolor consequat" }, { "_id": "A96cdBaBf7AD399B8c7BD9df", "name": "eiusmod dolor 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": "ffECDcaEEFcf0D29FCb7B2dE", "namespace": { "type": "project", "name": "dolor ex incididunt cupidatat aliqua", "accessControl": { "read": [ "nisi ea dolore" ], "write": [ "minim adipisicing in laborum" ], "execute": [ "consequat in velit est cupidatat", "nulla ipsum pariatur occaecat", "qui velit" ], "manage": [ "magna esse" ] } }, "createdBy": "0a7cddaDF4b4D7c666DEbe6f", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "De6aAb2C57e6dAbB42A3Fc1f", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "CDB254aEDdAaB68F9e8E0eFe", "name": "in cupidatat dolore nisi" }, { "_id": "FFD60F7DDaAbC9aC7F1DA149", "name": "cillum in deserunt aliqua" }, { "_id": "6DA2F77034C3cff387E17FFA", "name": "consectetur aliquip aute occaecat" } ] } ], "total": 90918919, "start": 909897, "end": 26722355, "count": 85907837, "next": "occaecat ut", "previous": "exercitation" }
{ "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" } ] } } }