Class CreateConnectionTemplateRequest

Namespace

BiExcellence.OpenBi.Api.ConnectionTemplates

Assembly

BiExcellence.OpenBi.Api.Client.dll

Request body for creating or updating a ConnectionTemplate.

public sealed record CreateConnectionTemplateRequest : ICreateConnectionTemplateRequest

Inheritance

object

CreateConnectionTemplateRequest

Implements

ICreateConnectionTemplateRequest

Properties

CustomAttributes

The values of the custom table attributes defined for connection templates, by attribute name. A name without a table attribute definition is ignored.

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

Property Value

Dictionary<string, JsonElement>

DataproviderType

The data provider type the template connects to - one of the types GetDataproviderTypesAsync(IOpenBiApiClient, CancellationToken) lists.

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

Property Value

string

Description

A free-text description of the template.

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

Property Value

string

Id

The id to create the template under; left out, the server generates one. Only read by CreateConnectionTemplateAsync(IOpenBiApiClient, CreateConnectionTemplateRequest, CancellationToken) - an update takes the id from the route. A built-in template's id is refused.

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

Property Value

string

IsHidden

Whether the template should be hidden in connection pickers.

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

Property Value

bool

Name

The display name of the template, for connection pickers.

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

Property Value

string

Parameters

Replaces the template's parameters wholesale; their order becomes their position.

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

Property Value

List<ConnectionTemplateParameter>