Table of Contents

Class ConnectionTemplateParameter

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

A single parameter of a ConnectionTemplate (or of a DataproviderTypeDto blueprint).

public sealed record ConnectionTemplateParameter : IConnectionTemplateParameter
Inheritance
object
ConnectionTemplateParameter
Implements

Properties

ConnectionTemplateId

The id of the connection template the parameter belongs to. Ignored on save.

[JsonPropertyName("connectionTemplateId")]
public string? ConnectionTemplateId { get; init; }

Property Value

string

Id

The server-assigned id of the parameter row. Ignored on save - a template's parameters are replaced wholesale and every row gets a new id. Not set in a DataproviderTypeDto blueprint.

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

Property Value

string

IsSupplied

true when the value is supplied by the server rather than by the user logging on. Supplied parameters are only returned to callers holding openbi.connectiontemplate.write.

[JsonPropertyName("isSupplied")]
public bool IsSupplied { get; init; }

Property Value

bool

Name

The name the dataprovider type knows the parameter by, e.g. USERNAME or PASSWORD. Unique within a template.

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

Property Value

string

Position

The parameter's position within the template, from 0. Ignored on save - the order of Parameters is the position.

[JsonPropertyName("position")]
public int Position { get; init; }

Property Value

int

Type

One of the ConnectionTemplateParameterType constants.

[JsonPropertyName("type")]
public string? Type { get; init; }

Property Value

string

Value

The stored value - in a DataproviderTypeDto blueprint, the default value. When a template is validated, the placeholders %OPENBI_USERNAME%, %OPENBI_PASSWORD% and %OPENBI_REALM% as the value of USERNAME, PASSWORD and REALM are replaced from the session user.

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

Property Value

string