Aufbau einer Suche

Worum es geht

Mit POST {basis}/query holst du eine Liste von Objekten eines Modells, zum Beispiel alle Kunden aus Köln, sortiert nach Namen, 25 pro Seite. Der Körper hat zwei Teile:

• response sagt, welche Felder jedes Objekt in der Liste hat. Das ist dieselbe Feldauswahl wie beim Lesen, siehe Feldauswahl.
• parameter sagt, welche Objekte in welcher Reihenfolge kommen.

Ein vollständiger Request

{
  "response": ["id", "name", "city"],
  "parameter": {
    "query": {
      "type": "AND",
      "filter": [
        { "key": "city", "value": "Köln", "param": "EQ" }
      ],
      "group": []
    },
    "order": [ { "field": "name", "order": "ASC" } ],
    "page": 0,
    "limit": 25,
    "meta": true
  }
}

flowchart TB
    B["Körper von POST /query"] --> R["response<br/>welche Felder"]
    B --> P["parameter"]
    P --> Q["query<br/>welche Objekte (Filterbaum)"]
    P --> O["order<br/>in welcher Reihenfolge"]
    P --> S["page + limit<br/>welcher Ausschnitt"]
    P --> M["meta<br/>Angaben zur Liste"]
    Q --> T["type: AND oder OR"]
    Q --> F["filter: einzelne Bedingungen<br/>key, value, param"]
    Q --> G["group: Untergruppen<br/>wieder mit type, filter, group"]

Standardwerte

Alles in parameter darf fehlen. Dann gilt:

Die Antwort

POST /api/rest/crm/customer/query
{ "response": ["id", "name"],
  "parameter": { "limit": 2, "order": [{ "field": "name", "order": "ASC" }] } }

{
  "data": [
    { "id": "5a2b…", "name": "Alt-Muster AG" },
    { "id": "7c1d…", "name": "Muster GmbH" }
  ],
  "meta": {
    "error": false,
    "totalCount": 42,
    "currentPage": 0,
    "currentLimit": 2
  }
}

data ist die Liste der Objekte dieser Seite. In meta steht unter anderem totalCount, die Zahl aller Treffer über alle Seiten. Die Antwort ist gekürzt, siehe Blättern und Trefferzahl für alle Angaben in meta.

Was auf dem Weg passiert

Die Suche braucht dieselbe Leserolle wie das Lesen eines einzelnen Objekts. Den Endpunkt gibt es nur, wenn das Modell ihn freigibt, siehe Endpunkte.

Alle Ausprägungen

Fallen