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": 10, "order": 1, "sort": "name", "include": "name,description", "exclude": "_id", "in": "officia", "not-in": "voluptate et sint do Ut", "equals": "dolore Lorem", "contains": "irure", "starts-with": "eu esse ad nisi", "ends-with": "nisi" } }
{ "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": "B3b76d13b9e5F5372b5DfFdC", "createdBy": "55BdEa26D36B5F7eeF41DAfb", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "aB25F1Ae2Eccf7Fe1Dc42Fa4", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "6046aF776d0FD0Ed4dB7FEB7", "name": "et exercitation culpa ad aute", "description": "A user-defined object to help group documents." }, { "_id": "CBb8B7d4dd3bE7F1FBd2a5bD", "name": "adipisicing amet in Lorem in", "description": "A user-defined object to help group documents." } ] }, { "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": "Fcfa0b07cdb2Bd7f4f3FcB2D", "createdBy": "3Fcb3D7EFbef8B2Ef994a3cF", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "952DF07BEAE5E50a3c6DBd29", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "998aAb5a4Eb1EA8c5912FB6E", "name": "tempor", "description": "A user-defined object to help group documents." }, { "_id": "dA9ce33c974BCB13aDcE9Ef4", "name": "nulla tempor adipisicing anim", "description": "A user-defined object to help group documents." }, { "_id": "a443Bc6FcbDa63d7EeFEEaf0", "name": "sunt", "description": "A user-defined object to help group documents." }, { "_id": "ac89cDbEC4Cdeddb735f0f0d", "name": "esse consectetur culpa reprehenderit", "description": "A user-defined object to help group documents." }, { "_id": "F60a7f41bc623C54Deed201E", "name": "magna", "description": "A user-defined object to help group documents." } ] }, { "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": "ccFb2B3f3E71a7Dd4e8B83Fd", "createdBy": "8A7BF4F5ee796251BE6e043A", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "A0091FC04E8bdB2eaCeE9FAF", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "CAB1EefE6D731efAE85f9fEB", "name": "id officia esse", "description": "A user-defined object to help group documents." }, { "_id": "2f65A0b344bB0FADD0f18FEB", "name": "tempor", "description": "A user-defined object to help group documents." }, { "_id": "C88dC9927E99F7F915Ae0Ef2", "name": "amet ex eu", "description": "A user-defined object to help group documents." } ] } ], "total": 6818660, "start": 36005041, "end": -53535626, "count": -59411339, "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": { "type": [ "string", "null" ], "description": "URI pointing to the next set of paginated results. Preserves previous search and projection parameters. Null if returning the last page of results." }, "previous": { "type": [ "string", "null" ], "description": "URI pointing to the previous set of paginated results. Preserves previous search and projection parameters. Null if returning the first page of results." } } }