Skip to content

Latest commit

 

History

History
282 lines (191 loc) · 4.54 KB

API.md

File metadata and controls

282 lines (191 loc) · 4.54 KB

API documentation

Jump to: limit | skip | order | where | fields

Limit ↑

A limit filter limits the number of records returned to the specified number (or less).

REST API

?filter[limit]=n

or RQL

?limit=n

Client API

FilterBuilder
    .NewFilterBuilder()
    .Limit(n)
    .Build();

Where n is the maximum number of results (records) to return.

Skip ↑

A skip filter omits the specified number of returned records. This is useful, for example, to paginate responses.

REST API

?filter[skip]=n

or RQL

?skip=n

Client API

FilterBuilder
    .NewFilterBuilder()
    .Skip(n)
    .Build();

Where n is the number of records to skip.

Order ↑

An order filter specifies how to sort the results: ascending (ASC) or descending (DESC) based on the specified property.

by ASC

REST API

?filter[order]=property ASC

by DESC

REST API

?filter[order]=property DESC

by ASC and DESC

Order by two or more properties:

REST API

?filter[order][0]=property ASC&filter[order][1]=property DESC

Where property is the name of the property (field) to sort by.

Where ↑

A where filter specifies a set of logical conditions to match, similar to a WHERE clause in a SQL query.

Comparison Operators

Equivalence =

REST API

?filter[where][property]=value

Client API

FilterBuilder
    .NewFilterBuilder()
    .Where("property".Equal("value"))
    .Build();
Greater than gt

REST API

?filter[where][property][gt]=value

Client API

FilterBuilder
    .NewFilterBuilder()
    .Where("property".GreaterThan(value))
    .Build();
Less than lt

REST API

?filter[where][property][lt]=value

Client API

FilterBuilder
    .NewFilterBuilder()
    .Where("property".LessThan(value))
    .Build();

Where:

  • property is the name of a property (field) in the model being queried.
  • value is a literal value.

Logical Operators

And and

REST API

?filter[where][and][0][property]=value&filter[where][and][1][property][gt]=value

Client API

FilterBuilder
    .NewFilterBuilder()
    .Where("property".Equal("value")
        .And("property".GreaterThan(value)))
    .Build();
Or or

REST API

?filter[where][or][0][property]=value&filter[where][or][1][property][lt]=value

Client API

FilterBuilder
    .NewFilterBuilder()
    .Where("property".Equal("value")
        .Or("property".LessThan(value)))
    .Build();
And/Or

⚠ in development!

REST API

?filter[where][or][0][property][gt]=value&filter[where][and][1][property]=value&filter[where][and][2][property][gt]=value

Client API

FilterBuilder
    .NewFilterBuilder()
    .Where("property".GreaterThan(value)
        .Or("property".Equal("value")
            .And("property".GreaterThan(value))))
    .Build();

Where:

  • property is the name of a property (field) in the model being queried.
  • value is a literal value.
Inq

The inq operator checks whether the value of the specified property matches any of the values provided in an array.

REST API

?filter[where][property][inq]=value1&filter[where][property][inq]=value2

Client API

FilterBuilder
    .NewFilterBuilder()
    .Where("property".Inq("value1", "value2"))
    .Build();

Where:

  • property is the name of a property (field) in the model being queried.
  • value1, value2, and so on, are literal values in an array.

Fields ↑

A fields filter specifies properties (fields) to include from the results.

REST API

?filter[fields][property]=true

Order by two or more properties:

?filter[fields][property]=true&filter[fields][property]=true

Client API

FilterBuilder
    .NewFilterBuilder()
    .Select(property)
    .Build();

Order by two or more properties:

FilterBuilder
    .NewFilterBuilder()
    .Select(property, property)
    .Build();

Where property is the name of the property (field) to include.

By default, queries return all model properties in results. However, if you specify at least one fields filter with a value of true, then by default the query will include only those you specifically include with filters.