cobra CRM

REST-API verwenden

Filtern und Sortieren

Filter setzen bei Endpunkten

Wenn Sie einen neuen Endpunkt anlegen, haben Sie die Möglichkeit, einen Filter nach relevanten Kriterien zu setzen. So können Sie bestehende Datensätze beispielsweise nach der Person, die den Datensatz angelegt hat, oder nach einer Postleitzahl filtern.

  • Klicken Sie bei dem Eintrag des relevanten Endpunkts auf die »...«- Schaltlfäche in der Spalte »Filter«.
Konfiguration REST-Endpunkt Filter

Im Reiter »Visuell« können Sie mithilfe der bekannten booleschen Operatoren den Filter mit vorgegebenen Bausteinen nach Ihren Kriterien gestalten. In unserem Beispiel setzen wir einen Filter, um die Adressen abzurufen, die mit der Postleitzahl »78« beginnen.

Konfiguration REST-Endpunkt Filter Visuell Beispiel PLZ 78

Im Reiter »Text« können Sie den Filter händisch in Textform eingeben. In unserem Beispiel setzen wir einen Filter, um die Adressen abzurufen, die mit der Postleitzahl »78« beginnen.

Konfiguration REST-Endpunkt Filter Text Beispiel PLZ 78

Filtern und Sortieren via REST-API

Sie können zum Filtern und Sortieren auf die DevExpress Criteria Language Syntax zurückgreifen. Es handelt sich dabei um die gleichen Ausdrücke, die bereits in cobra z.B. bei Filtern zur Verfügung stehen.

Im Folgenden zeigen wir Ihnen einige Beispiele, wie Sie nach Orten oder vergebenen Stichwörtern filtern können.

Darüber hinaus können Sie sich die relevanten Ergebnisse Ihrer Anfrage sortieren lassen.

Filter

Sie können nach einzelnen Feldern filtern:

GET /api/adressen

Beispiel: Adresse nach nach dem Ort »Konstanz« filtern.

http(s)://localhost:12345/api/adressen?FilterExpression=Ort='Konstanz'

Beispiel: Firma mit dem Anfangsbuchstaben »A«.

http(s)://localhost:12345/api/adressen?FilterExpression=Firma like 'A%'

Beispiel: Adresse mit dem Stichwort »Angebot«.

http(s)://localhost:12345/api/adressen?FilterExpression=HasKeyword('Angebot')

Weitere Beispiele für die Suche nach möglichen Stichwörtern oder deren IDs:

HasKeyword('Aktion - Angebot')
HasKeywords('Aktion - Angebot', 'Marketing - Werbeaktion')
HasKeywordID(49)
HasKeywordID(49,520,336)

Beispiel: die ersten fünf Einträge anzeigen lassen.

http(s)://localhost:12345/api/adressen?top=5

Sortierung

Sie können sich die Ergebnisse sortiert ausgeben lassen:

GET /api/adressen

Beispiel: Firmenname absteigend.

http(s)://localhost:12345/api/adressen?Orderby=Firma desc

Beispiel: Nachname aufsteigend.

http(s)://localhost:12345/api/adressen?Orderby=Nachname asc
Zurück
Authentifizierung