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", "include": "name", "exclude": "_id", "in": "laborum aute sit sunt", "not-in": "in culpa", "equals": "eiusmod consectetur dolore voluptate", "contains": "dolor incididunt dolore", "starts-with": "consectetur Ut Duis", "ends-with": "in id" } }
{ "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" ] }, "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": "e3d2fa5f681De7d195e7dDb5", "createdBy": "caE1F2c7F43Db833e0f361C4", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "ab9ccdB1d792FD3e4DB39553", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "9d3F44Ec40fbf7728e1aD47e", "name": "in elit amet" }, { "_id": "051180CcF6482BDB488eE633", "name": "elit dolore aute eu 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": "F5CC32DbC1DBB7a88D44BcBd", "createdBy": "DA0a56C5d1bf4bcEBCDecfdE", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "4fa1eE1BF5E6FAabddF367D6", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "46C0D7293ff28Ad8cA0aeF59", "name": "ullamco pariatur magna eu" }, { "_id": "D43b5dEa6E68B4bd100bfcEA", "name": "qui aliquip" } ] }, { "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": "A6cF1C0eF9ba08e9Eb5c0937", "createdBy": "3bC290EEC8dDde7917EAdBe7", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "f6F495Fdfe1DAe5A12b7C4F9", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "7ba19BCA0d4EdBABA09BEe24", "name": "labore" }, { "_id": "272CA3f11B42748f8Aeb3E3F", "name": "Duis laborum sunt irure" }, { "_id": "F5DA0b5db0E7CCaAdbae3498", "name": "aute" }, { "_id": "256e7B0751CafD31b6ED95bd", "name": "dolore" }, { "_id": "4eaeAD0D57b7a1B5846DD6eD", "name": "minim dolor pariatur occaecat enim" } ] }, { "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": "89Db30C6f7e734Fa6CF4Be84", "createdBy": "7eE4f7Ba2Dc1bEB0d7DA90cd", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "BA4a3EC569Ccacf56F3f73de", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "4bA8CdDf429Ff7eFDF6afc69", "name": "nulla" } ] } ], "total": 8448105, "start": 30371663, "end": -85186673, "count": -61151463, "next": null, "previous": "Duis do ex est consequat" }
{ "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" } ] } } }