Reading a node #

This page is for app developers who build a detail screen: one article, one product, one event. It shows the read routes for a single item, what the answer contains and how to ask for more.

Contents #

1. By node or by object
2. The metadata
3. Links to the fields
4. Locations
5. A detail screen in one call

By node or by object #

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>

Use the node route when you came from a list (lists give nodeId) or a link of the site. Use the object route when you stored an object id, for example from a relation. Both run the same controller action, viewContent, and both check content/read for the current user first: 403 access_denied if the user may not read it, 404 if it does not exist.

The metadata #

The Metadata response group is always included. The keys, from ezpRestContentModel:

Use dateModified to decide whether a cached copy in the app is still current (Caching in the app), and fullUrl for a "share" or "open in browser" button.

Links to the fields #

Every read has a links map: one entry per field identifier with the URL of that field, and * with the URL of all fields. The URLs repeat the Translation and OutputFormat parameters of the request. Follow them instead of building paths in the app; it keeps the app working if a path ever changes.

Locations #

An object can sit in several places of the tree. Ask for them with ?ResponseGroups=Locations:

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

(The ids and addresses are invented for the example; the keys are those of getLocationsByContent().) Use the main location for shared links, so every user shares the same address.

A detail screen in one call #

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

This gives the metadata and every field in one answer, which is usually all a detail screen needs. Add Locations only if the screen uses them. The field values are described in Fields and field values; images and rich text need extra care (Images in REST answers, Rich text in apps).

Related pages #

• Response groups
• Listing children and pagination
• How Exponential content reaches an app
• Free documentation: this page is free to copy, translate and improve under the GNU FDL 1.3.