Versions Compared

Key

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

...

The filter parameter has the following format: 

Code Block
property[operator]=value

...

Example:

Code Block
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 .

...

  • 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
  • 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
    Example:
    • 2018-01-01
    • Datetime:  yyyy-MM-dd'T'HH:mm:ss.SSSXXX

    Example:
    • Code Block
      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.

...