Page History

This page describes the delivery endpoint version 1 for obtaining JCR data as JSON. The endpoint provides two resources methods that can be called with HTTP

Mgnl get

. You can only create one configuration, which is required in order a single configuration that is required to use it.

Note
The version Version 1 of the delivery endpoint is deprecated. We recommend using version 2 instead.

Table of Contents

maxLevel	4
minLevel	2
exclude	Parameters

Methods

Read node

Returns one node by a given path, including its properties and child nodes down to a certain depth.

Request URL

Mgnl get

rest<magnolia-base-pathpath>/.rest/delivery/{endpointPrefix}/v1/{path}

Parameters

Advanced Tables - Table Plus

highlightColor	@default
multiple	false
enableHeadingAttributes	false
enableSorting	false
enableHighlighting	false

Parameter

Description

Data type

endpointPrefix

required

The name of an endpoint prefix as configured. Also can May also be a real workspace name.

String

path

required

The path relative to the rootPath defined in the configuration.

String

Example

Get the node of the first component in the main area of the /travel/about page.

...

Expand

title	Click to see the resulting JSON

Code Pro

language	js

{
  "@name": "00",
  "@path": "/travel/about/main/00",
  "@id": "01db6fc1-78af-4284-adf0-8c997309df6a",
  "@nodeType": "mgnl:component",
  "text": "<p>We are a full service, independent travel agency.</p>\n<p>We offer unique tours from every continent on the planet. Get inspired and book your tour with us for an experience you&rsquo;ll always remember.</p> ",
  "text_de": "<p>Wir sind eine unabh&auml;ngige Reiseagentur mit Rundumservice.</p>\n<p>Wir bieten einzigartige Reisen f&uuml;r jeden Kontinent der Erde an. Lassen Sie sich inspirieren und buchen Sie Ihre Reise bei uns, um Erfahrungen zu machen, die Ihnen f&uuml;r immer in Erinnerung bleiben werden.</p> ",
  "headline_de": "Über Magnolia Travels",
  "imagePosition": "below",
  "headlineLevel": "small",
  "headline": "About Magnolia Travels",
  "@nodes": []
}

The This result is based on this configuration:

Code Block

language	yaml

class: info.magnolia.rest.delivery.jcr.v1.JcrDeliveryEndpointDefinition
params:
  website:
    includeSystemProperties: false
    depth: 2
    nodeTypes:
      - mgnl:page
      - mgnl:area
      - mgnl:component
    childNodeTypes:
      - mgnl:area
      - mgnl:component

Query nodes

Returns a list of nodes matching a query composed of the given query parameters. You also can apply filters to the query.

Request URL

Mgnl get

rest-base-path/delivery/{endpointPrefix}/v1?param1=value1&param2=value2&...

Use any of the optional query parameters or none.

Parameters

the basic configuration.

Query nodes

Returns a list of nodes matching a query composed of the query parameters provided. You can also apply filters to the query.

Request URL

Mgnl get

<magnolia-base-path>/.rest/delivery/{endpointPrefix}/v1?param1=value1&param2=value2&...

Use any of the optional query parameters or none.

Parameters

Advanced Tables - Table Plus

highlightColor	@default
multiple	false
enableHeadingAttributes	false
enableSorting	false
enableHighlighting	false

Parameter

Description

Parameter type

Data type

endpointPrefix

required

The name of an endpoint prefix as configured. May also be a real workspace name.

path

String

q

optional

A search phrase (full-text search).

query

String

Anchor

	anc-orderBy
	anc-orderBy

orderBy

optional

The properties by which to order the nodes.

Example: mgnl:lastModified desc,title asc

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 must encode it manually or with an additional tool.

Example: orderBy=title%20asc

Please note that until Magnolia 5.6.5 the results provided by the endpoint were sorted alphabetically on node names (same as with the ORDER BY LOWER(NAME(t)) statement in the JCR-SQL2 query) even though no orderBy parameter was set in the request URL.

Since Magnolia 5.6.5 the results are returned unsorted if no orderBy parameter is set. This however does not mean "in natural order" since many other aspects may be involved, such as the setting of the respectDocumentOrder property or index consistency. For more information, see Apache Jackrabbit Search and Rebuilding the Index.

