Search and filtering

You can use a variety of query parameters to search and filter items in the response from any collection including folders, documents, images, content types, users or any other content with built-in or custom content type.

Filtering

The $filter option defines a subset of the entries from a specified collection. The filter expression can contain global functions and operations according to the OData standard.

Filtering only works on children

Our repository is tree-based and not table based. So our collections are not only tables as typed collections rather children of a tree node. As the collection request returns a container's children, `$filter` option is working only on children items.

Filtering by Field value

The following example returns the items that have a Price greater than 1 000 000.

Copy

GET https://example.com/OData.svc/Root/Content/Cars?$filter=Price gt 1000000

🛈 Special characters should be URL encoded

The following example returns true if the DisplayName field (given as second param) contains the given string.

Copy

GET https://example.com/OData.svc/Root/Content/Cars?$filter=substringof('Supra', DisplayName) eq true

🛈 Special characters should be URL encoded

The following example returns true if the DisplayName field starts with the given string.

Copy

GET https://example.com/OData.svc/Root/Content/Cars?$filter=startswith(DisplayName, 'Toyota') eq true

🛈 Special characters should be URL encoded

The following example returns true if the given DisplayName field ends with the given string.

Copy

GET https://example.com/OData.svc/Root/Content/Cars?$filter=endswith(DisplayName, 'Octavia') eq true

🛈 Special characters should be URL encoded

Filtering does not work on reference properties

In sensenet filtering for reference fields is not available so this type of filters will be skipped.

Do not use relational database specific operations in a filter

Since the search engine of sensenet is based on Lucene.NET, it is text based and not a relational one. Because of that you cannot use two or more fields in one logical operation, and cannot perform operations on fields. For example: comparing values of two fields or executing field operations in terms.

Filtering by Date

The following example returns documents that have StartingDate field greater value than the specified date.

Copy

GET https://example.com/OData.svc/Root/Content/Cars?$filter=StartingDate gt datetime'2020-01-12T03:55:00'

🛈 Special characters should be URL encoded

Filtering by an exact Type

Since sensenet supports content type inheritance there are two ways to filter items by their types.

The following example shows how to get items with an exact type skipping the contents with one of the inherited types.

Copy

GET https://example.com/OData.svc/Root/Content/Cars?metadata=no&$filter=ContentType eq 'Car'

🛈 Special characters should be URL encoded

Filtering by Type family

In most of the cases you will use the IsOf() operation to filter by type family (by a content type and all of its inherited ones).

The response of the following example will return every content with the type Folder or any inherited type.

Copy

GET https://example.com/OData.svc/Root/Content/Cars?$filter=isof('Folder')

🛈 Special characters should be URL encoded

Query option

There is a reserved custom query option: query (without "$" prefix) that helps to get filtered collection of entities with Content Query. The scope of the query is the subtree with requested entity as a root.

Performance considerations

Do not forget that querying on huge collections may impact server performance. Always use limiters when using the queries in such cases. If you use the custom `query` option use the CQL limiters and sorting in the `query` option (.TOP .SKIP) instead of using the OData ones ($top, $skip, $orderby).

Check the next big section of docs about querying in details HERE.

Ordering and Pagination

Metadata