Magnolia 5.6 reached end of life on June 25, 2020. This branch is no longer supported, see End-of-life policy.
This page describes the delivery endpoint for obtaining JCR data as JSON. The endpoint provides two resources that can be called with HTTP GET . The endpoint has to be configured via YAML, which enables its customization.
readNode
Returns one node by a given path, including its properties and child nodes down to a certain depth.
GET /delivery/{endpointPrefix}/v1/{path}
Parameter | Description | Data type |
| required The name of an endpoint prefix as configured in YAML. Also can be a real workspace name. |
|
| required The path relative to the |
|
Get the node of the first component in the main
area of the /travel/hello
page.
curl -X GET 'http://localhost:8080/magnoliaAuthor/.rest/delivery/website/v1/travel/about/main/00' \ -u superuser:superuser
queryNodes
Returns a list of nodes matching a query composed of the given query parameters.
GET /delivery/{endpoint-prefix}/v1?param1=value1¶m2=value2&...
Use any of the optional query parameters or none.
Parameter | Description | Parameter type | Data type |
| required The name of an endpoint prefix as configured in YAML. Also can be a real workspace name. |
|
|
| optional A search phrase (full-text search) |
|
|
| optional The properties by which to order the nodes. Example: |
|
|
offset | optional, default is The start position in a result list (for pagination) | query | Integer |
| optional, default: as set in YAML configuration The number of nodes displayed in a page query. Used together with |
|
|
*) Note that special characters such as a space (
) must be encoded when sent in an HTTP request. When using tools to generate a REST request, this may happen automatically. With simple cURL you have to encode it manually or with an additional tool. Example: orderBy=title%20asc
Search nodes in the tours
workspace which contain the keyword vietnam . Return the results in descending order by the location
property 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
The delivery endpoint requires a YAML configuration or otherwise it cannot deliver content. Version 2.0 of the Add the configuration to the Properties: required Must be required Must be required The map defining at least one or more workspaces. required Defines an endpoint prefix where requests will be routed and handled according to the associated workspace parameters below. The value can be an arbitrary name (no special characters!) - or it can be a real workspace name. If its not a real workspace name, you must provide the sub property optional The name of the JCR workspace to deliver content from. Must be set if the parent optional default= A list of allowed node types for depth-0 nodes. optional default= A list of allowed node types for child nodes. optional, default is The depth of subnodes to display in the result. optional, default is Specifies whether the result should show system properties. required The root path of this endpoint. The path information when requesting the endpoint is added to this path. optional, default is If set to optional, default is The number of nodes (of level 0) in the result. Used only in the *) The property can be overridden when calling A node may contain references to other nodes. With the 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 a URL parameter.restEndpoints
folder in a light module or within src/main/resources/<module-name>/restEndpoints
in a Magnolia Maven module.Basic configuration
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
class
info.magnolia.rest.delivery.jcr.JcrDeliveryEndpointDefinition
or a subclass.implementationClass
info.magnolia.rest.delivery.jcr.v1.JcrDeliveryEndpoint
or a subclass.params
<endpointPrefix>
workspace
.workspace
<endpointPrefix>
is not a real workspace name.nodeTypes
mgnl:content
childNodeTypes
mgnl:contentNode
depth
0
includeSystemProperties
true
rootPath
bypassWorkspaceAcls
false
true
, JCR security is bypassed. Use this with care and for development reasons only!limit
*10
queryNodes
method.queryNodes
with a request parameter.Reference resolving configuration
references
property you can extend the configuration to force it to resolve the referenced nodes per workspace.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
:references
A map which contains at least one reference definition. <reference-name>
propertyName
The name of the JCR property which stores the reference. It can be a multi-value property. referenceResolver
implementationClass
targetWorkspace
The name of the workspace where the referenced node resides.