Versions Compared

Old Version 128

changes.mady.by.user Christoph Meier

Saved on

compared with

New Version 129

changes.mady.by.user Christoph Meier

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents
maxLevel3
minLevel2

Methods

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}

...

Advanced Tables - Table Plus
highlightColor@default
multiplefalse
enableHeadingAttributesfalse
enableSortingfalse
enableHighlightingfalse


Parameter

Description

Data type

endpointPrefix

required

The name of an endpoint prefix as configured in YAML. 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.

...

Expand
titleClick to see the resulting JSON


Code Pro
languagejs
{
  "@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&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> ",
  "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.


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&param2=value2&... 

...

*) 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

Anchor
queryNodes-filter
queryNodes-filter
Filters

queryNodes provides a filtering mechanism with the following features. Filters are added as request parameters.

...

Filter for a property of the node. Example: author=Magnolia%20Travels*


Anchor
example-queryNodes
example-queryNodes
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.

...