Antwortgruppen
Diese Seite richtet sich an App-Entwickler, die über eine langsame Mobilverbindung kleine Antworten und dort, wo ein Bildschirm sie braucht, vollständige Antworten möchten. Antwortgruppen sind der Schalter der REST-API dafür.
Inhalt
- Die Gruppen pro Route
- Den Parameter schreiben
- Voreinstellungen werden immer hinzugefügt
- Gruppen für Bildschirme wählen
Die Gruppen pro Route
Aus den Konstanten von ezp7xRestContentController:
| Route | Gruppe | Fügt hinzu | Voreinstellung |
|---|---|---|---|
GET /content/node/<id>, GET /content/object/<id> | Metadata | das Objekt metadata | ja |
| dieselbe | Locations | die Liste locations | nein |
| dieselbe | Fields | die Tabelle fields | nein |
GET .../fields, GET .../field/<identifier> | FieldValues | die Tabelle fields (oder das eine Feld) | ja |
| dieselbe | Metadata | das Objekt metadata des Inhalts | nein |
GET /content/node/<id>/list... | Metadata | die Listen-metadata: childrenCount, parentNodeId | ja |
| dieselbe | Fields | eine Tabelle fields in jedem Unterknoten | nein |
GET /content/node/<id>/childrenCount | Metadata | metadata mit childrenCount | ja |
Bei den Namen kommt es auf Groß- und Kleinschreibung an: Fields, nicht fields.
Den Parameter schreiben
Der Request-Parser akzeptiert beide Formen:
?ResponseGroups=Metadata,Locations,Fields
?ResponseGroups[]=Metadata&ResponseGroups[]=Locations&ResponseGroups[]=FieldsDie zweite Form erzeugen manche HTTP-Bibliotheken aus einem Array. Vor 6.0.15 endete sie in einer Fehlerseite; der
Parser akzeptiert sie jetzt (Kommentar in http_parser.php).
Voreinstellungen werden immer hinzugefügt
Die voreingestellten Gruppen einer Route sind enthalten, ob Sie sie nennen oder nicht: Wer beim Lesen eines Knotens
?ResponseGroups=Fields anfordert, erhält trotzdem metadata. Die Antwort führt die angewendeten Gruppen in
requestedResponseGroups auf, was bei der Fehlersuche nach einem fehlenden Schlüssel hilft.
Gruppen für Bildschirme wählen
| Bildschirm | Aufruf | Warum |
|---|---|---|
| Eine Liste von Titeln | .../list/offset/0/limit/20 | Die Metadaten enthalten objectName, classIdentifier, nodeId; keine Felder nötig |
| Eine Liste von Karten mit Anreißer und Bild | .../list/offset/0/limit/20?ResponseGroups=Fields | Jeder Unterknoten bringt seine Felder mit |
| Ein Detailbildschirm | /content/node/<id>?ResponseGroups=Fields | Metadaten und alle Felder in einem Aufruf |
| Ein Badge mit einer Anzahl | /content/node/<id>/childrenCount | Eine Zahl, keine Elemente |
| Einen einzelnen Wert aktualisieren | /content/node/<id>/field/<identifier> | Nur ein Feld |
Fields liefert bei einer Liste jedes Feld jedes Unterknotens. Messen Sie bei Klassen mit vielen oder großen Feldern
die Größe der Antwort über eine Mobilverbindung, und erwägen Sie, Details erst zu lesen, wenn der Benutzer ein Element
öffnet.
Verwandte Seiten
- Einen Knoten lesen
- Unterknoten auflisten und Paginierung
- Felder und Feldwerte
- Freie Dokumentation: Diese Seite darf unter der GNU FDL 1.3 frei kopiert, übersetzt und verbessert werden.
Werden Sie Exponential-Partner
Partner teilen ihre Informationen, stellen Mittel bereit, geben Beiträge zurück und entwickeln die Produkte mit uns, und so wächst Exponential. Eine Partner-Website und ein Dashboard sind für Mitte 2027 geplant: Werden Sie noch heute Partner, damit wir schneller wachsen und neue Funktionen früher liefern.