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": 50, "order": 1, "sort": "name", "include": "name", "exclude": "_id", "in": "velit quis et nostrud", "not-in": "ullamco irure", "equals": "ad", "contains": "tempor sit velit", "starts-with": "ut proident incididunt", "ends-with": "Ut deserunt ullamco commodo" } }
{ "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": "8Ab1fb99C2BE3cdCd8bc7A88", "createdBy": "84EE344B15EeEf4A9d9E4ce4", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "84e23dbABA3D0cdBFAafff45", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "3dB2c522659bc6a1fB5adcdb", "name": "ipsum aliquip" }, { "_id": "E9144020eEA7A8b87b03c2fc", "name": "in consequat anim" }, { "_id": "1eeFdAF8e0b80457CEDDdE8b", "name": "dolore" }, { "_id": "cD7CE42DdE9b7b71f7Cd69cC", "name": "culpa dolor nostrud" } ] }, { "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": "D3eD3efd0104Bb00fC4fB1bA", "createdBy": "ADb1fe09f3cFdfaC4ABDbE32", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "987ecffB0f2237D3ada4Fe4D", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "1a52C2b79784C00BfEBa9bbF", "name": "voluptate nostrud cillum" }, { "_id": "fc41823A0C2C251a2BE6Eeab", "name": "nostrud" }, { "_id": "beA36dDB8bC2bECCEC89F4A8", "name": "dolor" }, { "_id": "5cFE2A9a0FBDbF1DE5eE54C5", "name": "magna laborum cupidatat anim" } ] }, { "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": "B9ef8Ba74B282ACFe9B1Ec7B", "createdBy": "BdA2cce6e3DE2eD0AaC0439e", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "E1b8F8F33e41AFbF2FCbD84e", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "Bc2760dAbA55A80a2fdADDE7", "name": "commodo fugiat ullamco ad" }, { "_id": "De5afEFfCF5ecEFdc6EBfe0D", "name": "enim nostrud" }, { "_id": "5eFFDce4Adc567A1DfE0005A", "name": "consectetur quis reprehenderit laboris ut" }, { "_id": "B2fDf151F9631F1E62c5Bd8d", "name": "irure eu sit" } ] }, { "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": "1D903Fff1eA8f080Be5783E1", "createdBy": "2BD5c7e41DCfE3AC6697010E", "created": "2019-11-25T22:51:39.201Z", "lastUpdatedBy": "48F8b23Fb6DF6A5E8f4d9A9C", "lastUpdated": "2019-11-25T22:51:39.201Z", "version": 1, "tags": [ { "_id": "4257a29B4cC0a6E74BfdAEdF", "name": "fugiat" }, { "_id": "1fFbcdD646ffDb66e7b3C86B", "name": "adipisicing sed dolore" }, { "_id": "89175Fbb6eBF5b43B8bEA88C", "name": "deserunt mollit dolore ea" } ] } ], "total": 22817669, "start": -62863716, "end": -77233346, "count": -99064036, "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" } ] } } }