Class OpenBiApiClientDataProviderStoreExtensions

Namespace

BiExcellence.OpenBi.Api.DataProviderStore

Assembly

BiExcellence.OpenBi.Api.Client.dll

Extension methods for the /datastoreobjects REST API - the dataprovider store, which holds the documents that belong to a dataprovider rather than to a role. POST chartdefinitions writes here, and the chart data routes read back from it by id.

public static class OpenBiApiClientDataProviderStoreExtensions

Inheritance

object

OpenBiApiClientDataProviderStoreExtensions

Methods

CreateDataProviderStoreObjectAsync(IOpenBiApiClient, DataProviderStoreObject, CancellationToken)

Stores a new object (POST datastoreobjects) and returns it, including a server-generated id. UpdateDataProviderStoreObjectAsync(IOpenBiApiClient, string, DataProviderStoreObject, CancellationToken) creates as well as updates, so a caller that picks its own id can use that instead. Set Type deliberately: routes that read the store filter on it.

public static Task<DataProviderStoreObject?> CreateDataProviderStoreObjectAsync(this IOpenBiApiClient client, DataProviderStoreObject storeObject, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient

storeObject DataProviderStoreObject

cancellationToken CancellationToken

Returns

Task<DataProviderStoreObject>

DeleteDataProviderStoreObjectAsync(IOpenBiApiClient, string, CancellationToken)

Removes a stored object (DELETE datastoreobjects/{id}). An id that does not exist succeeds as well.

public static Task DeleteDataProviderStoreObjectAsync(this IOpenBiApiClient client, string id, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient

id string

cancellationToken CancellationToken

Returns

Task

GetDataProviderStoreObjectAsync(IOpenBiApiClient, string, CancellationToken)

Reads one stored object by id (GET datastoreobjects/{id}). Throws OpenBiApiException (404) when there is no store object with this id.

public static Task<DataProviderStoreObject> GetDataProviderStoreObjectAsync(this IOpenBiApiClient client, string id, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient

id string

cancellationToken CancellationToken

Returns

Task<DataProviderStoreObject>

GetDataProviderStoreObjectsAsync(IOpenBiApiClient, OpenBiListRequest?, CancellationToken)

Lists the stored objects (GET datastoreobjects). Filter on Type to find one kind of document.

public static Task<OpenBiListResult<DataProviderStoreObject>> GetDataProviderStoreObjectsAsync(this IOpenBiApiClient client, OpenBiListRequest? request = null, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient

request OpenBiListRequest

cancellationToken CancellationToken

Returns

Task<OpenBiListResult<DataProviderStoreObject>>

UpdateDataProviderStoreObjectAsync(IOpenBiApiClient, string, DataProviderStoreObject, CancellationToken)

Creates or updates the stored object with this id (POST datastoreobjects/{id}): an id that does not exist yet is inserted rather than answered with a 404. The id in the body is ignored.

public static Task<DataProviderStoreObject?> UpdateDataProviderStoreObjectAsync(this IOpenBiApiClient client, string id, DataProviderStoreObject storeObject, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient

id string

storeObject DataProviderStoreObject

cancellationToken CancellationToken

Returns

Task<DataProviderStoreObject>