Interface ICreateEntityRequest

Namespace

BiExcellence.OpenBi.Api.Entities

Assembly

BiExcellence.OpenBi.Api.Client.dll

Request body for creating or updating an Entity.

public interface ICreateEntityRequest

Properties

Changed

When the entity was last saved. null has the server set the current time.

DateTimeOffset? Changed { get; init; }

Property Value

DateTimeOffset?

Created

When the entity was created. null keeps the stored value, or has the server set it on insert.

DateTimeOffset? Created { get; init; }

Property Value

DateTimeOffset?

CustomAttributes

The values of the table attributes attached to the base entity, keyed by attribute name; an attribute with IsMultiple takes a JSON array. Names that are not attached are ignored.

Dictionary<string, JsonElement>? CustomAttributes { get; init; }

Property Value

Dictionary<string, JsonElement>

Description

A free-text description of the entity.

string? Description { get; init; }

Property Value

string

Id

Optional: a GUID is generated when it is omitted. UpdateEntityAsync(IOpenBiApiClient, string, string, CreateEntityRequest, CancellationToken) takes the id from the route instead.

string? Id { get; init; }

Property Value

string

Name

The display name of the entity.

string? Name { get; init; }

Property Value

string

Price

A price, left over from the shop products entities used to be. Kept for compatibility; new data belongs in a table attribute.

double? Price { get; init; }

Property Value

double?