Summary
Get templates filtered
Description
Get filtered list of templates
Route
GET /template_builder/filterTemplates
Roles
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| options | object | yes | Options for query parameters |
{ "options": { "limit": 10, "skip": 0, "order": -1, "sort": "name", "contains": "Template name search term", "containsField": "name" } }
{ "type": "object", "properties": { "options": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 0 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "type": "integer", "enum": [ -1, 1 ] }, "sort": { "type": "string" }, "contains": { "type": "string" }, "containsField": { "type": "string" }, "equals": { "type": "string" }, "equalsField": { "type": "string" }, "startsWith": { "type": "string" }, "startsWithField": { "type": "string" } }, "examples": [ { "limit": 10, "skip": 0, "order": -1, "sort": "name", "contains": "Template name search term", "containsField": "name" } ] } }, "required": [ "options" ], "additionalProperties": false }
Return
| Name | Type | Description |
|---|---|---|
| templatesResult | object | Template and example results from parsed text |
{ "total": 46878678, "skip": 72473866, "limit": 7692631, "list": [ { "templates": [ { "name": "My Template", "device": "Device Group A", "command": "show hostname", "template": "Value HOSTNAME (.+?)\n\nStart\n ^${HOSTNAME}\\s*$$ -> Record", "text": "hostname", "type": "custom", "_id": "0b275ee12e73086ed9af032f" }, { "name": "My Template", "device": "Device Group A", "command": "show hostname", "template": "Value HOSTNAME (.+?)\n\nStart\n ^${HOSTNAME}\\s*$$ -> Record", "text": "hostname", "type": "custom", "_id": "3037e44487f988dd4a632f80" }, { "name": "My Template", "device": "Device Group A", "command": "show hostname", "template": "Value HOSTNAME (.+?)\n\nStart\n ^${HOSTNAME}\\s*$$ -> Record", "text": "hostname", "type": "custom", "_id": "d44de642855f04712f3415fe" } ], "devices": [ { "name": "device1", "id": "device1" }, { "name": "device1", "id": "device1" }, { "name": "device1", "id": "device1" } ] }, { "templates": [ { "name": "My Template", "device": "Device Group A", "command": "show hostname", "template": "Value HOSTNAME (.+?)\n\nStart\n ^${HOSTNAME}\\s*$$ -> Record", "text": "hostname", "type": "custom", "_id": "44fcb387cadddbc8429902ab" } ], "devices": [ { "name": "device1", "id": "device1" }, { "name": "device1", "id": "device1" }, { "name": "device1", "id": "device1" }, { "name": "device1", "id": "device1" } ] }, { "templates": [ { "name": "My Template", "device": "Device Group A", "command": "show hostname", "template": "Value HOSTNAME (.+?)\n\nStart\n ^${HOSTNAME}\\s*$$ -> Record", "text": "hostname", "type": "custom", "_id": "1238b0afbf4eda88b7f75de9" } ], "devices": [ { "name": "device1", "id": "device1" }, { "name": "device1", "id": "device1" } ] }, { "templates": [ { "name": "My Template", "device": "Device Group A", "command": "show hostname", "template": "Value HOSTNAME (.+?)\n\nStart\n ^${HOSTNAME}\\s*$$ -> Record", "text": "hostname", "type": "custom", "_id": "4c29f041020ce7df97daff38" }, { "name": "My Template", "device": "Device Group A", "command": "show hostname", "template": "Value HOSTNAME (.+?)\n\nStart\n ^${HOSTNAME}\\s*$$ -> Record", "text": "hostname", "type": "custom", "_id": "96b2ad6f058c768a576a7e51" }, { "name": "My Template", "device": "Device Group A", "command": "show hostname", "template": "Value HOSTNAME (.+?)\n\nStart\n ^${HOSTNAME}\\s*$$ -> Record", "text": "hostname", "type": "custom", "_id": "f723b59a7a6c8cf4c1ba567d" }, { "name": "My Template", "device": "Device Group A", "command": "show hostname", "template": "Value HOSTNAME (.+?)\n\nStart\n ^${HOSTNAME}\\s*$$ -> Record", "text": "hostname", "type": "custom", "_id": "54cb6f2403ea2d4855fe3332" } ], "devices": [ { "name": "device1", "id": "device1" }, { "name": "device1", "id": "device1" }, { "name": "device1", "id": "device1" } ] }, { "templates": [ { "name": "My Template", "device": "Device Group A", "command": "show hostname", "template": "Value HOSTNAME (.+?)\n\nStart\n ^${HOSTNAME}\\s*$$ -> Record", "text": "hostname", "type": "custom", "_id": "0a92e85e7a8a4cbde88ebb92" }, { "name": "My Template", "device": "Device Group A", "command": "show hostname", "template": "Value HOSTNAME (.+?)\n\nStart\n ^${HOSTNAME}\\s*$$ -> Record", "text": "hostname", "type": "custom", "_id": "6780d83c513f145459cedf7e" } ], "devices": [ { "name": "device1", "id": "device1" }, { "name": "device1", "id": "device1" } ] } ] }
{ "type": "object", "properties": { "total": { "type": "integer", "minimum": 0 }, "skip": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 0 }, "list": { "type": "array", "items": { "$ref": "templatesResults" } } } }