Summary
Get templates filtered
Description
Get filtered list of templates
Route
GET /template_builder/filterTemplates
Roles
admin
other
readonly
apiread
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| options |
object |
yes |
Options for query parameters |
Copied to Clipboard
{
"options": {
"limit": 10,
"skip": 0,
"order": -1,
"sort": "name",
"contains": "Template name search term",
"containsField": "name"
}
}
Copied to Clipboard
{
"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
DetailsExampleSchema
| Name |
Type |
Description |
| templatesResult |
object |
Template and example results from parsed text |
Copied to Clipboard
{
"total": 35274428,
"skip": 82608874,
"limit": 19327316,
"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": "43ea682a66d01320b23d700b"
},
{
"name": "My Template",
"device": "Device Group A",
"command": "show hostname",
"template": "Value HOSTNAME (.+?)\n\nStart\n ^${HOSTNAME}\\s*$$ -> Record",
"text": "hostname",
"type": "custom",
"_id": "2e7f109399dc5f63406ab485"
},
{
"name": "My Template",
"device": "Device Group A",
"command": "show hostname",
"template": "Value HOSTNAME (.+?)\n\nStart\n ^${HOSTNAME}\\s*$$ -> Record",
"text": "hostname",
"type": "custom",
"_id": "35a25ccf0bb2cadbaac031a4"
}
],
"devices": [
{
"name": "device1",
"id": "device1"
},
{
"name": "device1",
"id": "device1"
},
{
"name": "device1",
"id": "device1"
},
{
"name": "device1",
"id": "device1"
},
{
"name": "device1",
"id": "device1"
}
]
}
]
}
Copied to Clipboard
{
"type": "object",
"properties": {
"total": {
"type": "integer",
"minimum": 0
},
"skip": {
"type": "integer",
"minimum": 0
},
"limit": {
"type": "integer",
"minimum": 0
},
"list": {
"type": "array",
"items": {
"$ref": "templatesResults"
}
}
}
}
