Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: unhide MGNLREST-120

...

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

The filter parameter has the following format:  property[operator]=value . For example, https://example.com/.rest/delivery/pages/v1?title[like]=tour .

If no operator is provided, eq is used by default. The value in the filter parameter is treated as String .

Supported operators:

  • eq means  =
  • ne means <>
  • lt means <
  • gt means >
  • lte means <=
  • gte means >=
  • like means LIKE
  • in means IN
  • not-in means NOT IN

For in and not-in, a range symbol ~ (the tilde) should be provided, for example:

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
    Example: 2018-01-01
  • Datetime: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
    Example: 2018-01-11T10:26:47.438+07:00

Property filter

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

...