Table of Contents

Namespace BiExcellence.OpenBi.Api

Classes

OpenBiApiClient

Default IOpenBiApiClient implementation, backed by an System.Net.Http.HttpClient.

OpenBiApiException

Thrown when the OpenBI REST API returns a non-success HTTP status code.

OpenBiApiFile

A file the server returned: the response body, plus the media type and file name it stated. Disposing it disposes the underlying response, so read Content before letting it go.

OpenBiListQuery

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().

OpenBiListRequest

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

OpenBiListResult<T>

The items returned by a list endpoint, together with the total number of matching items on the server when the request asked for it via IncludeTotalCount(bool).

Interfaces

IOpenBiApiClient

Low-level HTTP transport shared by every OpenBI REST API domain's extension methods (see the BiExcellence.OpenBi.Api.* namespaces). Obtain an instance from OpenBiApiClient and authenticate it using the extension methods in BiExcellence.OpenBi.Api.Auth before calling any other domain operation.