Wie konfiguriere ich durchsuchbare benutzerdefinierte Felder?

  • Aktualisiert am May 19, 2025
  • Veröffentlicht am Apr 30, 2025
Prev Next

Wir haben die benutzerdefinierten Felder um eine Suchfunktion für Kunden/Verträge/Abonnements und Produkte (Komponenten) erweitert, die eine Filterung nach benutzerdefinierten Feldern ermöglicht.

Bitte beachten Sie:

Wenn Sie mehr über benutzerdefinierte Felder erfahren möchten, lesen Sie diesen Artikel.

Konfiguration

  1. Gehen Sie zu Einstellungen>Benutzerdefinierte Felder.
    SearchableCustomFields1.png

  2. Achten Sie beim Hinzufügen eines neuen benutzerdefinierten Feldes darauf, dass Sie die Option Durchsuchbar aktivieren.
    SearchableCustomFields2.png

Bitte beachten Sie:

Bitte aktivieren Sie dieses Kontrollkästchen nur für benutzerdefinierte Felder, die eine Suchfunktion erfordern. Sobald ein Feld neu als durchsuchbar markiert wurde, kann es einige Zeit dauern, bis die Suche ein erwartetes Ergebnis liefert.

Filtern

Die Filterung ist über UI und API möglich:

  • UI - Sie können die Benutzeroberfläche verwenden, um mehrere Elemente wie Kunden/Verträge oder Pläne und Komponenten herauszufiltern:

    • Für Kunden/Verträge - Im Abschnitt Kunden können Sie im Dropdown-Menü Zusätzliche Suchattribute nach bestimmten benutzerdefinierten Feldern suchen.
      SearchableCustomFields3.png

    • Für Komponenten - Im Abschnitt Produkte, unter Komponenten, können Sie nach bestimmten benutzerdefinierten Feldern suchen.
      SearchableCustomFields4.png

    • Für Pläne - Im Abschnitt Produkte unter Pläne können Sie nach bestimmten benutzerdefinierten Feldern sowie nach Komponenten suchen.
      SearchableCustomFields5.png

  • API - Sie können Endpunkte verwenden, um Kunden/Verträge/Abonnements oder Produkte nach durchsuchbaren benutzerdefinierten Feldern herauszufiltern:

    Bitte beachten Sie:

    Um Kunden/Verträge/Produkte oder Abonnements anhand des Wertes von customField zu finden, muss customFieldApiName genau so angegeben werden, wie er für Custom Field festgelegt ist (Groß- und Kleinschreibung wird beachtet). Der Wert von Searchable CustomField unterscheidet nicht zwischen Groß- und Kleinschreibung.

    • Für Kunden - GET /api/v1/customers?CustomFields.{CustomFieldApiName}={customField value}. Erkunden Sie diese Funktion auf unserer API-Referenzseite

    • Für Verträge - GET /api/v1/contracts?CustomFields.{CustomFieldApiName}={customField value}. Weitere Informationen zu dieser Funktion finden Sie auf unserer API-Referenzseite.

    • Für Abonnements nach den benutzerdefinierten Feldern des Vertrags GET /api/v1/subscriptions?Contract.CustomFields.{CustomFieldApiName}={customField value}. Weitere Informationen zu dieser Funktion finden Sie auf unserer API-Referenzseite.

    • Für Abonnements nach den benutzerdefinierten Feldern des Kunden GET /api/v1/subscriptions?Customer.CustomFields.{CustomFieldApiName}={customField value}. Weitere Informationen zu dieser Funktion finden Sie auf unserer API-Referenzseite.

    • Für Komponenten - GET /api/v1/components. Weitere Informationen zu dieser Funktion finden Sie auf unserer API-Referenzseite.

    • Für Produkte (Pläne) - GET /api/v1/pläne. Weitere Informationen zu dieser Funktion finden Sie auf unserer API-Referenzseite.

Bitte beachten Sie:

Durch die Filterung über diese Endpunkte ist es möglich, nach einigen wenigen benutzerdefinierten Feldern zu filtern:

Zum Beispiel mit den bereits erwähnten Endpunkten:

GET /api/v1/customers?CustomFields.{CustomFieldApiName}={customField 1 value}&&CustomFields.{CustomField2ApiName}={customField 2 value})

Verwandte Artikel