Feldauswahl mit response

Worum es geht

Jede Anfrage, die Daten zurückliefert, trägt eine Liste response. Sie sagt CDMS, welche Felder in der Antwort stehen sollen. Das gilt für read, query, create, update, patch und rollback.

{
  "response": ["id", "firstname", "+", { "field": "company", "response": ["companyname"] }],
  "exclude": ["internalNote"]
}

Die drei Arten von Einträgen

Ein Eintrag in response ist entweder ein Text oder ein Objekt:

flowchart TB
    E["Eintrag in response"] --> T{"Text oder Objekt?"}
    T -->|"Text ohne + und *"| F["Feldname<br/>genau dieses einfache Feld"]
    T -->|"Text mit + oder *"| W["Wildcard<br/>viele Felder auf einmal"]
    T -->|"Objekt { field, response }"| O["Referenz ausbauen<br/>mit eigener Feldauswahl"]

Dazu kommt neben response die Liste exclude. Sie nimmt Felder wieder heraus, die eine Wildcard dazugenommen hat.

Das Objekt im Detail

Ein Objekt baut eine Referenz aus. Es hat bis zu vier Schlüssel:

Weil response im Objekt wieder Objekte enthalten darf, kannst du beliebig tief verschachteln. Wie das abläuft, steht unter Referenzen und Listen ausbauen.

Beispiel am Modell employee

Dasselbe Modell wie auf den anderen Seiten dieses Kapitels: employee mit firstname, lastname und den Referenzen company und department.

POST /api/rest/hr/employee/read/7f3…
{
  "response": [
    "firstname",
    "+name",
    { "field": "company", "response": ["companyname"] }
  ]
}

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

firstname steht doppelt da, einmal als Name und einmal über +name. Das schadet nicht, CDMS liest jedes Feld nur einmal.

Was CDMS mit ungewöhnlichen Einträgen macht

Entscheidungstabelle

Rechte: pro Modell und pro Beziehung

Ob du etwas lesen darfst, entscheidet CDMS pro Modell und pro Beziehung. Wer employee lesen darf, darf die einfachen Felder von employee lesen, außer ein Feld trägt eine eigene Leserolle: Dann lässt + es ohne diese Rolle weg, und beim Namen angefordert gibt es 403. Siehe Geschützte Werte. Eine Rolle kommt erst ins Spiel, wenn die response in ein anderes Modell hineinreicht: Dann brauchst du dessen Leserolle oder eine Rolle auf der Beziehung selbst. Siehe Modellrollen und Rechte auf Beziehungen.

Die Tabellen oben beschreiben den Standard, den Strict Mode. Ohne ihn ist eine Einzelreferenz ohne Rolle still null; die anderen Fälle scheitern weiter, nur mit anderem Status oder Schlüssel. Siehe Strict Mode.

Fallen