Table of Contents

Class DataproviderTypeDto

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

A connection type that can be configured, with the parameters a ConnectionTemplate of that type has to fill in - the blueprint to start a new template from. Read-only metadata.

public sealed record DataproviderTypeDto : IDataproviderTypeDto
Inheritance
object
DataproviderTypeDto
Implements

Properties

DataproviderType

The type name, e.g. SAP_BW or MSSQL - the value for DataproviderType.

[JsonPropertyName("dataproviderType")]
public string? DataproviderType { get; init; }

Property Value

string

IsHidden

Whether connection pickers should fold this type away by default. A hidden type is still fully usable. Unrelated to IsHidden, which hides one stored template.

[JsonPropertyName("isHidden")]
public bool IsHidden { get; init; }

Property Value

bool

Name

Human readable name, for connection pickers.

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

Property Value

string

Parameters

The parameters a template of this type takes, in their declared order, each with its default value and type.

[JsonPropertyName("parameters")]
public List<ConnectionTemplateParameter>? Parameters { get; init; }

Property Value

List<ConnectionTemplateParameter>