Magnolia 5.6 reached end of life on June 25, 2020. This branch is no longer supported, see End-of-life policy.
Page History
This page describes the delivery endpoint for obtaining JCR data as JSON. The endpoint provides two resources that can be called with HTTP
| Mgnl get |
|---|
| Info | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
Currently we only support a single delivery endpoint configuration. Please note that a preconfigured endpoint is delivered by default in bundles that contain the demo. We plan to support multiple endpoints soon. Keep an eye on
|
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
readNode
Returns one node by a given path, including its properties and child nodes down to a certain depth.
Request URL
| Mgnl get |
|---|
/delivery/{endpointPrefix}/v1/{path}Parameters
| Advanced Tables - Table Plus | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
Example
Get the node of the first component in the main area of the /travel/about page.
| Code Pro |
|---|
curl -X GET 'http://localhost:8080/magnoliaAuthor/.rest/delivery/website/v1/travel/about/main/00' \ -u superuser:superuser |
| Expand | |||||
|---|---|---|---|---|---|
| |||||
The result is based on the basic configuration . |
queryNodes
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 |
|---|
/delivery/{endpointPrefix}/v1?param1=value1¶m2=value2&... Use any of the optional query parameters or none.
Parameters
| Advanced Tables - Table Plus | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||
|
| Anchor | ||||
|---|---|---|---|---|
|
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
Example filter used in a URL:
| 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(meansLIKE)
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(meansIN)not-in(meansNOT IN)
Filter types
Property filter
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 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,
eqis used by default.The
valuein the filter parameter is treated asString.Use brackets to pass an operator, for example
[eq],[ne],[lt], and so on.For
inandnot-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~200is interpreted asprice >= 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-ddCode Block 2018-01-01
Datetime:
yyyy-MM-dd'T'HH:mm:ss.SSSXXXCode 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 | ||||
|---|---|---|---|---|
|
Find webpages in the Travel Demo which were last modified before or on June 3, 2015:
Code Pro 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:pageInfo 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:pageInfo 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
toursworkspace which contain the keyword vietnam. Return the results in the descending order by thelocationproperty 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ähigkeit zum Wandel. Dies wird nirgends deutlicher als in Ho-Chi-Minh-Stadt. Die am Saigon-Fluss gelegene Großstadt ist das perfekte Beispiel für das Nebeneinander von Fortschritt und Tradition. Prächtige Kolonialbauten stehen neben modernen Wolkenkratzern, während sich japanische Autos mit Fahrradrikschas die stark befahrenen Straßen teilen. Wir bringen Sie nicht nur zu den wichtigsten Sehenswürdigkeiten, sondern zeigen Ihnen auch die verborgenen Geschichten, die erklären können, was Vietnam zu dem macht, was es heute ist, und wohin es geht.</p>\n<p>Eine zweitägige Tour durch das Mekong-Delta (Vietnamesisch: Đồng Bằng Sông Cuu Long „Flussdelta der neun Drachen“) taucht Sie in ein Labyrinth des Lebens auf dem Wasser ein, in dem alles auf Booten geschieht, selbst die lokalen Märkte, die Tag für Tag durch ein Floß der Boote der Händler gebildet werden. Wir fahren weiter zur Küstenstadt Vung Tau, um dort im Phuong-Distrikt zu entspannen und wie die Einheimischen zu schwimmen.<br /> Während wir dort sind, besuchen wir den berühmten Weißen Palast, die alte historische Kolonialvilla des franzö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’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’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’s going.</p>\n<p>A two day tour of the Mekong delta (Vietnamese: Đồng bằng Sông Cửu Long "Nine Dragon river delta") 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’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’ll visit the storied White Palace, the historical old colonial villa of the french governor.</p>\n<p>Along the way, you’ll eat some of the finest food you’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
descriptionis 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ührt zum weltberühmten Tiger Beach in den Gewässern vor den Bahamas. Dieser spektakuläre Ort ist einmalig in der Welt. Magnolia Travels garantiert Ihnen eine der einzigstartigen Unterwasser-Erfahrungen überhaupt. Umgeben vom kristallblauen Wasser der Bahamas und perlweißem Sand können Sie Ammenhaie, Riffhaie, Zitronenhaie und Tigerhaie beobachten. Bringen Sie Ihre Kamera mit, es gibt auf dieser Reise keinen Mangel an großartigen Foto- oder Videogelegenheiten. </p>\n<p>Auf dieser Expedition haben Sie Gelegenheit, mit unseren entzückenden und berühmten Tigerhai-„Supermodels“ von Angesicht zu Angesicht zu tauchen: Emma, Baby Cakes, Tanya, Begonia und Mini-T. Unsere „Supermodel“ werden Ihnen dabei helfen, einige der weltweit besten Hai-Fotos zu schießen. Sie lieben es, für die Kamera zu lächeln!</p>\n<p>Natürlich wäre keine Reise auf die Bahamas vollständig ohne Tauchen in den umwerfenden und vielfarbigen Riffen. Sie sind von einer Fülle kleiner und großer Meereslebewesen umgeben; Schönheit und Wunder dieses vibriendenden Ökosystems lassen Sie verstummen. Karibische Riffhaie, große Zackenbarsche, Muränenaale und viele andere Fische wetteifern um Ihre Aufmerksamkeit, während Sie über vielfältige Korallenarten, wellenförmige Seefächer und eine bunte Anordnung von Schwä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. Amidst the crystal blue Bahamian water and powder white sand, you will experience Nurse, Reef, Lemon and Tiger sharks up close and personal. Bring your camera, there is no shortage of great photo or video opportunities on this trip. </p>\n<p>On this expedition you will have the opportunity to dive face-to-face with our lovely and famous Tiger shark “supermodels”: Emma, Baby Cakes, Tanya, Begonia & Mini-T. Our “supermodels” will help you produce some of the world’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. 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. 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. 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
websiteworkspace, 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
Expand 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:
Code Block language yaml class: info.magnolia.rest.delivery.jcr.v1.JcrDeliveryEndpointDefinition params: website: rootPath: / includeSystemProperties: false nodeTypes: - mgnl:page
| Anchor | ||||
|---|---|---|---|---|
|
| Multiexcerpt | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
The delivery endpoint requires a configuration, which can be done in YAML file or via JCR, otherwise, it cannot deliver content. Version 2.0 of the Add the configuration to the
Properties:
A node may contain references to other nodes. With the
Properties of
|
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
Overview
Content Tools