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, which enables its customization.
We plan to support multiple endpoints soon. Keep an eye on MGNLREST-152
-
Getting issue details...STATUS to see how development is coming along!
readNode
Returns one node by a given path, including its properties and child nodes down to a certain depth.
Request URL
GET/delivery/{endpointPrefix}/v1/{path}
Parameters
Parameter
Description
Data type
endpointPrefix
required
The name of an endpoint prefix as configured. Also can 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.
curl -X GET 'http://localhost:8080/magnoliaAuthor/.rest/delivery/website/v1/travel/about/main/00' \
-u superuser:superuser
{
"@name": "00",
"@path": "/travel/about/main/00",
"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’ll always remember.</p> ",
"text_de": "<p>Wir sind eine unabhängige Reiseagentur mit Rundumservice.</p>\n<p>Wir bieten einzigartige Reisen für jeden Kontinent der Erde an. Lassen Sie sich inspirieren und buchen Sie Ihre Reise bei uns, um Erfahrungen zu machen, die Ihnen für immer in Erinnerung bleiben werden.</p> ",
"jcr:createdBy": "admin",
"headline_de": "Über Magnolia Travels",
"mgnl:lastActivatedBy": "superuser",
"mgnl:template": "travel-demo:components/jumbotron",
"mgnl:lastActivated": "2015-10-27T13:50:52.396+0100",
"jcr:created": "2017-10-31T11:53:44.169+0100",
"mgnl:created": "2015-02-02T20:23:37.199+0100",
"imagePosition": "below",
"headlineLevel": "small",
"mgnl:createdBy": "superuser",
"jcr:uuid": "01db6fc1-78af-4284-adf0-8c997309df6a",
"headline": "About Magnolia Travels",
"mgnl:lastModified": "2015-06-18T11:08:06.983+0200",
"mgnl:activationStatus": "true",
"jcr:primaryType": "mgnl:component",
"mgnl:lastModifiedBy": "superuser",
"@nodes": []
}
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
optional,default is 0
The start position in a result list (for pagination)
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 can combine filters with AND operator. See filter options.
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
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
2018-01-01
Datetime: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
2018-01-11T10:26:47.438+07:00
If a filter can take multiple possible values which must match, use | (OR):
@name=travel|about
Examples
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
{
"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": []
}
]
}
Find a tour and filter with the description property (Get photobombed by a Sea Turtle):
curl -X GET \
'http://localhost:8080/magnoliaAuthor/.rest/delivery/tours/v1?description=Get%20photobombed%20by%20a%20Sea%20Turtle' \
-u superuser:superuser
{
"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 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 magnolia-rest-content-delivery module can have only one configuration. You can decorate the definition. Future versions will allow multiple configurations which can be distinguished via a URL parameter.
Add the configuration to the restEndpoints folder in a light module or within src/main/resources/<module-name>/restEndpoints in a Magnolia Maven module.
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 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 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.
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
If set to true , JCR security is bypassed. Use this with care and for development reasons 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.
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.
A map which contains at least one reference definition.
<reference-name>
An arbitrary name for a ReferenceDefinition.
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 ReferenceResolverDefinition.
implementationClass
A class implementing ReferenceResolverDefinition.
Current implementations: UuidReferenceResolver.
targetWorkspace
The name of the workspace where the referenced node resides.
{
"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",
"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",
"tourTypes": {
"@name": "tourTypes",
"@path": "/magnolia-travels/Vietnam--Tradition-and-Today/@tourTypes",
"offPath": {
"@name": "offPath",
"@path": "/tour-types/offPath",
"body_de": "Auf einem großen Reisebus sitzen, Touristengerichte essen und Fotos vom Eiffelturm machen ist nicht Ihre Vorstellung vom Reisen. Sie möchten etwas Neues finden und die Dinge aus dem örtlichen Blickwinkel betrachten. Mit uns können Sie die örtlichen Juwelen entdecken, die die meisten Reisenden nie sehen. ",
"body": "Riding on a big tour bus, eating tourist menus and taking pictures of the Eiffel Tower is not your idea of travelling. You want to find something new, and see things from a local point of view. With us, you can discover the local gems that most travellers never experience. ",
"description_de": "Einzigartige Ferien abseits der ausgetretenen Pfade",
"name": "offPath",
"level": "level-1",
"description": "Unique holidays that take you off the beaten track ",
"displayName_de": "Abseits der Trampelpfade",
"icon": "jcr:6d5d576a-79f9-48d9-b141-6682f2eef585",
"displayName": "Off the Beaten Path",
"image": "jcr:272f75b9-ed87-4e0b-8bf3-15db217ba897",
"@nodes": []
},
"cultural": {
"@name": "cultural",
"@path": "/tour-types/cultural",
"body_de": "Ferien sind für Erlebnisse da, um die bedeutendsten Orte der Welt zu entdecken. Egal ob Chinesische Mauer oder ägyptische Pyramiden, Sie möchten alles darüber wissen. Haben Sie schon einmal daran gedacht, die alten Tempel in Vietnam zu bereisen oder die gewundenen Gassen in Jerusalem? Wir organisieren die besten örtlichen Reiseführer und Hotels, damit Sie die ganze Kultur einfach nur in sich aufnehmen brauchen.",
"body": "Holidays are for experiences, for discovering the greatest places in the world. Whether it’s the Great Wall of China or the Egyptian pyramids, you want to know all about them. And have you thought about visiting the ancient temples of Vietnam or the winding alleyways of Jerusalem? We organize the best local guides and hotels, so you can just soak in all that culture.",
"description_de": "Einmalige Erlebnisse",
"name": "cultural",
"level": "level-1",
"description": "Experiences of a lifetime",
"icon": "jcr:58c420b6-fa30-4578-8af0-c062ba51e5fb",
"displayName_de": "Kultur",
"displayName": "Cultural",
"image": "jcr:a792164f-5a2a-4708-b3c8-62b48a578200",
"@nodes": []
},
"@nodes": [
"offPath",
"cultural"
]
},
"@nodes": [
"tourTypes"
]
}
]
}