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": 92557724, "skip": 69859200, "limit": 18667655, "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": "3fdadc5ce76a74627ff1e84f" }, { "name": "My Template", "device": "Device Group A", "command": "show hostname", "template": "Value HOSTNAME (.+?)\n\nStart\n ^${HOSTNAME}\\s*$$ -> Record", "text": "hostname", "type": "custom", "_id": "b44b46520e1b809de7fa9041" }, { "name": "My Template", "device": "Device Group A", "command": "show hostname", "template": "Value HOSTNAME (.+?)\n\nStart\n ^${HOSTNAME}\\s*$$ -> Record", "text": "hostname", "type": "custom", "_id": "9f9cc89f9a46d82a01b6fb26" }, { "name": "My Template", "device": "Device Group A", "command": "show hostname", "template": "Value HOSTNAME (.+?)\n\nStart\n ^${HOSTNAME}\\s*$$ -> Record", "text": "hostname", "type": "custom", "_id": "fe3bb58c569d8c26b56ab2a1" }, { "name": "My Template", "device": "Device Group A", "command": "show hostname", "template": "Value HOSTNAME (.+?)\n\nStart\n ^${HOSTNAME}\\s*$$ -> Record", "text": "hostname", "type": "custom", "_id": "a36699a45e6e9593aa0a7b20" } ], "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": "4b58999f3ebe7f37859ecce0" } ], "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": "ccb8881e279272ca36c4d608" }, { "name": "My Template", "device": "Device Group A", "command": "show hostname", "template": "Value HOSTNAME (.+?)\n\nStart\n ^${HOSTNAME}\\s*$$ -> Record", "text": "hostname", "type": "custom", "_id": "6c3752741692ee72f5e0100f" } ], "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": "28b1c639741f1434816931fa" }, { "name": "My Template", "device": "Device Group A", "command": "show hostname", "template": "Value HOSTNAME (.+?)\n\nStart\n ^${HOSTNAME}\\s*$$ -> Record", "text": "hostname", "type": "custom", "_id": "834388b56f4482f0de9b024e" }, { "name": "My Template", "device": "Device Group A", "command": "show hostname", "template": "Value HOSTNAME (.+?)\n\nStart\n ^${HOSTNAME}\\s*$$ -> Record", "text": "hostname", "type": "custom", "_id": "f9a5e4a435175cf3d6a5fb77" }, { "name": "My Template", "device": "Device Group A", "command": "show hostname", "template": "Value HOSTNAME (.+?)\n\nStart\n ^${HOSTNAME}\\s*$$ -> Record", "text": "hostname", "type": "custom", "_id": "91e326f090fd2e4e00221005" }, { "name": "My Template", "device": "Device Group A", "command": "show hostname", "template": "Value HOSTNAME (.+?)\n\nStart\n ^${HOSTNAME}\\s*$$ -> Record", "text": "hostname", "type": "custom", "_id": "7bf2703d6aa78786f0959923" } ], "devices": [ { "name": "device1", "id": "device1" }, { "name": "device1", "id": "device1" }, { "name": "device1", "id": "device1" }, { "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" } } } }