query

String

offset

optional, default is 0

The start position in a result list (for pagination).

query

Integer

limit

optional, default is as set in configuration

The number of nodes displayed in a page query. Use

Advanced Tables - Table Plus

highlightColor	@default
multiple	false
enableHeadingAttributes	false
enableSorting	false
enableHighlighting	false

optional, default is 0

The start position in a result list (for pagination)

Parameter	Description	Parameter type	Data type
`endpointPrefix`	required The name of an endpoint prefix as configured. Also can be a real workspace name.	`path`	`String`
`q`	optional A search phrase (full-text search)	`query`	`String`
`orderBy`	optional The properties by which to order the nodes. Example: `mgnl:lastModified desc,title asc` 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`	`query`	`String`
`offset`	`query`	`Integer`	`limit`	optional, default is as set in configuration The number of nodes displayed in a pagequery. Used together with `offset` for pagination.	`query`	`Integer`
`<filter>`	optional There are multiple filter options to filter for a property of the node, for node names, for nodes which must be ancestors of a given path, you and so on. You can combine filters with an `AND` operator. See filter options.

Anchor
queryNodes-filter
queryNodes-filter
Filters

queryNodes provides a filtering mechanism. Filters are added as request parameters. Filter values must be properly URL-encoded. You can use multiple filters within the same request.

Filter format

The filter parameter has the following format: property[operator]=value

...

Code Block
https://example.com/.rest/delivery/pages/v1?title[like]=tour

Supported filter operators

eq (means =)
ne (means <>)
lt (means <)
gt (means >)
lte (means <=)
gte (means >=)
like (means LIKE)
Two wildcard characters can be used in the search pattern:
- - % (percentage, URL encoded as %25) stand for zero or more additional characters.
  - _ (underscore) stands for any one character.
in (means IN)
not-in (means NOT IN)

Filter types

Property filter

Include Page

	_filter operators
	_filter operators

Filter types

Property filter

Filter for a node Filter for a node property. The property value must be an exact match.

Code Block
author=Magnolia%20Travels

@name property filter

Filter by a node name.

Code Block
@name=travel

@ancestor filter

Find nodes for whom which the path provided is the ancestor. The path must be absolute in the given workspace of the given workspace prefix.

Code Block
@ancestor=/travel/about/careers/marketing-associate

Usage notes

If no operator is provided, eq is used by default.
The value in the filter parameter is treated as String .
Use brackets to pass an operator, for example [eq], [ne], [lt], and so on.
For in and not-in, a range symbol ~ (the tilde) should be provided, for example:
Code Block
https://example.com/.rest/delivery/pages/v1?mgnl:created[in]=2018-01-01~2018-02-01
Ranges are inclusive: price[in]=100~200 is interpreted as price >= 100 AND price <= 200.

For filtering by date and time, only two ISO 8601-based formats are accepted. The patterns shown are in JAVA notation (

java.text.SimpleDateFormat

):

Date: yyyy-MM-dd
Code Block
2018-01-01
Datetime: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
Code Block
2018-01-11T10:26:47.438+07:00

If a filter can take multiple possible values which must match, use | (OR):
Code Block
@name=travel|about

...

Find webpages in the Travel Demo which were last modified before or on June 3, 2015:

Code Pro

language	bash

curl -X GET 'http://localhost:8080/magnoliaAuthor/.rest/delivery/website/v1?mgnl:lastModified\[lte\]=2015-06-03' \
-u superuser:superuser

(The brackets have been escaped with the backslash character ( \ ) for the command to work correctly in bash.)

Expand

title	Click to see the resulting JSON

Code Pro

language	js
linenumbers	true

{
  "results": [{
    "@name": "meta",
    "@path": "/travel/meta",
    "@id": "7ebd74f1-c6f7-4307-9953-afd549118a56",
    "@nodeType": "mgnl:page",
    "jcr:createdBy": "admin",
    "hideInNav": "true",
    "mgnl:template": "travel-demo:pages/standard",
    "mgnl:lastActivatedBy": "superuser",
    "jcr:created": "2018-03-09T13:47:38.468+01:00",
    "mgnl:lastActivated": "2018-03-09T13:47:50.329+01:00",
    "mgnl:created": "2015-02-02T20:58:23.939+01:00",
    "mgnl:createdBy": "superuser",
    "title": "Container for meta pages",
    "mgnl:lastModified": "2015-06-03T20:37:49.283+02:00",
    "mgnl:activationStatus": "true",
    "mgnl:lastModifiedBy": "superuser",
    "@nodes": []
  }]
}

The result is returned for the following configuration:

Code Block

language	yaml

class: info.magnolia.rest.delivery.jcr.v1.JcrDeliveryEndpointDefinition
params:
  website:
    rootPath: /
    nodeTypes:
      - mgnl:page

Info

Please note that the logic of the "equal" filtering operation before the release of REST 2.1 was slightly different. In order to obtain the above response you would have to send the following request:

Code Pro
curl -X GET 'http://localhost:8080/magnoliaAuthor/.rest/delivery/website/v1?mgnl:lastModified\[lte\]=2015-06-04' \ -u superuser:superuser

(

Jira

server	Magnolia - Issue tracker
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	500b06a6-e204-3125-b989-2d75b973d05f
key	MGNLREST-170

)

Find webpages whose title is either Story or Stories. This can be done in two ways:

Code Pro
curl -X GET 'http://localhost:8080/magnoliaAuthor/.rest/delivery/website/v1?title=Story\|Stories' \ -u superuser:superuser

Code Pro
curl -X GET 'http://localhost:8080/magnoliaAuthor/.rest/delivery/website/v1?title\[like\]=Stor%25' \ -u superuser:superuser

(The brackets have been escaped with the backslash character ( \ ) for the command to work correctly in bash.)

Expand

title	Click to see the resulting JSON

Code Pro

language	js
linenumbers	true

{
  "results": [{
    "@name": "stories",
    "@path": "/travel/stories",
    "@id": "f8cbedd6-df91-4d7c-a952-2dc414d97704",
    "@nodeType": "mgnl:page",
    "title": "Stories",
    "@nodes": []
  }, {
    "@name": "story",
    "@path": "/travel/stories/story",
    "@id": "a096ec20-c190-4b2e-91a4-294c99b64049",
    "@nodeType": "mgnl:page",
    "hideInNav": "true",
    "title": "Story",
    "@nodes": []
  }]
}

The result is returned for the following configuration:

Code Block

language	yaml

class: info.magnolia.rest.delivery.jcr.v1.JcrDeliveryEndpointDefinition
params:
  website:
    rootPath: /
    includeSystemProperties: false
    nodeTypes:
      - mgnl:page

Info

Please note that the logic of the "equal" filtering operation before the release of REST 2.1 was slightly different. In order to obtain the above response you would have to send the following request:

Code Pro
curl -X GET 'http://localhost:8080/magnoliaAuthor/.rest/delivery/website/v1?mgnl:lastModified\[lte\]=2015-06-04' \ -u superuser:superuser

(

Jira

server	Magnolia - Issue tracker
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	500b06a6-e204-3125-b989-2d75b973d05f
key	MGNLREST-170

)

Find nodes in the tours workspace which contain the keyword vietnam. Return the results in the descending order by the location property and restrict the limit to one:

Code Pro
curl -X GET 'http://localhost:8080/magnoliaAuthor/.rest/delivery/tours/v1?q=vietnam&orderBy=location%20desc&limit=1' \ -u superuser:superuser

Expand

title	Click to see the resulting JSON

Code Pro

language	js
linenumbers	true

{
  "results": [
    {
      "@name": "Vietnam--Tradition-and-Today",
      "@path": "/magnolia-travels/Vietnam--Tradition-and-Today",
      "isFeatured": "true",
      "name": "Vietnam: Tradition and Today",
      "description": "Discover the culture and everyday treasures of a rising phoenix",
      "location": "Ho Chi Minh City, Vietnam",
      "tourTypes": [
        "415025c6-e4b5-4506-9384-34f428a52104",
        "e007e401-1bf8-4658-8293-b9c743784264"
      ],
      "author": "Magnolia Travels",
      "body_de": "<p>Vietnam ist eine der exotischsten und kulturreichsten Destinationen weltweit. Als Juwel unter Juwelen bietet es dem Besucher schillernde Vielfalt. Doch was die meisten so faszinierend finden, ist seine F&auml;higkeit zum Wandel. Dies wird nirgends deutlicher als in Ho-Chi-Minh-Stadt. Die am Saigon-Fluss gelegene Gro&szlig;stadt ist das perfekte Beispiel f&uuml;r das Nebeneinander von Fortschritt und Tradition. Pr&auml;chtige Kolonialbauten stehen neben modernen Wolkenkratzern, w&auml;hrend sich japanische Autos mit Fahrradrikschas die stark befahrenen Stra&szlig;en teilen. Wir bringen Sie nicht nur zu den wichtigsten Sehensw&uuml;rdigkeiten, sondern zeigen Ihnen auch die verborgenen Geschichten, die erkl&auml;ren k&ouml;nnen, was Vietnam zu dem macht, was es heute ist, und wohin es geht.</p>\n<p>Eine zweit&auml;gige Tour durch das Mekong-Delta (Vietnamesisch: Đồng Bằng S&ocirc;ng Cuu Long &bdquo;Flussdelta der neun Drachen&ldquo;) taucht Sie in ein Labyrinth des Lebens auf dem Wasser ein, in dem alles auf Booten geschieht, selbst die lokalen M&auml;rkte, die Tag f&uuml;r Tag durch ein Flo&szlig; der Boote der H&auml;ndler gebildet werden. Wir fahren weiter zur K&uuml;stenstadt Vung Tau, um dort im Phuong-Distrikt zu entspannen und wie die Einheimischen zu schwimmen.<br /> W&auml;hrend wir dort sind, besuchen wir den ber&uuml;hmten Wei&szlig;en Palast, die alte historische Kolonialvilla des franz&ouml;sischen Gouverneurs.</p>\n<p>Unterwegs werden Sie mit das beste Essen zu sich nehmen, das Sie jemals gegessen haben und wir werden Ihnen eventuell sogar beibringen, wie es zubereitet wird.</p> ",
      "body": "<p>Vietnam is one of the world&rsquo;s most exotic and culturally rich destinations. A gem among gems, it offers dazzling diversity for visitors. Yet what most find so fascinating is its capacity for change. This is nowhere more evident than in Ho Chi Minh City. Set on the Saigon river, the capital is the perfect example of progress and tradition living side-by-side. Grand colonial buildings stand alongside modern skyscrapers while Japanese cars share the busy roads with cycle rickshaws.</p>\n<p>We won&rsquo;t just take you to the key sights, but also reveal the hidden stories that explain what makes Vietnam what it is today, and where it&rsquo;s going.</p>\n<p>A two day tour of the Mekong delta (Vietnamese: Đồng bằng S&ocirc;ng Cửu Long &quot;Nine Dragon river delta&quot;) will immerse you in a water-world maze where everything happens on the boats - even local markets which form every day from a raft of vendors boats. We&rsquo;ll continue to the coastal town of Vung Tau in the Phuong district to relax and swim like the locals do.</p>\n<p>While there we&rsquo;ll visit the storied White Palace, the historical old colonial villa of the french governor.</p>\n<p>Along the way, you&rsquo;ll eat some of the finest food you&rsquo;ve ever eaten, and we might even teach you to cook it too.</p> ",
      "description_de": "Entdecken Sie die Kultur und die alltäglichen Schätze eines Phoenix aus der Asche",
      "destination": [
        "7ec72c48-c33f-418e-b2ff-44cfb4bbb1f2"
      ],
      "duration": "14",
      "name_de": "Vielfältiges Vietnam",
      "image": "jcr:1044b3b8-30b1-48fe-8078-832b6cef8fb5",
      "@nodes": []
    }
  ]
}

The result is based on the basic configuration.

Find a tour whose description is Get photobombed by a Sea Turtle:

Code Block
curl -X GET \ 'http://localhost:8080/magnoliaAuthor/.rest/delivery/tours/v1?description=Get%20photobombed%20by%20a%20Sea%20Turtle' \ -u superuser:superuser

Expand

title	Click to see the resulting JSON

Code Pro

language	js
linenumbers	true

{
  "results": [
    {
      "@name": "Scuba-Diving-in-Bahamas--famed-Tiger-Beach",
      "@path": "/magnolia-travels/Scuba-Diving-in-Bahamas--famed-Tiger-Beach",
      "isFeatured": "true",
      "name": "Scuba Diving at Tiger Beach",
      "description": "Get photobombed by a Sea Turtle",
      "location": "Miami, USA",
      "tourTypes": [
        "d2245867-ecaa-4b4e-8743-e0c939be68b7",
        "eaf9a648-fae1-48ae-a293-69bed874f159"
      ],
      "author": "Magnolia Travels",
      "body_de": "<p>Unsere beliebteste aktive Tour f&uuml;hrt zum weltber&uuml;hmten Tiger Beach in den Gew&auml;ssern vor den Bahamas. Dieser spektakul&auml;re Ort ist einmalig in der Welt. Magnolia Travels garantiert Ihnen eine der einzigstartigen Unterwasser-Erfahrungen &uuml;berhaupt. Umgeben vom kristallblauen Wasser der Bahamas und perlwei&szlig;em Sand k&ouml;nnen Sie Ammenhaie, Riffhaie, Zitronenhaie und Tigerhaie beobachten. Bringen Sie Ihre Kamera mit, es gibt auf dieser Reise keinen Mangel an gro&szlig;artigen Foto- oder Videogelegenheiten. &nbsp;</p>\n<p>Auf dieser Expedition haben Sie Gelegenheit, mit unseren entz&uuml;ckenden und ber&uuml;hmten Tigerhai-&bdquo;Supermodels&ldquo; von Angesicht zu Angesicht zu tauchen:&nbsp; Emma, Baby Cakes, Tanya, Begonia und Mini-T. Unsere &bdquo;Supermodel&ldquo; werden Ihnen dabei helfen, einige der weltweit besten Hai-Fotos zu schie&szlig;en. Sie lieben es, f&uuml;r die Kamera zu l&auml;cheln!</p>\n<p>Nat&uuml;rlich w&auml;re keine Reise auf die Bahamas vollst&auml;ndig ohne Tauchen in den umwerfenden und vielfarbigen Riffen. Sie sind von einer F&uuml;lle kleiner und gro&szlig;er Meereslebewesen umgeben;&nbsp; Sch&ouml;nheit und Wunder dieses vibriendenden &Ouml;kosystems lassen Sie verstummen. Karibische Riffhaie, gro&szlig;e Zackenbarsche, Mur&auml;nenaale und viele andere Fische wetteifern um Ihre Aufmerksamkeit, w&auml;hrend Sie &uuml;ber vielf&auml;ltige Korallenarten, wellenf&ouml;rmige Seef&auml;cher und eine bunte Anordnung von Schw&auml;mmen gleiten. Beginnen Sie noch heute, mit uns Ihre Erinnerungen zu gestalten!</p> ",
      "body": "<p>Our most popular active tour is to the world-famous Tiger Beach in the waters off the Bahamas. This spectacular location is unlike any other in the world. Magnolia Travels guarantees you will have one of the most unique underwater experiences ever. &nbsp;Amidst the crystal blue Bahamian water and powder white sand, you will experience Nurse, Reef, Lemon and Tiger sharks up close and personal. &nbsp;Bring your camera, there is no shortage of great photo or video opportunities on this trip. &nbsp;</p>\n<p>On this expedition you will have the opportunity to dive face-to-face with our lovely and famous Tiger shark &ldquo;supermodels&rdquo;: &nbsp;Emma, Baby Cakes, Tanya, Begonia &amp; Mini-T. &nbsp;Our &ldquo;supermodels&rdquo; will help you produce some of the world&rsquo;s best shark photography. They love to smile for the camera!</p>\n<p>Of course, no trip to the Bahamas would be complete without diving the dazzling and colorful reefs. &nbsp;Surrounded by an abundance of marine life, both large and small, you will be in awe of the beauty and wonder of this vibrant ecosystem. &nbsp;Caribbean Reef sharks, large groupers, moray eels and numerous fish will compete for your attention as you hover above the multiple species of coral, undulating sea fans, and colorful array of sponges. &nbsp;Start making your memories with us today!</p> ",
      "description_de": "Lassen Sie sich von einer Meeresschildkröte überraschen, die plötzlich auf Ihrem Foto erscheint",
      "destination": [
        "ed3dcd18-78af-46df-a9e1-bc732479f2e7"
      ],
      "duration": "14",
      "name_de": "Tauchen am Tiger Beach",
      "image": "jcr:795449d2-6c16-402e-9e8a-bbb101fe22bb",
      "@nodes": []
    }
  ]
}

The result is based on the basic configuration.

In the website workspace, find all nodes for whom /travel/about/careers is the ancestor:

Code Block
curl -X GET \ 'http://localhost:8080/magnoliaAuthor/.rest/delivery/website/v1?@ancestor=/travel/about/careers' \ -u superuser:superuser

-in, a range symbol ~ (the tilde) should be provided, for example:

Code Block
https://example.com/.rest/delivery/pages/v1?mgnl:created[in]=2018-01-01~2018-02-01

Ranges are inclusive: price[in]=100~200 is interpreted as price >= 100 AND price <= 200.
For filtering by date and time, only two ISO 8601-based formats are accepted. The patterns shown are in JAVA notation (java.text.SimpleDateFormat):
- Date: yyyy-MM-dd
  Code Block
  2018-01-01
- Datetime: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
  Code Block
  2018-01-11T10:26:47.438+07:00
If a filter can take multiple possible values which must match, use | (OR):
Code Block
@name=travel|about

Anchor
example-queryNodes
example-queryNodes
Examples

Include Page

	_REST delivery endpoint v1 filter examples
	_REST delivery endpoint v1 filter examples

...

title	Click to see the resulting JSON

Code Pro

language	js
linenumbers	true

{
  "results": [{
    "@name": "customer-experience-agent",
    "@path": "/travel/about/careers/customer-experience-agent",
    "@id": "1f8af166-258f-4351-a543-3d0fc8bb00c0",
    "@nodeType": "mgnl:page",
    "hideInNav": "false",
    "title": "Customer Experience Agent",
    "title_de": "Kundenerlebnisvermittler",
    "@nodes": []
  }, {
    "@name": "customer-experience-supervisor",
    "@path": "/travel/about/careers/customer-experience-supervisor",
    "@id": "c8e6902a-499a-44d7-9de9-45fd93d60a6b",
    "@nodeType": "mgnl:page",
    "hideInNav": "false",
    "title": "Customer Experience Supervisor",
    "title_de": "Kundenerlebnisteamleiter",
    "@nodes": []
  }, {
    "@name": "marketing-associate",
    "@path": "/travel/about/careers/marketing-associate",
    "@id": "f19c60f2-3049-4883-a170-4bf65e3abb91",
    "@nodeType": "mgnl:page",
    "hideInNav": "false",
    "title": "Marketing Associate",
    "title_de": "Marketingmitarbeiter/in",
    "@nodes": []
  }]
}

The result is returned for the following configuration:

...

language	yaml

...

Anchor
configuration
configuration
Configuration

Multiexcerpt

MultiExcerptName	configuration

The delivery endpoint requires a configuration, otherwise, or it cannot deliver content. Version 1 of the delivery endpoint can only have only one configuration. You can decorate the definition.

Add the configuration to the restEndpoints folder in a light module, within src/main/resources/<module-name>/restEndpoints in a Magnolia Maven module or as JCR in the configuration workspace.

Anchor
basic-config
basic-config
Basic configuration

Code Pro

language	yaml
title	my-lightmodule/restEndpoints /my-endpoint.yaml

class: info.magnolia.rest.delivery.jcr.v1.JcrDeliveryEndpointDefinition
params:
  website:
    depth: 2
    nodeTypes:
      - mgnl:page
      - mgnl:area
      - mgnl:component
    childNodeTypes:
      - mgnl:area
      - mgnl:component
    rootPath: /
  trips:
    workspace: tours
    includeSystemProperties: false

Properties:

class

required

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

implementationClass

optional, default =is info.magnolia.rest.delivery.jcr.v1.JcrDeliveryEndpoint

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

params

required

The map defining at least one or more endpoint prefixes.

<endpointPrefix>

required

Defines an endpoint prefix where requests will be are routed and handled according to the associated workspace parameters parameter below.

The value can be an arbitrary name (no special characters !allowed) - , or it can be a real workspace name. If it is not a real workspace name, you must provide the sub property workspace.

workspace

optional

The name of the JCR workspace to deliver content from.

Must be set if the parent <endpointPrefix> is not a real workspace name.

nodeTypes

optional, default is mgnl:content

A list of allowed node types for depth-0 nodes. mgnl:folder is ignored deliberately.

childNodeTypes

optional, default is mgnl:contentNode

A list of allowed node types for child nodes.

depth

optional, default is 0

The depth of child nodes to display in the result.

includeSystemProperties

optional,default is true

Specifies whether the result should show system properties.

rootPath

optional

The root path of this endpoint.

The path information when requesting the endpoint is added to this path.

bypassWorkspaceAcls

optional, default is false

Note
If set to `true`, JCR security is bypassed. Use this property with care and for development reasons purposes only!.

limit

optional, default is 10

The number of nodes (of level 0) in the result. Used only in the queryNodes method.

The property can be overridden when calling queryNodes with a request parameter.

Anchor
anc-reference-resolving-configuration
anc-reference-resolving-configuration
Reference resolving configuration

A node may contain references to other nodes. With the references property, you can extend the configuration to force it to resolve the referenced nodes per workspace.

Code Pro

language	yaml
linenumbers	true

class: info.magnolia.rest.delivery.jcr.v1.JcrDeliveryEndpointDefinition
params:
  trips:
    workspace: tours
    includeSystemProperties: false
    references:
      tour-types:
        propertyName: tourTypes
        referenceResolver:
          implementationClass: info.magnolia.rest.reference.jcr.UuidReferenceResolver
          targetWorkspace: category

Properties of references:

references A map which contains at least one reference definition.

<reference-name>

An arbitrary name for a

Javadoc resource link

className	info.magnolia.rest.reference.ReferenceDefinition
renderType	asynchronous

.

propertyName

The name of the JCR property which stores the reference. It can be a multi-value property.

referenceResolver

The reference resolver definition for this reference. Its definition class is

Javadoc resource link

className	info.magnolia.rest.reference.ReferenceResolverDefinition
renderType	asynchronous

.

implementationClass

A class implementing

Javadoc resource link

className	info.magnolia.rest.reference.ReferenceResolverDefinition
renderType	asynchronous

.

Current implementations:

Javadoc resource link

className	info.magnolia.rest.reference.jcr.UuidReferenceResolver
renderType	asynchronous

.

targetWorkspace

The name of the workspace where the referenced node resides.

...

Page tree

Versions Compared

Old Version 6

New Version Current

Key

Methods

Read node

Request URL

Parameters

Example

Query nodes

Request URL

Parameters

Query nodes

Request URL

Parameters

Anchor
queryNodes-filter
queryNodes-filter
Filters

Filter format

Supported filter operators

Filter types

Property filter

Filter types

Usage notes

Anchor
example-queryNodes
example-queryNodes
Examples

Anchor
configuration
configuration
Configuration

Anchor
basic-config
basic-config
Basic configuration

Anchor
anc-reference-resolving-configuration
anc-reference-resolving-configuration
Reference resolving configuration

Page tree

Page History

Versions Compared

Old Version 6

New Version Current

Key

Methods

Read node

Request URL

Parameters

Example

Query nodes

Request URL

Parameters

Query nodes

Request URL

Parameters

AnchorqueryNodes-filterqueryNodes-filterFilters

Filter format

Supported filter operators

Filter types

Property filter

Filter types

Usage notes

Anchorexample-queryNodesexample-queryNodesExamples

AnchorconfigurationconfigurationConfiguration

Anchorbasic-configbasic-configBasic configuration

Anchoranc-reference-resolving-configurationanc-reference-resolving-configurationReference resolving configuration

Anchor
queryNodes-filter
queryNodes-filter
Filters

Anchor
example-queryNodes
example-queryNodes
Examples

Anchor
configuration
configuration
Configuration

Anchor
basic-config
basic-config
Basic configuration

Anchor
anc-reference-resolving-configuration
anc-reference-resolving-configuration
Reference resolving configuration