Page History

This page explains Use the delivery endpoint, which can be used API to obtain JCR data as JSON.

The endpoint provides two REST resources - readNode and queryNodes - both must be called with HTTP 

The delivery endpoint must be configured via YAML. Its next version will allow multiple named configurations which can be distinguished by URL path parameter.

YAML configuration

The delivery endpoint requires a YAML configuration - otherwise it cannot deliver cannot. Add the configuration to the folder your-light-module/restEndpoints/.

class: info.magnolia.rest.delivery.jcr.JcrDeliveryEndpointDefinition
implementationClass: info.magnolia.rest.delivery.jcr.v1.JcrDeliveryEndpoint
params:
  website:
    depth: 3
    includeSystemProperties: false
    nodeTypes:
      - mgnl:page
      - mgnl:area
      - mgnl:component
    rootPath: /
    limit: 10
    bypassWorkspaceAcls: true
  dam:
    depth: 1
    includeSystemProperties: false
    nodeTypes:
      - mgnl:asset
      - mgnl:folder
    rootPath: /
    limit: 10
    bypassWorkspaceAcls: false

...

Required

Must be info.magnolia.rest.delivery.jcr.JcrDeliveryEndpointDefinition or a subclass.

...

Required

Must be info.magnolia.rest.delivery.jcr.v1.JcrDeliveryEndpoint or a subclass.

...

Required

The map defining at least one ore more workspace parameters.

This REST resource is customizable and flexible to use.

Two versions of the delivery endpoint exist. Both versions can resolve references to nodes of other JCR workspaces. But only version 2 can deliver localized content.

Delivery endpoint v2

Version 2 was introduced with Magnolia REST 2.1 and provides more flexibility. You can use it to define multiple endpoint configurations, deliver localized content and resolve references to nodes of other workspaces including assets and asset renditions.

See Delivery endpoint API v2.

Delivery endpoint v1

Version 1 was introduced with Magnolia REST 2.0. You can configure a single endpoint for your project.

See Delivery endpoint API v1.

Methods

readNode

Returns a node including its properties and child nodes down to a certain depth.

Request URL

..

Parameters

..

Example

...

queryNodes

..