This page describes the delivery endpoint version 1 for obtaining JCR data as JSON. The endpoint provides two resources that can be called with HTTP
.
The endpoint has to be configured, which enables its customization.| 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 | 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-152 |
|---|
|
to see how development is coming along! |
You can create one configuration, which is required in order to use it.
| Note |
|---|
The version 1 of the delivery endpoint is deprecated. We recommend using version 2 instead. |
| Table of Contents |
|---|
| maxLevel | 4 |
|---|
| minLevel | 2 |
|---|
| exclude | Parameters |
|---|
|
...
Read node
Returns one node by a given path, including its properties and child nodes down to a certain depth.
...
| Expand |
|---|
| title | Click to see the resulting JSON |
|---|
|
| Code Pro |
|---|
| {
"@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 result is based on the basic configuration . |
...
Query nodes
Returns a list of nodes matching a query composed of the given query parameters. You also can apply filters to the query.
...