Get

[POST] .../v1/filterfield/get

Returns filterable fields for the selected entity. Use this method before constructing dynamic filters for an API entity when the client needs the machine-readable list of allowed field names. The request requires entity_type in filters and returns standard filter fields plus custom additional fields when that entity and tariff support them. Selection control fields such as search, filters, sort_orders, limit and offset are excluded from the returned filterable fields. Use ItemExt as entity_type to get the filter fields for Item/GetExt. Missing body, invalid or unsupported entity_type, unavailable additional-fields tariff option, metadata provider errors and storage failures are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Filterable Fields

Request Example

{
  "filters": [
    {
      "field": "entity_type",
      "operator": "Equal",
      "value": "Item"
    }
  ]
}

Response Parameters

Response Example

{
  "ok": true,
  "result": [
    {
      "field": "id",
      "datatype": "int",
      "filter_type": "Number",
      "multiple": true,
      "operators": [
        "Equal",
        "In"
      ]
    },
    {
      "field": "name",
      "datatype": "string",
      "filter_type": "Text",
      "multiple": false,
      "operators": [
        "Equal",
        "Like"
      ]
    }
  ]
}