Class OpenBiListRequest

Namespace

BiExcellence.OpenBi.Api

Assembly

BiExcellence.OpenBi.Api.Client.dll

Builds the OData-style $select/$top/$skip/$count/$orderby/$filter/$search query string understood by every OpenBI REST API list endpoint.

public sealed class OpenBiListRequest

Inheritance

object

OpenBiListRequest

Methods

Create()

Creates an empty list request. Use the fluent methods to configure it.

public static OpenBiListRequest Create()

Returns

OpenBiListRequest

Filter(string)

Adds a filter expression ($filter). Call multiple times to AND several expressions together.

public OpenBiListRequest Filter(string filterExpression)

Parameters

filterExpression string

Returns

OpenBiListRequest

IncludeTotalCount(bool)

Asks the server to also return the total number of matching items via the X-Total-Count response header ($count).

public OpenBiListRequest IncludeTotalCount(bool includeTotalCount = true)

Parameters

includeTotalCount bool

Returns

OpenBiListRequest

OrderBy(string, bool)

Adds a sort key ($orderby). Call multiple times to sort by more than one field.

public OpenBiListRequest OrderBy(string field, bool descending = false)

Parameters

field string

descending bool

Returns

OpenBiListRequest

Search(string)

Adds a free-text search expression ($search).

public OpenBiListRequest Search(string searchExpression)

Parameters

searchExpression string

Returns

OpenBiListRequest

Select(params string[])

Requests only the given fields be returned for each item ($select).

public OpenBiListRequest Select(params string[] fields)

Parameters

fields string[]

Returns

OpenBiListRequest

Skip(int)

Skips the given number of items before returning results ($skip).

public OpenBiListRequest Skip(int skip)

Parameters

skip int

Returns

OpenBiListRequest

ToQuery()

The same options as a request body, for the QUERY-method form of a list route - which takes filters that are too long or too awkward to put in a URL.

public OpenBiListQuery ToQuery()

Returns

OpenBiListQuery

ToQueryString()

Renders this request as a URL query string (including the leading ?), or an empty string when nothing was configured.

public string ToQueryString()

Returns

string

Top(int)

Limits the number of items returned ($top).

public OpenBiListRequest Top(int top)

Parameters

top int

Returns

OpenBiListRequest