Class OpenBiApiClientMapDimensionExtensions

Namespace

BiExcellence.OpenBi.Api.MapDimensions

Assembly

BiExcellence.OpenBi.Api.Client.dll

Extension methods for the /mapdimensions REST API.

public static class OpenBiApiClientMapDimensionExtensions

Inheritance

object

OpenBiApiClientMapDimensionExtensions

Methods

CreateMapDimensionAsync(IOpenBiApiClient, MapDimension, CancellationToken)

Creates a map dimension in the caller's organisation. UpdateMapDimensionAsync(IOpenBiApiClient, string, MapDimension, CancellationToken) creates as well, under an id of the caller's choosing.

public static Task<MapDimension?> CreateMapDimensionAsync(this IOpenBiApiClient client, MapDimension mapDimension, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient

mapDimension MapDimension

cancellationToken CancellationToken

Returns

Task<MapDimension>

DeleteMapDimensionAsync(IOpenBiApiClient, string, CancellationToken)

Deletes a map dimension; grids using that characteristic stop resolving to coordinates. An unknown id is not an error.

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

Parameters

client IOpenBiApiClient

id string

cancellationToken CancellationToken

Returns

Task

GetMapDimensionsAsync(IOpenBiApiClient, CancellationToken)

Lists every map dimension of the caller's organisation.

public static Task<OpenBiListResult<MapDimension>> GetMapDimensionsAsync(this IOpenBiApiClient client, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient

cancellationToken CancellationToken

Returns

Task<OpenBiListResult<MapDimension>>

UpdateMapDimensionAsync(IOpenBiApiClient, string, MapDimension, CancellationToken)

Creates or updates the map dimension with the given id: an id that is not there yet is inserted rather than answered with a 404.

public static Task<MapDimension?> UpdateMapDimensionAsync(this IOpenBiApiClient client, string id, MapDimension mapDimension, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient

id string

mapDimension MapDimension

cancellationToken CancellationToken

Returns

Task<MapDimension>