Type Alias ConnectionCreateResponse

Essential fields of a connection

type ConnectionCreateResponse = {
    created?: string;
    links?: Link;
    privileges: Privilege[];
    qArchitecture: 0 | 1;
    qConnectStatement: string;
    qCredentialsID?: string;
    qCredentialsName?: string;
    qEngineObjectID: string;
    qID: string;
    qLogOn: "0" | "1" | "LOG_ON_SERVICE_USER" | "LOG_ON_CURRENT_USER";
    qName: string;
    qReferenceKey?: string;
    qSeparateCredentials: boolean;
    qType: string;
    space?: string;
    updated?: string;
    user?: string;
}
Index

Properties

created? links? privileges qArchitecture qConnectStatement qCredentialsID? qCredentialsName? qEngineObjectID qID qLogOn qName qReferenceKey? qSeparateCredentials qType space? updated? user?

Properties

created?: string

Datetime when the connection was created

links?: Link
privileges: Privilege[]

Array of string (i.e. update, delete, read) indicating the user's privileges on the associated connection

qArchitecture: 0 | 1

0 or 1 value indicating whether the data connector is 64-bit (0) or 32-bit (1). Defaults to 0 if not specified.

qConnectStatement: string

Connection string for the data connection

qCredentialsID?: string

ID of the credential associated with the connection

qCredentialsName?: string

Name of the credential associated with the connection

qEngineObjectID: string

Unique identifier (UUID) for the data connection, must be same as qID

qID: string

Unique identifier (UUID) for the data connection, must be same as qEngineObjectID

qLogOn: "0" | "1" | "LOG_ON_SERVICE_USER" | "LOG_ON_CURRENT_USER"

Indicates the type of user associated with the data connection.

qName: string

Descriptive name of the data connection

qReferenceKey?: string

Reference key of credential in redis

qSeparateCredentials: boolean

Indicates whether or not this is a credential-less connection

qType: string

Type of connection - indicates connection provider type

space?: string

ID of the space to which the connection belongs

updated?: string

Datetime when the connection was last updated

user?: string

User ID of the connection's creator

Settings

Member Visibility

On This Page

Properties