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": 27192293,
  "skip": 31550720,
  "limit": 50153608,
  "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": "6db571daac07ae45137cca0c"
        }
      ],
      "devices": [
        {
          "name": "device1",
          "id": "device1"
        },
        {
          "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": "0b42cc604f35f4f22bb47c8f"
        },
        {
          "name": "My Template",
          "device": "Device Group A",
          "command": "show hostname",
          "template": "Value HOSTNAME (.+?)\n\nStart\n  ^${HOSTNAME}\\s*$$ -> Record",
          "text": "hostname",
          "type": "custom",
          "_id": "d0a2a414c0186598e1a2346c"
        },
        {
          "name": "My Template",
          "device": "Device Group A",
          "command": "show hostname",
          "template": "Value HOSTNAME (.+?)\n\nStart\n  ^${HOSTNAME}\\s*$$ -> Record",
          "text": "hostname",
          "type": "custom",
          "_id": "8f39315ef9b53611fd167b9e"
        },
        {
          "name": "My Template",
          "device": "Device Group A",
          "command": "show hostname",
          "template": "Value HOSTNAME (.+?)\n\nStart\n  ^${HOSTNAME}\\s*$$ -> Record",
          "text": "hostname",
          "type": "custom",
          "_id": "7093e01f541b441c2f7d7b98"
        }
      ],
      "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": "6e0a34e890c84bbd4948f5f2"
        },
        {
          "name": "My Template",
          "device": "Device Group A",
          "command": "show hostname",
          "template": "Value HOSTNAME (.+?)\n\nStart\n  ^${HOSTNAME}\\s*$$ -> Record",
          "text": "hostname",
          "type": "custom",
          "_id": "98257466c446d22ddf2ce071"
        }
      ],
      "devices": [
        {
          "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"
      }
    }
  }
}