Wenn du Informationen zu einem bestimmten Kunden finden möchtest, kannst du den Parameter filter der Cloud Channel API über die Methode customers.list verwenden.
Wenn Sie einen Filter verwenden, dauert es beim Erstellen eines Kunden in der Regel einige Sekunden. Wenn Sie direkt nach der Erstellung Zugriff auf einen Kunden benötigen, empfehlen wir, customers.list ohne Filter oder customers.get zu verwenden.
Verfügbare Filter
Strings für den Filterparameter unterstützen die exakte Übereinstimmung oder die exakte Übereinstimmung mit Präfix-Filterung. Bei Filtern wird nicht zwischen Groß- und Kleinschreibung unterschieden.
In der folgenden Tabelle werden die verfügbaren Felder beschrieben, nach denen Sie suchen können, und die unterstützten Methoden.
| Externer Suchschlüssel | Unterstützung für genau passende Keywords | Präfixunterstützung |
|---|---|---|
| Domain | Ja | Ja |
| org_display_name | Ja | Ja |
| cloud_identity_id | Ja | Nein |
| channel_partner_id | Ja | Nein |
Die vollständige Filtersyntax finden Sie im Leitfaden für API-Filter.
Syntax für die genaue Übereinstimmung
Mit Filtern vom Typ „Genau passend“ werden nur Kunden gefunden, die dieselben Felder wie im eingereichten String enthalten.
Syntax:
<domain | org_display_name | cloud_identity_id | channel_partner_id> = <value>
Beispiel: domain = "domain.com" AND channel_partner_id = "12345"
Präfixsyntax
Bei Präfixfiltern kann ein Sternchen als Platzhalter verwendet werden. Mit diesem Filter werden Kunden mit Feldern mit dem Präfix gefunden, unabhängig vom Inhalt, der danach folgt.
Syntax: <domain | org_display_name> : <value>*
Beispiel: domain : "uw.com*" AND org_display_name : "prefix*"
Beispiele für Filter mit logischen Operatoren
Cloud Channel API-Filter unterstützen die Verwendung der logischen Operatoren AND und OR. Sie können beide Operatoren in einem Filter verwenden, indem Sie eine eingeklammerte Anweisung verwenden.
Beispiel für UND
domain = "domain.com" AND channel_partner_id = "12345" AND org_display_name :
"display*"
ODER-Beispiel
domain = "domain.com" OR channel_partner_id = "12345" OR org_display_name :
"display*"
Beispiel für AND + OR
domain = "domain.com" OR (channel_partner_id = "12345" AND org_display_name :
"display*" )
Klammern sind erforderlich, wenn der Filter eine AND- und eine OR-Beschreibung enthält. Das folgende Beispiel ist kein gültiger Filterstring.
domain = "domain.com" OR channel_partner_id = "12345" AND org_display_name :
"display*