Table of Contents

Class CreateEntityRequest

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

Request body for creating or updating an Entity.

public sealed record CreateEntityRequest : ICreateEntityRequest
Inheritance
object
CreateEntityRequest
Implements

Properties

Changed

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

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

[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 takes a JSON array. Names that are not attached are ignored.

[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

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

[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?