Class SharedConfigurationSetting

Namespace

BiExcellence.OpenBi.Api.SystemInfo

Assembly

BiExcellence.OpenBi.Api.Client.dll

A server setting kept in the database and used by every server connected to it, from GET system/sharedconfiguration. A server's own Configuration.xml, environment variables and command line still override it. Only reachable on the dedicated configuration port.

public sealed record SharedConfigurationSetting : ISharedConfigurationSetting

Inheritance

object

SharedConfigurationSetting

Implements

ISharedConfigurationSetting

Fields

SecretPlaceholder

What a secret's value reads as. Sent back unchanged it means "keep the current value".

public const string SecretPlaceholder = "********"

Field Value

string

Properties

Changed

When the setting was last saved. Set by the server.

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

Property Value

DateTimeOffset?

IsSecret

Whether the setting is a secret (its name contains PASSWORD, other than at the start): stored encrypted, never returned in plain text.

[JsonPropertyName("isSecret")]
public bool IsSecret { get; init; }

Property Value

bool

Name

The setting name, the same key a server reads from its configuration. Compared case-insensitively.

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

Property Value

string

UserId

The user who last saved the setting. Set by the server.

[JsonPropertyName("userId")]
public string? UserId { get; init; }

Property Value

string

Value

The value. For a secret it reads SecretPlaceholder; sending that back unchanged keeps the current value.

[JsonPropertyName("value")]
public string? Value { get; init; }

Property Value

string