Einen Knoten lesen #

Diese Seite richtet sich an App-Entwickler, die einen Detailbildschirm bauen: einen Artikel, ein Produkt, eine Veranstaltung. Sie zeigt die Leserouten für ein einzelnes Element, was die Antwort enthält und wie Sie mehr anfordern.

Inhalt #

1. Über den Knoten oder über das Objekt
2. Die Metadaten
3. Links zu den Feldern
4. Platzierungen
5. Ein Detailbildschirm mit einem Aufruf

Über den Knoten oder über das Objekt #

curl -s -H "Authorization: Bearer $EXP_API_KEY" https://example.com/api/ezp/v2/content/node/<node id>
curl -s -H "Authorization: Bearer $EXP_API_KEY" https://example.com/api/ezp/v2/content/object/<object id>

Verwenden Sie die Knotenroute, wenn Sie von einer Liste kommen (Listen liefern nodeId) oder von einem Link der Website. Verwenden Sie die Objektroute, wenn Sie eine Objekt-ID gespeichert haben, zum Beispiel aus einer Relation. Beide führen dieselbe Controller-Aktion viewContent aus, und beide prüfen zuerst content/read für den aktuellen Benutzer: 403 access_denied, wenn der Benutzer das Element nicht lesen darf, 404, wenn es nicht existiert.

Die Metadaten #

Die Antwortgruppe Metadata ist immer enthalten. Die Schlüssel aus ezpRestContentModel:

Verwenden Sie dateModified, um zu entscheiden, ob eine zwischengespeicherte Kopie in der App noch aktuell ist (Caching in der App), und fullUrl für eine Schaltfläche „Teilen“ oder „Im Browser öffnen“.

Links zu den Feldern #

Jeder Lesezugriff enthält eine Tabelle links: einen Eintrag pro Feldbezeichner mit der URL dieses Feldes und * mit der URL aller Felder. Die URLs wiederholen die Parameter Translation und OutputFormat der Anfrage. Folgen Sie ihnen, statt Pfade in der App zusammenzubauen; so funktioniert die App weiter, falls sich ein Pfad einmal ändert.

Platzierungen #

Ein Objekt kann an mehreren Stellen des Baums liegen. Fragen Sie die Platzierungen mit ?ResponseGroups=Locations ab:

"locations": [
  {"nodeId": 61, "nodeRemoteId": "...", "fullUrl": "https://example.com/news/launch", "isMain": true},
  {"nodeId": 142, "nodeRemoteId": "...", "fullUrl": "https://example.com/products/launch", "isMain": false}
]

(Die IDs und Adressen sind für das Beispiel erfunden; die Schlüssel sind die von getLocationsByContent().) Verwenden Sie die Hauptplatzierung für geteilte Links, damit alle Benutzer dieselbe Adresse teilen.

Ein Detailbildschirm mit einem Aufruf #

curl -s -H "Authorization: Bearer $EXP_API_KEY" \
     "https://example.com/api/ezp/v2/content/node/<node id>?ResponseGroups=Metadata,Fields"

Das liefert die Metadaten und alle Felder in einer Antwort, was meist alles ist, was ein Detailbildschirm braucht. Fügen Sie Locations nur hinzu, wenn der Bildschirm die Platzierungen verwendet. Die Feldwerte sind in Felder und Feldwerte beschrieben; Bilder und Rich Text erfordern besondere Sorgfalt (Bilder in REST-Antworten, Rich Text in Apps).

Verwandte Seiten #

• Antwortgruppen
• Unterknoten auflisten und Paginierung
• Wie Exponential-Inhalte in eine App gelangen
• Freie Dokumentation: Diese Seite darf unter der GNU FDL 1.3 frei kopiert, übersetzt und verbessert werden.