Filter in einem API-Anforderungskörper
Die Filterung bietet grundlegende bedingte Abfragen und Seitensteuerung für die Verarbeitung von API-Anforderungen. Es gibt drei grundlegende Komponenten für die Filterung: Bedingungen, Sortier- und Paginierungsparameter.
Informationen zu Filtern
GrundfilterBenutzer filtert, um nach einer einzelnen Bedingung zu suchen, oder sie können in logische Operanden UND und ODER eingewickelt werden. Benutzerfilterung für eine einfache bedingte Auswertung eines einzelnen Felds. Die Werte, die in einem Filter verwendet werden, z. B. ein Operator und ein Feld, sind spezifisch für die API, in der sie verwendet werden.
Standardwerte werden in den Winkelklammern < >dargestellt. Verwenden Sie für jeden Parameter nur einen Wert.
{
"filter": {
"operator": "<NONE, lt, le, eq, ne, ge, gt, substring, and, or, not>",
"field": "string",
"value": "string"
}
}{
"filter": {
"operator": "<and, or>",
"operands": [
{
"operator": "<NONE, lt, le, eq, ne, ge, gt, substring, and, or, not>",
"field": "string",
"value": "string"
},
{
"operator": "<NONE, lt, le, eq, ne, ge, gt, substring, and, or, not>",
"field": "string",
"value": "string"
}
]
}
}| Operation | Beschreibung | Beispiel |
|---|---|---|
| lt | Kleiner als | Menge lt 1500 |
| le | Kleiner gleich | Menge le 1500 |
| eq | Ist gleich | UserEmailAddress, eq first.last@aa.com |
| Ne | Ungleich | UserEmailAddress, ne first.last@aa.com |
| ge | Größer als oder gleich | CreatedDateUtc ge 2021-03-15 |
| gt | Größer als | CreatedDateUtc gt 2021-03-15 |
| and (und) | Und | Feld1 eq 'abc' und Feld2 eq 'def' |
| or (oder) | Oder | Feld1 eq 'abc' oder Feld2 eq 'def' |
"page":{
"offset":0,
"length":0
}- Offset:
Typ: Ganzzahl
Der numerische Wert, der angibt, wie Viele Zeilen in einer Tabelle, die der Filter auswertet.
- Länge
Typ: Ganzzahl
Die Anzahl der Zeilen, die in einer einzelnen Zeile zurückgegeben werden Seite mit Ergebnissen.
"sort": [
{
"field": "string",
"direction": "<asc, desc>"
}- Feld: Das Feld, nach dem die Ergebnisse gefiltert werden sollen. Dies muss ein unterstütztes filterbares Feld sein. Filterbare Felder variieren je nach API.
- Richtung
Typ: Enum [ desc, asc ]
- asc = aufsteigend (kleinste bis größte, 0 bis 9, A bis Z)
- desc = absteigend (größte bis kleinste, 9 bis 0, Z bis A)
Beispiele für API-Filter
- Beispiel für einen Filter für die Benutzerverwaltung
Dieser Beispielfilter basiert auf den Feldern und Parametern der User Management API. Dieser Filter sucht nach dem Benutzernamen, dem Benutzernamenund dem Vornamen des Benutzers .
- Beispiel für einen Repository-Management-Filter
Dieser Beispielfilter basiert auf den Feldern und Parametern der Repository Management API. Dieses Filterbeispiel durchsucht den Bot Status und den Namen.
- Beispiel für den Filter „Ergebnisse der Migrationsliste“
Dieser Beispielfilter basiert auf den Feldern und Parametern der Migrations-API. Dieser Filter sucht nach Migrationen, die ein bestimmtes Feld im Namen enthalten und zwischen zwei Datumsangaben mit updatedOn gestartet wurden.