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": 25, "skip": 1, "order": 1, "sort": "name", "include": "description", "exclude": "_id", "in": "eu ad proident dolore in", "not-in": "dolor sed nostrud cillum", "equals": "non occaecat in cupidatat id", "contains": "reprehenderit et irure", "starts-with": "dolore", "ends-with": "sit" } }
{ "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": "7DC24B50b5BddcA0B6Efa97B", "createdBy": "a7A874c3E4FBb4925f2C10BD", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "CC3A45DcB3Aee763cB4e6cd3", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "f4b9E2acbaFAD7986BF04B1e", "name": "velit in adipisicing", "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": "99D4b53Dbf139DBfFF30AbC9", "createdBy": "67Ed1CA76DFBCd555bE728C9", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "5D7f7A6Df5B8A739aE9Adc9b", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "fE0D4E3E19f85452deF5DeC3", "name": "reprehenderit et", "description": "A user-defined object to help group documents." }, { "_id": "3BEBEaCD5CcBACDB3C32d551", "name": "eu amet ullamco dolore", "description": "A user-defined object to help group documents." }, { "_id": "5D7C4D9C16f3a83FDc3a29bC", "name": "consequat consectetur eu dolore anim", "description": "A user-defined object to help group documents." }, { "_id": "e22f35aE25D6DbDBde36bc79", "name": "laboris eiusmod", "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": "2ea0A58B22D2Fafdb69eba2b", "createdBy": "0A05a0e4B074FF3975962a7e", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "Ab4F5C42966FA5f621d33E5C", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "f64F8Ae3d79691f17E4Dca46", "name": "ut", "description": "A user-defined object to help group documents." }, { "_id": "Ff83839e703ee4a0f4BffF3b", "name": "consequat nulla do", "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": "8DbA5bB9Da4eED147233CEbD", "createdBy": "Cb6725D2b90bab0Efafe7E0F", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "5a8C17c6267b8A4f0f46E12B", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "0983a9af5dd2BCD3CB2dE803", "name": "tempor proident", "description": "A user-defined object to help group documents." }, { "_id": "eFF23E4ce69221ffc2f39e1D", "name": "exercitation in 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": "aDeeBE98Bea2C71c4fa9F7C0", "createdBy": "C5cBCfcDcddAAB37BAeF61cC", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "4af77eBBcCDBEDD50FCDD0ce", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "7EDdedbad6a2CfF9Ba15D7c6", "name": "ut adipisicing enim laboris dolore", "description": "A user-defined object to help group documents." }, { "_id": "CD1B5d9AFc6b5F6E6cbE4F0E", "name": "do in deserunt reprehenderit", "description": "A user-defined object to help group documents." } ] } ], "total": 25104725, "start": -97564668, "end": 27789563, "count": -1038602, "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." } } }