Class CreateDataProviderCommentRequest

Namespace

BiExcellence.OpenBi.Api.DataProviders

Assembly

BiExcellence.OpenBi.Api.Client.dll

A comment on one cell of the executed grid.

public sealed class CreateDataProviderCommentRequest

Inheritance

object

CreateDataProviderCommentRequest

Remarks

The cell is named one of two ways: by KeyFigureId and Tuples, which keeps pointing at the same data after a re-execute; or by Row and Column, which reads those tuples off the grid and so needs an executed dataprovider.

Properties

Column

The cell's column, 1-based. Given together with Row.

[JsonPropertyName("column")]
public int? Column { get; set; }

Property Value

int?

Comment

The text.

[JsonPropertyName("comment")]
public string? Comment { get; set; }

Property Value

string

Id

The comment's id. Server-generated when omitted; an id that already exists is rewritten.

[JsonPropertyName("id")]
public string? Id { get; set; }

Property Value

string

IsPrivate

Whether only its author may see it.

[JsonPropertyName("isPrivate")]
public bool IsPrivate { get; set; }

Property Value

bool

KeyFigureId

The key figure the comment belongs to. Given together with Tuples.

[JsonPropertyName("keyFigureId")]
public string? KeyFigureId { get; set; }

Property Value

string

Row

The cell's row, 1-based. Given together with Column.

[JsonPropertyName("row")]
public int? Row { get; set; }

Property Value

int?

Tuples

The cell, as one value per dimension - dimension id to value.

[JsonPropertyName("tuples")]
public Dictionary<string, string>? Tuples { get; set; }

Property Value

Dictionary<string, string>