Wildcards + und *

Worum es geht

Bei jedem Lesen sagst du CDMS in der Liste response, welche Felder du zurückhaben willst. Du kannst jedes Feld einzeln nennen. Bei Modellen mit vielen Feldern ist das mühsam, deshalb gibt es zwei Abkürzungen, die Wildcards:

Das Beispielmodell

Alle Bilder auf dieser Seite benutzen dasselbe Modell employee (Mitarbeiter):

Die zwei Grundformen

POST /api/rest/hr/employee/read/7f3…
{ "response": ["*"] }

{
  "data": {
    "id": "7f3…",
    "firstname": "Daniel",
    "lastname": "Mertins",
    "company":    { "id": "a1…", "companyname": null },
    "department": { "id": "d4…", "name": null }
  },
  "meta": { "error": false }
}

Wenn du mehr als die id einer Referenz brauchst, baust du sie ausdrücklich aus. Das steht unter Referenzen ausbauen.

Die Teil-Wildcards

Beide Zeichen kannst du mit einem Wortanfang oder einem Wortende kombinieren. Das Zeichen steht entweder ganz vorn oder ganz hinten:

Wie CDMS eine Wildcard auflöst

Die Auflösung übernimmt eine Komponente im REST-Layer, der Expander. Für jeden Eintrag der response-Liste geht er so vor:

flowchart TB
    E["Eintrag aus response"] --> Q1{"Ist es ein Objekt<br/>{ field, response }?"}
    Q1 -->|ja| R["Referenz gezielt ausbauen<br/>(eigene Seite)"]
    Q1 -->|nein| Q2{"Enthält der Text<br/>+ oder * am Anfang<br/>oder am Ende?"}
    Q2 -->|nein| F["genau dieses Feld übernehmen"]
    Q2 -->|"ja, +"| P["alle einfachen Felder,<br/>deren Name passt"]
    Q2 -->|"ja, *"| S["alle einfachen Felder, deren Name passt<br/>+ alle Referenzen, deren Name passt<br/>(nur mit id)"]
    P --> X["exclude abziehen"]
    S --> X
    F --> Z["Ergebnis: Liste der Felder<br/>→ genau diese Spalten werden aus der DB gelesen"]
    X --> Z

Vier Regeln, die du dir merken solltest:

1. Wortanfang oder Wortende, sonst nichts. Es gibt keine regulären Ausdrücke, kein Zeichen in der Wortmitte und nie zwei Zeichen in einem Eintrag.
2. Groß- und Kleinschreibung zählen. +Name trifft firstname nicht.
3. Mehrere Einträge werden zusammengezählt. ["+name", "*ment"] liefert firstname, lastname und department.
4. Kein Treffer ist kein Fehler. Eine Wildcard, die nichts trifft, liefert einfach keine Felder, die Antwort ist trotzdem 200.

Felder wieder herausnehmen: exclude

Mit exclude nimmst du einzelne Felder aus dem Ergebnis einer Wildcard wieder heraus:

{ "response": ["*"], "exclude": ["department"] }

{ "data": { "id": "7f3…", "firstname": "Daniel",
            "lastname": "Mertins", "company": { "id": "a1…" },
            "department": null } }

Alle Ausprägungen auf einen Blick

Die zwei Fallen

Falle 1: null heißt nicht „leer“

In der Antwort steht immer das ganze Objekt. Felder, die du nicht angefordert hast, stehen als null darin, sie fehlen nicht. Bei firstname: null weißt du also nicht, ob das Feld leer ist oder ob du es nur nicht angefordert hast.

Falle 2: * braucht die Rechte aller Referenzen

Ein ["*"], das bei dir funktioniert, kann bei einem Kollegen mit weniger Rollen scheitern.

Warum das Ganze? Die Wirkung auf die Datenbank

Die response ist kein Filter, der hinterher Felder aus der Antwort streicht. Sie bestimmt schon, was aus der Datenbank gelesen wird: CDMS baut eine Abfrage, die genau die angeforderten Spalten liest, und hängt Referenzen per LEFT JOIN an. Ein + auf einem Modell mit 40 Feldern liest also 40 Spalten, ["id", "name"] nur zwei.

flowchart LR
    A["response: ['id','firstname','*ment']"] --> B["Expander<br/>→ id, firstname, department.id"]
    B --> C["SQL: SELECT e.id, e.firstname, d.id<br/>FROM employee e<br/>LEFT JOIN department d …"]
    C --> D["Antwort mit genau diesen Werten"]