Type Alias DataConnectionsAPI

type DataConnectionsAPI = {
    clearCache: typeof clearCache;
    createDataConnection: typeof createDataConnection;
    deleteDataConnection: typeof deleteDataConnection;
    deleteDataConnections: typeof deleteDataConnections;
    duplicateDataAConnection: typeof duplicateDataAConnection;
    getDataConnection: typeof getDataConnection;
    getDataConnections: typeof getDataConnections;
    patchDataConnection: typeof patchDataConnection;
    updateDataConnection: typeof updateDataConnection;
    updateDataConnections: typeof updateDataConnections;
}
Index

Properties

clearCache createDataConnection deleteDataConnection deleteDataConnections duplicateDataAConnection getDataConnection getDataConnections patchDataConnection updateDataConnection updateDataConnections

Properties

clearCache: typeof clearCache

Clears the cache for data-connections api requests.

createDataConnection: typeof createDataConnection

Creates a new connection. Depending on the fields defined in the request body, credentials embedded (or associated) in the connection can be updated or created.

Param: body

an object with the body content

CreateDataConnectionHttpError

deleteDataConnection: typeof deleteDataConnection

Deletes the specified data connection by ID (or by name when type=connectionname is set in query)

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

Connection ID

an object with query parameters

DeleteDataConnectionHttpError

deleteDataConnections: typeof deleteDataConnections

Delete multiple connections, only available to Admin

Param: body

an object with the body content

DeleteDataConnectionsHttpError

duplicateDataAConnection: typeof duplicateDataAConnection

Duplicate a connection

Param: body

an object with the body content

DuplicateDataAConnectionHttpError

getDataConnection: typeof getDataConnection

Retrieves a connection by connection ID, or by name when the query parameter "type" is set to "connectionname."

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

Connection ID

an object with query parameters

GetDataConnectionHttpError

getDataConnections: typeof getDataConnections

Gets a list of connections

getDataConnections(
  {
    dataName: "data",
    extended: false,
    spaceId: "611bcebaeec1203d88211ac4",
    personal: false,
    owner: "928e2a66-01ba-4678-aa32-e74c213896fa",
    ownedByMe: true,
    limit: 30,
    sort: "+qName",
    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 patchDataConnection

Patches a connection specified by connection ID (or by name when type=connectionname is set in query).

Connection ID

an object with query parameters

Param: body

an object with the body content

PatchDataConnectionHttpError

updateDataConnection: typeof updateDataConnection

Updates a connection specified by connection ID (or by name when type=connectionname is set in query). Depends on the fields defined in the request body, credentials embedded (or associated) in the connection can be updated or created.

Connection ID

an object with query parameters

Param: body

an object with the body content

UpdateDataConnectionHttpError

updateDataConnections: typeof updateDataConnections

Update multiple connections, only available to Admin. When update is to change ownership of a connection, the credentials associated with the connection will NOT be transferred to the new owner, and new owner is expected to provide their own credentials for the connection.

Param: body

an object with the body content

UpdateDataConnectionsHttpError

Settings

Member Visibility

On This Page

Properties