Versions Compared

Key

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

...

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.

Format and operators

Format

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
  • in means IN
  • not-in means NOT IN

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
  • 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 have multiples possible values which must match, use | (OR):

    Mgnl mini code snippet
    Stylesimple

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

Filter types

Property filter

Filter for a property of the node. Thev value for the property must be an exact match.

Mgnl mini code snippet
Stylesimple

author=Magnolia%20Travels

@name property filter

Filter for the node name.

Mgnl mini code snippet
Stylesimple

@name=travel

@ancestor filter

Filter for ancestor nodes of a provided path. The path must be absolute on the given workspace of the given workspace prefix.

Mgnl mini code snippet
Stylesimple

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

Using OR | to provide multiple filter values

One filter can have multiples possible values which must match.

Mgnl mini code snippet
Stylesimple

@name=travel|about

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.

...