Search Class - 06.Filters

Get a list with all properties available to create a filter for this endpoint. To get more info about how to create filters, please refer to this link.

Returns a list with all properties available to create a filter for this endpoint.

• string property_name: Internal name of the property. You must it this value to define properties in your filter.
• string property_type: Type of the property. Here you can find basic types like String, DateTime, Boolean, Int32, etc. Or internal types of LawPanel entities like Registry, SearchClass, Client, etc.
• string property_display_name: Human-readable name for the property.
• string property_description: Human-readable description for the property.
• array comparators_available: An array of strings with comparators available for this property.
  
  Some common values:

  • string == Equal to.
  • string != Not equal to.
  • string > Greater than.
  • string >= Greater or equal to.
  • string < Minor than.
  • string <= Minor or equal to.
  • string IN In range.
  • string CU Into current.
  • string CONTAINS Contains value.
  • string STARTSWITH Value starts with.
  • string ENDSWITH Value ends with.
• bool multiple: When true means that properti can handle multiple values on its definition.
• string endpoint: For properties of non-basic types like String, DateTime, Boolean, etc., this property indicates the endpoint where you can get a list with entities to use at the filter definition. For example, if the type of the property is Registry then this property will contains the endpoint Registry which is the URL to get Registries and their IDs in order to compose the filter.

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "property_name": {
        "type": "string"
      },
      "property_type": {
        "type": "string"
      },
      "property_display_name": {
        "type": "string"
      },
      "property_description": {
        "type": "string"
      },
      "comparators_available": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "multiple": {
        "type": "boolean"
      },
      "end_point": {
        "type": "string"
      }
    },
    "required": [
      "property_name",
      "property_type",
      "property_display_name",
      "property_description",
      "comparators_available",
      "multiple",
      "end_point"
    ]
  }
}