Table of Contents

Class CreateBaseEntityRequest

Namespace
BiExcellence.OpenBi.Api.BaseEntities
Assembly
BiExcellence.OpenBi.Api.Client.dll

Request body for creating or updating a BaseEntity.

public sealed record CreateBaseEntityRequest : ICreateBaseEntityRequest
Inheritance
object
CreateBaseEntityRequest
Implements

Properties

CustomAttributes

The values of the table attributes defined on table SHOP_BASE_PRODUCT - the base entity's own extra fields, keyed by attribute name. Not the columns of its entities; those are TableAttributes.

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

Property Value

Dictionary<string, JsonElement>

Description

A free-text description of the base entity.

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

Property Value

string

EntityTableName

The table that holds the entities of this base entity (wire name tableName). Server-assigned when the base entity is created: SHOP_PRODUCT_ followed by the id in upper case without dashes. It is also the Type of a table attribute that refers to one of these entities.

[JsonPropertyName("tableName")]
public string? EntityTableName { get; init; }

Property Value

string

Id

Optional on create: a GUID is generated when it is omitted. UpdateBaseEntityAsync(IOpenBiApiClient, string, CreateBaseEntityRequest, CancellationToken) takes the id from the route instead.

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

Property Value

string

Name

The display name of the base entity.

[JsonPropertyName("name")]
public string? Name { get; init; }

Property Value

string