Type Alias ConnectionCreateResponse

Represents a data connection returned after a successful create, update, or duplicate operation.

type ConnectionCreateResponse = {
    createdAt?: string;
    links?: dataConnections.Link;
    privileges: dataConnections.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
createdAt? links? privileges qArchitecture qConnectStatement qCredentialsID? qCredentialsName? qEngineObjectID qID qLogOn qName qReferenceKey? qSeparateCredentials qType space? updated? user?
createdAt?: string

The date and time when the connection was created, in ISO 8601 format.

links?: dataConnections.Link
privileges: dataConnections.Privilege[]

The user's access privileges on this connection, such as update, delete, or read.

qArchitecture: 0 | 1

Indicates the data connector architecture. 0 for 64-bit, 1 for 32-bit. Default is 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

The unique identifier for the data connection. Must match qID.

qID: string

The unique identifier of the data connection. Must match qEngineObjectID.

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

Logon type for the connection. LOG_ON_SERVICE_USER (or 0) indicates service user logon; LOG_ON_CURRENT_USER (or 1) indicates current user logon.

qName: string

Descriptive name of the data connection

qReferenceKey?: string

Internal reference key for the credential.

qSeparateCredentials: boolean

When true, this connection is credential-less and does not embed authentication details. When false, credentials are embedded in the connection.

qType: string

The connection type, identifying the provider of the underlying connector.

space?: string

ID of the space to which the connection belongs.

updated?: string

The date and time when the connection was last updated, in ISO 8601 format.

user?: string

User ID of the connection's creator.

Settings
Member Visibility

On This Page
Properties