Filter Query Parameter

Last updated

19:02, 20 Jul 2016
Save as PDF

The filter parameter filters results to a subset that meet specific criteria. Whenever possible, use where or filter to explicitly choose specific assets, thereby reducing the load put on the application.

rest-1 URL Syntax

In rest-1.v1/Data and rest-1.oauth.v1/Data, there is no distinct filter parameter. The ability to filter on equality or inequalities is handled with the where parameter.

query.v1 Syntax

In query.v1 and query.legacy.v1, the filter parameter is a sequence of VersionOne filter tokens as strings. The filter tokens name an attribute (possible traversing relations) and give a comparison operator and either a comparison value or a context variable that will be defined in the with clause. For simple equality comparison, use the where parameter.

YAML

from: Story
select:
  - Name
  - Estimate
filter:
  - Estimate>'0'

JSON

{
  "from": "Story",
  "select":
    [
      "Name",
      "Estimate"
    ],
  "filter":
    [
      "Estimate>'0'"
    ]
}