Fields API

Die Fields APIs geben Beschreibungen für die Datenfelder in Customa zurück. Mit Hilfe dieser API können z.B. Benutzerschnittstellen wie der MCP-Server oder eine grafische Oberfläche dynamisch Filter für die Search API oder Stats API bereitstellen.

Es werden über die API folgende Informationen ausgegeben:

  • Name: Name des Feldes, mehrsprachig
  • Description: Evtl. längere Beschreibung des Feldes, mehrsprachig
  • AllowedFilters: Erlaubte Filtertypen für die Search API - Dies kann sich vor allem zwischen den API-Entitäten und der Stats API unterscheiden.
  • AllowedValues (optional): Diese Eigenschaft ist bei Enumerations gesetzt. Mögliche Werte werden in mehreren Sprachen beschrieben.