Class OpenBiListQuery

Namespace

BiExcellence.OpenBi.Api

Assembly

BiExcellence.OpenBi.Api.Client.dll

The list options as a request body, for the QUERY-method form of a list route. Same options as the query string, for filters that do not fit in a URL. Build one with ToQuery().

public sealed class OpenBiListQuery

Inheritance

object

OpenBiListQuery

Properties

Count

True to return the unpaged total in the X-Total-Count response header.

[JsonPropertyName("$count")]
public bool? Count { get; set; }

Property Value

bool?

Filter

Filter expressions over the entity properties. An entity has to match all of them.

[JsonPropertyName("$filter")]
public string[]? Filter { get; set; }

Property Value

string[]

Order

Sort by these properties, each optionally followed by asc or desc.

[JsonPropertyName("$orderby")]
public string[]? Order { get; set; }

Property Value

string[]

Search

Free-text search expressions. Combined with a filter, an entity has to match both.

[JsonPropertyName("$search")]
public string[]? Search { get; set; }

Property Value

string[]

Select

Return only these properties of each entity.

[JsonPropertyName("$select")]
public string[]? Select { get; set; }

Property Value

string[]

Skip

Skip this many entities before returning - the page offset.

[JsonPropertyName("$skip")]
public int? Skip { get; set; }

Property Value

int?

Top

Return at most this many entities - the page size.

[JsonPropertyName("$top")]
public int? Top { get; set; }

Property Value

int?