Class DataProviderF4ValuesRequest

Namespace

BiExcellence.OpenBi.Api.DataProviders

Assembly

BiExcellence.OpenBi.Api.Client.dll

The value help options as a body, plus the filter context to narrow the values by. Only needed where the caller holds variable answers the dataprovider has not been executed with yet - otherwise the dataprovider's own filters narrow the values and the query-string form says everything.

public sealed class DataProviderF4ValuesRequest

Inheritance

object

DataProviderF4ValuesRequest

Properties

DimensionId

The dimension to read the values of. Exactly one of this and VariableId is given.

[JsonPropertyName("dimension")]
public string? DimensionId { get; set; }

Property Value

string

HierarchyName

Read the values as nodes of this hierarchy instead of as a flat list. The empty string reads them flat even where the dimension has a hierarchy active.

[JsonPropertyName("hierarchyName")]
public string? HierarchyName { get; set; }

Property Value

string

VariableId

The variable to read the values of. Exactly one of this and DimensionId is given.

[JsonPropertyName("variable")]
public string? VariableId { get; set; }

Property Value

string

VariableLow

The value a dependent variable is being read for.

[JsonPropertyName("variableLow")]
public string? VariableLow { get; set; }

Property Value

string

Variables

The variables to narrow the values by, each with the filters that answer it. Left out, the dataprovider's own filters narrow them.

[JsonPropertyName("variables")]
public List<DataProviderVariable>? Variables { get; set; }

Property Value

List<DataProviderVariable>

WithAttributes

Fill each value's attributes.

[JsonPropertyName("withAttributes")]
public bool? WithAttributes { get; set; }

Property Value

bool?

WithMaps

Resolve each value to geo coordinates.

[JsonPropertyName("withMaps")]
public bool? WithMaps { get; set; }

Property Value

bool?