Magnolia 5.6 reached end of life on June 25, 2020. This branch is no longer supported, see End-of-life policy.
This page explains the delivery endpoint, which can be used to obtain JCR data as JSON.
The endpoint provides two resources to be called with HTTP GET.
The delivery endpoint must be configured via YAML. Its next version will allow multiple named configurations which can be distinguished by URL path parameter.
Methods
readNode
Returns one node by a given path including its properties and child nodes down to a certain depth.
Request URL
GET /delivery/{workspace}/v1/{path}
Parameters
Parameter | Description | Data type |
| required The name of the workspace. |
|
| required The path relative to the |
|
Example
Get the node of the first component in the area main of the page /travel/hello.
curl -X GET 'http://localhost:8080/magnoliaAuthor/.rest/delivery/website/v1/travel/hello/main/0' \ -u superuser:superuser
queryNodes
Returns a list of nodes matching a query which is composed by the given query parameters.
Request URL
GET /delivery/{workspace}/v1?param1=value1¶m2=value2&...
You can use any of the optional query parameters or none.
Parameters
Parameter | Description | Parameter type | Data type |
| required The name of the workspace. |
|
|
| optional Comma-separated string of primary node types. |
|
|
| optional Text to search (full-text search). |
|
|
| optional The properties to order the nodes. Example: |
|
|
offset | optional (default=0) Starting position in a result list (to use for pagination) | query | Integer |
| optional ( default: as set in YAML configuration) The number of nodes displayed in a page query. (To use togehter with |
|
|
*) Note that special characters such as a space ( ) must be encodeded when sent in an HTTP request. When using tools to generate a REST request, this may happen automatically. With simple cURL you must encode it manually (or with an additional tool). Example: orderBy=title%20asc
Example
Search nodes in the workspace tours which contain the keyword vietnam, order the result descending by the property location and restrict the limit to one.
curl -X GET 'http://localhost:8080/magnoliaAuthor/.rest/delivery/tours/v1?q=vietnam&orderBy=location%20desc&limit=1' \ -u superuser:superuser
YAML configuration
The delivery endpoint requires a YAML configuration - otherwise it cannot deliver content. Version 2.0 of the Add the configuration to the folder Properties: required Must be required Must be required The map defining at least one ore more workspace parameters. required The name of the JCR workspace to deliver content from. You define as many workspaces as you need. You define one workspace with the below properties. (The definiton class is WorkspaceParameters). required An list of allowed node types. optional (default=0) The depth of subnodes to shwo in the result optional (default=true) Whether the result should show the system properties. required The root path of this endpoint. Path information when requesting the endpoint is added to this path. optional (default=false) When set to true JCR - security is bypassed. Use with care and for development reasons only! optional (default=10) The number of nodes (of level 0) in the result. Only used in *) These properties can be overridden when calling A node may contain references to other nodes. You can extend the configuration to force it to resolve referenced nodes per workspace with the property Properties of An arbitrary name for a ReferenceDefinition. The reference resolver definition for this reference, its definition class is ReferenceResolverDefinition. A class implementing ReferenceResolverDefinition. Current implementations: UuidReferenceResolvermagnolia-rest-content-delivery module can have only one configuration. (Future versions will allow multiple configurations which can be distinguished via URL parameter.)restEndpoints in a light module or within src/main/resources/<module-name>/restEndpoints in a Magnolia Maven module.Basic configuration
my-lightmodule/restEndpoints /my-endpoint.yaml
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: /
dam:
depth: 1
includeSystemProperties: false
nodeTypes:
- mgnl:asset
- mgnl:folder
rootPath: /travel-demoe
classinfo.magnolia.rest.delivery.jcr.JcrDeliveryEndpointDefinition or a subclass.implementationClassinfo.magnolia.rest.delivery.jcr.v1.JcrDeliveryEndpoint or a subclass.params<workspace-name>nodeTypes*depth*includeSystemPropertiesrootPathbypassWorkspaceAclslimit*queryNodes method.queryNodes with a request parameter.Reference resolving configuration
references
class: info.magnolia.rest.delivery.jcr.JcrDeliveryEndpointDefinition
implementationClass: info.magnolia.rest.delivery.jcr.v1.JcrDeliveryEndpoint
params:
tours:
depth: 1
includeSystemProperties: false
nodeTypes:
- mgnl:content
- mgnl:folder
rootPath: /
references:
tour-types:
propertyName: tourTypes
referenceResolver:
implementationClass: info.magnolia.rest.reference.jcr.UuidReferenceResolver
targetWorkspace: category
references:referencesA map which contains at least one reference definition. <reference-name>propertyNameThe name of the JCR property which stores the reference. (Can be a multi-value property). referenceResolverimplementationClasstargetWorkspaceThe name of the workspace where the referenced node resides.
Overview
Content Tools