Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: add usage note: Ranges are inclusive.

...

  • 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
  • Ranges are inclusive: price[in]=100~200 is interpreted as price >= 100 AND price <= 200.
  • 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 take multiple possible values which must match, use | (OR):

    Code Block
    @name=travel|about

...