Index

Properties

clearCache: typeof dataConnections.clearCache

Clears the cache for data-connections api requests.

createDataConnection: typeof dataConnections.createDataConnection

Use this operation to create a new data connection in your tenant. Depending on the fields provided in the request body, credentials embedded in or associated with the connection are created or updated alongside the connection.

an object with the body content

CreateDataConnectionHttpError

deleteDataConnection: typeof dataConnections.deleteDataConnection

Use this operation to delete a data connection by its unique identifier. To delete a connection by name instead of ID, set the type query parameter to connectionname. This action cannot be undone.

deleteDataConnection(
"82ee7b44-0c4d-491b-bd38-82640c0430a5",
{
type: "connectionname",
spaceId: "611bcebaeec1203d88211ac4"
}
)

The unique identifier of the connection.

an object with query parameters

DeleteDataConnectionHttpError

deleteDataConnections: typeof dataConnections.deleteDataConnections

Use this operation to delete multiple data connections in a single request. Requires the Admin role. Returns a 207 Multi-Status response indicating the outcome for each connection in the request.

an object with the body content

DeleteDataConnectionsHttpError

duplicateDataConnections: typeof duplicateDataConnections

Use this operation to create a copy of an existing data connection. The duplicated connection can optionally be placed in a different space by specifying spaceId. You can override the credentials in the duplicate by providing qUsername and qPassword in the request body.

an object with the body content

DuplicateDataConnectionsHttpError

getDataConnection: typeof dataConnections.getDataConnection

Use this operation to retrieve a single data connection by its unique identifier. To look up a connection by name instead of ID, set the type query parameter to connectionname. Returns the full connection object including the caller's access privileges.

getDataConnection(
"82ee7b44-0c4d-491b-bd38-82640c0430a5",
{
extended: false,
type: "connectionname",
credentialId: "22379dc5-076e-4fec-ae20-5529a8a57dc2",
byCredentialName: false,
spaceId: "611bcebaeec1203d88211ac4",
noCache: false,
parseConnection: true
}
)

The unique identifier of the connection.

an object with query parameters

GetDataConnectionHttpError

getDataConnections: typeof dataConnections.getDataConnections

Use this operation to retrieve a list of data connections available to the caller. Results are filtered based on the caller's space access permissions. Use the spaceId, personal, or filter parameters to narrow results to a specific scope.

getDataConnections(
{
dataName: "data",
extended: false,
spaceId: "611bcebaeec1203d88211ac4",
personal: false,
owner: "928e2a66-01ba-4678-aa32-e74c213896fa",
ownedByMe: true,
limit: 30,
page: "page=JwAAAAljcmVhdGVkAPfQ-sx0AQAAB19pZABfb93nZcM4SN1M0e8A",
noDatafiles: true,
userId: "6K9xjsItDexffolu5vg1oWYkY8x7f-0G",
caseinsensitive: true,
locale: "en",
includeQris: true,
includeDisabled: true
}
)

an object with query parameters

GetDataConnectionsHttpError

patchDataConnection: typeof dataConnections.patchDataConnection

Use this operation to apply partial updates to a data connection using JSON Patch operations. To patch a connection by name instead of ID, set the type query parameter to connectionname. Some data sources require an OAuth authentication code; provide it using the qlik-auth-code request header.

The unique identifier of the connection.

an object with query parameters

an object with the body content

PatchDataConnectionHttpError

updateDataConnection: typeof dataConnections.updateDataConnection

Use this operation to replace a data connection with the values provided in the request body. All required fields must be included. To update a connection by name instead of ID, set the type query parameter to connectionname. Credentials embedded in or associated with the connection are created or updated based on the fields provided.

The unique identifier of the connection.

an object with query parameters

an object with the body content

UpdateDataConnectionHttpError

updateDataConnections: typeof dataConnections.updateDataConnections

Use this operation to update multiple data connections in a single request. Requires the Admin role. Returns a 207 Multi-Status response with the outcome for each connection. When transferring ownership, credentials associated with the connection are not automatically transferred to the new owner; the new owner must provide their own credentials.

an object with the body content

UpdateDataConnectionsHttpError