Type Alias DcaasConnectionCreate

Schema used to create a connection using a list of connection properties for given datasource

type DcaasConnectionCreate = {
    authUrlOnly?: boolean;
    connectionProperties: unknown;
    datasourceID: string;
    qName: string;
    space?: string;
    tags?: string[];
}
Index
authUrlOnly? connectionProperties datasourceID qName space? tags?
authUrlOnly?: boolean

When true, only the authentication URL is returned and no connection is created, provided the data source supports OAuth. All other request properties are ignored. Has no effect if the data source does not support OAuth.

connectionProperties: unknown

Connection properties required to establish the connection for the specified data source. The expected properties are defined by the response of GET /connectivity/data-sources/{datasourceId}/api-specs.

datasourceID: string

ID of the datasource of the connection

qName: string

Descriptive name of the data connection

space?: string

ID of the space in which the connection shall be created. Connection will be created in user's personal space if undefined

tags?: string[]

List of tags attached to the connection (allow max 32 tags)

Settings
Member Visibility

On This Page
Properties