Class Entity

Namespace

BiExcellence.OpenBi.Api.Entities

Assembly

BiExcellence.OpenBi.Api.Client.dll

An entity: a row of a BaseEntity's dynamically-shaped child table (the instance side of the dynamic custom-attribute / EAV engine).

public sealed record Entity : IEntity

Inheritance

object

Entity

Implements

IEntity

Properties

BaseEntityId

The id of the base entity this entity is a row of - the baseEntityId of the route.

[JsonPropertyName("baseEntityId")]
public string? BaseEntityId { get; init; }

Property Value

string

Changed

When the entity was last saved. Set to the current time on every save unless the request carries it.

[JsonPropertyName("changed")]
public DateTimeOffset Changed { get; init; }

Property Value

DateTimeOffset

Created

When the entity was created. Set by the server on insert unless the request carries it.

[JsonPropertyName("created")]
public 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 holds a JSON array.

[JsonPropertyName("customAttributes")]
public Dictionary<string, JsonElement>? CustomAttributes { get; init; }

Property Value

Dictionary<string, JsonElement>

Description

A free-text description of the entity.

[JsonPropertyName("description")]
public string? Description { get; init; }

Property Value

string

Id

The id of the entity, unique within its base entity.

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

Property Value

string

Name

The display name of the entity.

[JsonPropertyName("name")]
public 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.

[JsonPropertyName("price")]
public double? Price { get; init; }

Property Value

double?