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

Properties

authUrlOnly? connectionProperties datasourceID qName space? tags?

Properties

authUrlOnly?: boolean

When set to true, only authentication URL will be returned (i.e. no connection will be created) if datasource supports OAuth, and other properties set in the request will ignored. This property will be ignored if the request is not OAuth or datasource doesn't support OAuth

connectionProperties: unknown

Connection properties required to create dataconnection for the given datasource, which is defined by the response of 'GET /v1/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 31 tags)

Settings

Member Visibility

On This Page

Properties