CloudBeaver GraphQL API documentation

Welcome to the CloudBeaver GraphQL API reference! This reference includes the complete set of GraphQL types, queries, and mutations available in the Community Edition (CE), Enterprise Edition (EE), and AWS version of CloudBeaver.

To authenticate API requests, you’ll need an API token. Learn how to generate an access token.

See usage examples in the cloudbeaver-graphql-examples repository.

You can try queries in the built-in GraphQL console, available on your server at https://your-server-address/_services/api/gql/console. This tool lets you test requests directly from your browser.

For a live example, see the demo GraphQL console.


API Endpoints
https://your-server-address/api/gql

Queries

activeProductLicense

Description

Returns the currently active product license with its details and status.

Response

Returns an LMLicenseInfo

Example

Query
query activeProductLicense {
  activeProductLicense {
    id
    licenseType
    ownerCompany
    ownerName
    ownerEmail
    usersNumber
    yearsNumber
    subscription
    unlimitedServers
    multiInstance
    serversNumber
    licenseIssueTime
    licenseStartTime
    licenseEndTime
    licenseRoles {
      ...LMLicenseRoleFragment
    }
    licenseStatus {
      ...LMLicenseStatusDetailsFragment
    }
  }
}
Response
{
  "data": {
    "activeProductLicense": {
      "id": "abc123",
      "licenseType": "abc123",
      "ownerCompany": "abc123",
      "ownerName": "xyz789",
      "ownerEmail": "abc123",
      "usersNumber": 987,
      "yearsNumber": 123,
      "subscription": false,
      "unlimitedServers": false,
      "multiInstance": false,
      "serversNumber": 123,
      "licenseIssueTime": "abc123",
      "licenseStartTime": "xyz789",
      "licenseEndTime": "xyz789",
      "licenseRoles": [LMLicenseRole],
      "licenseStatus": LMLicenseStatusDetails
    }
  }
}

activeUser

Description

Active user information. null is no user was authorized within session

Response

Returns a UserInfo

Example

Query
query activeUser {
  activeUser {
    userId
    displayName
    authRole
    authTokens {
      ...UserAuthTokenFragment
    }
    linkedAuthProviders
    metaParameters
    configurationParameters
    teams {
      ...UserTeamInfoFragment
    }
    isAnonymous
  }
}
Response
{
  "data": {
    "activeUser": {
      "userId": 4,
      "displayName": "abc123",
      "authRole": "4",
      "authTokens": [UserAuthToken],
      "linkedAuthProviders": ["abc123"],
      "metaParameters": Object,
      "configurationParameters": Object,
      "teams": [UserTeamInfo],
      "isAnonymous": false
    }
  }
}

addConnectionsAccess

Description

Sets access to the connections for the specified subjects (users and teams)

Response

Returns a Boolean

Arguments
Name Description
projectId - ID!
connectionIds - [ID!]!
subjects - [ID!]!

Example

Query
query addConnectionsAccess(
  $projectId: ID!,
  $connectionIds: [ID!]!,
  $subjects: [ID!]!
) {
  addConnectionsAccess(
    projectId: $projectId,
    connectionIds: $connectionIds,
    subjects: $subjects
  )
}
Variables
{
  "projectId": 4,
  "connectionIds": ["4"],
  "subjects": ["4"]
}
Response
{"data": {"addConnectionsAccess": true}}

adminUserInfo

Description

Returns information about user by userId

Response

Returns an AdminUserInfo!

Arguments
Name Description
userId - ID!

Example

Query
query adminUserInfo($userId: ID!) {
  adminUserInfo(userId: $userId) {
    userId
    metaParameters
    configurationParameters
    grantedTeams
    grantedConnections {
      ...AdminConnectionGrantInfoFragment
    }
    origins {
      ...ObjectOriginFragment
    }
    linkedAuthProviders
    enabled
    authRole
    disableDate
    disabledBy
    disableReason
  }
}
Variables
{"userId": 4}
Response
{
  "data": {
    "adminUserInfo": {
      "userId": 4,
      "metaParameters": Object,
      "configurationParameters": Object,
      "grantedTeams": ["4"],
      "grantedConnections": [AdminConnectionGrantInfo],
      "origins": [ObjectOrigin],
      "linkedAuthProviders": ["xyz789"],
      "enabled": false,
      "authRole": "abc123",
      "disableDate": "2007-12-03T10:15:30Z",
      "disabledBy": "xyz789",
      "disableReason": "xyz789"
    }
  }
}

aiChatConversationInfo

Description

Returns AI chat conversation info for the specified conversation ID.

Response

Returns an AIChatConversationInfo!

Arguments
Name Description
conversationId - ID!

Example

Query
query aiChatConversationInfo($conversationId: ID!) {
  aiChatConversationInfo(conversationId: $conversationId) {
    dataSourceId {
      ...DataSourceIdFragment
    }
    id
    caption
    time
    messages {
      ...AIMessageFragment
    }
    settings {
      ...AIChatConversationSettingsFragment
    }
  }
}
Variables
{"conversationId": 4}
Response
{
  "data": {
    "aiChatConversationInfo": {
      "dataSourceId": DataSourceId,
      "id": 4,
      "caption": "abc123",
      "time": "2007-12-03T10:15:30Z",
      "messages": [AIMessage],
      "settings": AIChatConversationSettings
    }
  }
}

aiListChatConversations

Description

Returns list of AI chat conversations for the specified connection.

Response

Returns [AIChatConversationInfo!]!

Arguments
Name Description
dataSourceId - DataSourceIdInput

Example

Query
query aiListChatConversations($dataSourceId: DataSourceIdInput) {
  aiListChatConversations(dataSourceId: $dataSourceId) {
    dataSourceId {
      ...DataSourceIdFragment
    }
    id
    caption
    time
    messages {
      ...AIMessageFragment
    }
    settings {
      ...AIChatConversationSettingsFragment
    }
  }
}
Variables
{"dataSourceId": DataSourceIdInput}
Response
{
  "data": {
    "aiListChatConversations": [
      {
        "dataSourceId": DataSourceId,
        "id": "4",
        "caption": "abc123",
        "time": "2007-12-03T10:15:30Z",
        "messages": [AIMessage],
        "settings": AIChatConversationSettings
      }
    ]
  }
}

aiListEngineProperties

Description

Returns the properties of the specified AI engine for displaying it in the UI.

Response

Returns [ObjectPropertyInfo!]!

Arguments
Name Description
engineId - ID!

Example

Query
query aiListEngineProperties($engineId: ID!) {
  aiListEngineProperties(engineId: $engineId) {
    id
    displayName
    description
    hint
    category
    dataType
    value
    validValues
    defaultValue
    length
    features
    order
    supportedConfigurationTypes
    required
    scopes
    conditions {
      ...ConditionFragment
    }
  }
}
Variables
{"engineId": "4"}
Response
{
  "data": {
    "aiListEngineProperties": [
      {
        "id": "xyz789",
        "displayName": "abc123",
        "description": "abc123",
        "hint": "abc123",
        "category": "xyz789",
        "dataType": "abc123",
        "value": Object,
        "validValues": [Object],
        "defaultValue": Object,
        "length": "TINY",
        "features": ["xyz789"],
        "order": 123,
        "supportedConfigurationTypes": [
          "abc123"
        ],
        "required": true,
        "scopes": ["abc123"],
        "conditions": [Condition]
      }
    ]
  }
}

aiListEngines

Description

Returns the list of available AI engines.

Response

Returns [AIEngineInfo!]

Example

Query
query aiListEngines {
  aiListEngines {
    id
    name
  }
}
Response
{
  "data": {
    "aiListEngines": [
      {
        "id": "4",
        "name": "xyz789"
      }
    ]
  }
}

aiSettings

Description

Returns the global AI settings.

Response

Returns an AISettingsInfo!

Example

Query
query aiSettings {
  aiSettings {
    activeEngine
  }
}
Response
{
  "data": {
    "aiSettings": {"activeEngine": "4"}
  }
}

allProductLicenses

Description

Returns a list of all product licenses available in the system, including their details and status.

Response

Returns [LMLicenseInfo!]!

Example

Query
query allProductLicenses {
  allProductLicenses {
    id
    licenseType
    ownerCompany
    ownerName
    ownerEmail
    usersNumber
    yearsNumber
    subscription
    unlimitedServers
    multiInstance
    serversNumber
    licenseIssueTime
    licenseStartTime
    licenseEndTime
    licenseRoles {
      ...LMLicenseRoleFragment
    }
    licenseStatus {
      ...LMLicenseStatusDetailsFragment
    }
  }
}
Response
{
  "data": {
    "allProductLicenses": [
      {
        "id": "xyz789",
        "licenseType": "abc123",
        "ownerCompany": "abc123",
        "ownerName": "abc123",
        "ownerEmail": "abc123",
        "usersNumber": 123,
        "yearsNumber": 987,
        "subscription": true,
        "unlimitedServers": false,
        "multiInstance": true,
        "serversNumber": 987,
        "licenseIssueTime": "abc123",
        "licenseStartTime": "xyz789",
        "licenseEndTime": "abc123",
        "licenseRoles": [LMLicenseRole],
        "licenseStatus": LMLicenseStatusDetails
      }
    ]
  }
}

asyncDbSmSessions

Description

Create an async task to retrieve database sessions for the specified connection.

Response

Returns an AsyncTaskInfo!

Arguments
Name Description
projectId - ID!
connectionId - ID!
limit - Int

Example

Query
query asyncDbSmSessions(
  $projectId: ID!,
  $connectionId: ID!,
  $limit: Int
) {
  asyncDbSmSessions(
    projectId: $projectId,
    connectionId: $connectionId,
    limit: $limit
  ) {
    id
    name
    running
    status
    error {
      ...ServerErrorFragment
    }
    taskResult
  }
}
Variables
{
  "projectId": "4",
  "connectionId": "4",
  "limit": 123
}
Response
{
  "data": {
    "asyncDbSmSessions": {
      "id": "xyz789",
      "name": "xyz789",
      "running": false,
      "status": "abc123",
      "error": ServerError,
      "taskResult": Object
    }
  }
}

asyncDbSmSessionsResult

Description

Retrieve the result of an async task that returns database sessions for the specified connection.

Response

Returns [DataSourceSessionInfo!]

Arguments
Name Description
taskId - ID!

Example

Query
query asyncDbSmSessionsResult($taskId: ID!) {
  asyncDbSmSessionsResult(taskId: $taskId) {
    activeQuery
    properties {
      ...ObjectPropertyInfoFragment
    }
    sessionId
  }
}
Variables
{"taskId": "4"}
Response
{
  "data": {
    "asyncDbSmSessionsResult": [
      {
        "activeQuery": "abc123",
        "properties": [ObjectPropertyInfo],
        "sessionId": "abc123"
      }
    ]
  }
}

authChangeLocalPassword

Description

Changes the local password of the current user

Response

Returns a Boolean!

Arguments
Name Description
oldPassword - String!
newPassword - String!

Example

Query
query authChangeLocalPassword(
  $oldPassword: String!,
  $newPassword: String!
) {
  authChangeLocalPassword(
    oldPassword: $oldPassword,
    newPassword: $newPassword
  )
}
Variables
{
  "oldPassword": "xyz789",
  "newPassword": "abc123"
}
Response
{"data": {"authChangeLocalPassword": false}}

authLogin

Description

Authorizes the user using specified auth provider. Associates new credentials with the active user when linkUser=true. Kills another user sessions if forceSessionsLogout=true.

Response

Returns an AuthInfo!

Arguments
Name Description
provider - ID!
configuration - ID
credentials - Object
linkUser - Boolean
forceSessionsLogout - Boolean

Example

Query
query authLogin(
  $provider: ID!,
  $configuration: ID,
  $credentials: Object,
  $linkUser: Boolean,
  $forceSessionsLogout: Boolean
) {
  authLogin(
    provider: $provider,
    configuration: $configuration,
    credentials: $credentials,
    linkUser: $linkUser,
    forceSessionsLogout: $forceSessionsLogout
  ) {
    redirectLink
    authId
    authStatus
    userTokens {
      ...UserAuthTokenFragment
    }
  }
}
Variables
{
  "provider": 4,
  "configuration": "4",
  "credentials": Object,
  "linkUser": false,
  "forceSessionsLogout": true
}
Response
{
  "data": {
    "authLogin": {
      "redirectLink": "xyz789",
      "authId": "abc123",
      "authStatus": "SUCCESS",
      "userTokens": [UserAuthToken]
    }
  }
}

authLogout

use authLogoutExtended instead
Description

Same as authLogoutExtended but without additional information

Response

Returns a Boolean

Arguments
Name Description
provider - ID
configuration - ID

Example

Query
query authLogout(
  $provider: ID,
  $configuration: ID
) {
  authLogout(
    provider: $provider,
    configuration: $configuration
  )
}
Variables
{"provider": "4", "configuration": 4}
Response
{"data": {"authLogout": false}}

authLogoutExtended

Description

Logouts user. If provider not specified then all authorizations are revoked from session. Contains additional information

Response

Returns a LogoutInfo!

Arguments
Name Description
provider - ID
configuration - ID

Example

Query
query authLogoutExtended(
  $provider: ID,
  $configuration: ID
) {
  authLogoutExtended(
    provider: $provider,
    configuration: $configuration
  ) {
    redirectLinks
  }
}
Variables
{"provider": "4", "configuration": 4}
Response
{
  "data": {
    "authLogoutExtended": {
      "redirectLinks": ["abc123"]
    }
  }
}

authModels

Description

Returns list of available database auth models

Response

Returns [DatabaseAuthModel!]!

Example

Query
query authModels {
  authModels {
    id
    displayName
    description
    icon
    requiresLocalConfiguration
    requiredAuth
    properties {
      ...ObjectPropertyInfoFragment
    }
  }
}
Response
{
  "data": {
    "authModels": [
      {
        "id": 4,
        "displayName": "abc123",
        "description": "xyz789",
        "icon": "xyz789",
        "requiresLocalConfiguration": true,
        "requiredAuth": "xyz789",
        "properties": [ObjectPropertyInfo]
      }
    ]
  }
}

authProviders

Description

Returns list of all available auth providers

Response

Returns [AuthProviderInfo!]!

Example

Query
query authProviders {
  authProviders {
    id
    label
    icon
    description
    defaultProvider
    trusted
    private
    authHidden
    supportProvisioning
    configurable
    federated
    configurations {
      ...AuthProviderConfigurationFragment
    }
    templateConfiguration {
      ...AuthProviderConfigurationFragment
    }
    credentialProfiles {
      ...AuthProviderCredentialsProfileFragment
    }
    requiredFeatures
    required
  }
}
Response
{
  "data": {
    "authProviders": [
      {
        "id": "4",
        "label": "abc123",
        "icon": 4,
        "description": "xyz789",
        "defaultProvider": false,
        "trusted": false,
        "private": true,
        "authHidden": false,
        "supportProvisioning": true,
        "configurable": true,
        "federated": true,
        "configurations": [AuthProviderConfiguration],
        "templateConfiguration": AuthProviderConfiguration,
        "credentialProfiles": [
          AuthProviderCredentialsProfile
        ],
        "requiredFeatures": ["abc123"],
        "required": false
      }
    ]
  }
}

authUpdateStatus

No longer supported
Response

Returns an AuthInfo!

Arguments
Name Description
authId - ID!
linkUser - Boolean

Example

Query
query authUpdateStatus(
  $authId: ID!,
  $linkUser: Boolean
) {
  authUpdateStatus(
    authId: $authId,
    linkUser: $linkUser
  ) {
    redirectLink
    authId
    authStatus
    userTokens {
      ...UserAuthTokenFragment
    }
  }
}
Variables
{"authId": 4, "linkUser": true}
Response
{
  "data": {
    "authUpdateStatus": {
      "redirectLink": "abc123",
      "authId": "xyz789",
      "authStatus": "SUCCESS",
      "userTokens": [UserAuthToken]
    }
  }
}

awsAdminX

Response

Returns a Boolean

Example

Query
query awsAdminX {
  awsAdminX
}
Response
{"data": {"awsAdminX": false}}

awsAvailableRegions

Description

List of available regions

Response

Returns [AWSRegion!]!

Example

Query
query awsAvailableRegions {
  awsAvailableRegions {
    id
    displayName
    superRegion
    global
    partition
    domain
  }
}
Response
{
  "data": {
    "awsAvailableRegions": [
      {
        "id": "abc123",
        "displayName": "abc123",
        "superRegion": "xyz789",
        "global": true,
        "partition": "abc123",
        "domain": "xyz789"
      }
    ]
  }
}

awsConfiguration

Description

AWS cloud configuration. Null if AWS wasn't configured

Response

Returns an AWSConfiguration

Example

Query
query awsConfiguration {
  awsConfiguration {
    cloudId
    cloudName
    allowedAccounts
    regions
    federatedAccessEnabled
    govRegionsEnabled
    proxyUser {
      ...AWSUserInfoFragment
    }
    useDefaultCredentials
    assumeRoleName
  }
}
Response
{
  "data": {
    "awsConfiguration": {
      "cloudId": "abc123",
      "cloudName": "xyz789",
      "allowedAccounts": ["abc123"],
      "regions": ["abc123"],
      "federatedAccessEnabled": true,
      "govRegionsEnabled": true,
      "proxyUser": AWSUserInfo,
      "useDefaultCredentials": false,
      "assumeRoleName": "abc123"
    }
  }
}

awsInstallInfo

Description

Information about CB AWS installation (EC2)

Response

Returns an AWSInstallInfo!

Example

Query
query awsInstallInfo {
  awsInstallInfo {
    instanceId
    instanceType
    instanceRole
    accountId
    version
    marketplaceProductCodes
    amiId
    agreementId
    defaultRegion
    accountRegions
  }
}
Response
{
  "data": {
    "awsInstallInfo": {
      "instanceId": "abc123",
      "instanceType": "xyz789",
      "instanceRole": "abc123",
      "accountId": "abc123",
      "version": "abc123",
      "marketplaceProductCodes": ["xyz789"],
      "amiId": "xyz789",
      "agreementId": "xyz789",
      "defaultRegion": "xyz789",
      "accountRegions": ["xyz789"]
    }
  }
}

awsPartitions

Description

List of available partitions

Response

Returns [AWSPartition!]!

Example

Query
query awsPartitions {
  awsPartitions {
    id
    name
  }
}
Response
{
  "data": {
    "awsPartitions": [
      {
        "id": "4",
        "name": "abc123"
      }
    ]
  }
}

awsSetSessionRegions

use awsSetRegions (24.3.1)
Description

Sets session regions

Response

Returns a Boolean

Arguments
Name Description
regions - [String!]!

Example

Query
query awsSetSessionRegions($regions: [String!]!) {
  awsSetSessionRegions(regions: $regions)
}
Variables
{"regions": ["xyz789"]}
Response
{"data": {"awsSetSessionRegions": false}}

awsUserInfo

Description

Information about currently logged user

Response

Returns an AWSUserInfo

Example

Query
query awsUserInfo {
  awsUserInfo {
    userId
    userName
    userPath
    userArn
    accountId
    organizationName
    createDate
    tags {
      ...AWSTagFragment
    }
  }
}
Response
{
  "data": {
    "awsUserInfo": {
      "userId": "abc123",
      "userName": "xyz789",
      "userPath": "xyz789",
      "userArn": "abc123",
      "accountId": "abc123",
      "organizationName": "abc123",
      "createDate": "2007-12-03T10:15:30Z",
      "tags": [AWSTag]
    }
  }
}

configureServer

Description

Saves server configuration

Response

Returns a Boolean!

Arguments
Name Description
configuration - ServerConfigInput!

Example

Query
query configureServer($configuration: ServerConfigInput!) {
  configureServer(configuration: $configuration)
}
Variables
{"configuration": ServerConfigInput}
Response
{"data": {"configureServer": true}}

connectionFolders

Description

Returns list of connection folders

Response

Returns [ConnectionFolderInfo!]!

Arguments
Name Description
projectId - ID
path - ID

Example

Query
query connectionFolders(
  $projectId: ID,
  $path: ID
) {
  connectionFolders(
    projectId: $projectId,
    path: $path
  ) {
    id
    projectId
    description
  }
}
Variables
{
  "projectId": "4",
  "path": "4"
}
Response
{
  "data": {
    "connectionFolders": [
      {
        "id": "4",
        "projectId": 4,
        "description": "xyz789"
      }
    ]
  }
}

connectionInfo

Description

Returns connection info

Response

Returns a ConnectionInfo!

Arguments
Name Description
projectId - ID!
id - ID!

Example

Query
query connectionInfo(
  $projectId: ID!,
  $id: ID!
) {
  connectionInfo(
    projectId: $projectId,
    id: $id
  ) {
    id
    driverId
    name
    description
    host
    port
    serverName
    databaseName
    url
    mainPropertyValues
    keepAliveInterval
    autocommit
    properties
    connected
    provided
    readOnly
    useUrl
    saveCredentials
    sharedCredentials
    sharedSecrets {
      ...SecretInfoFragment
    }
    credentialsSaved
    authNeeded
    folder
    nodePath
    connectTime
    connectionError {
      ...ServerErrorFragment
    }
    serverVersion
    clientVersion
    origin {
      ...ObjectOriginFragment
    }
    authModel
    authProperties {
      ...ObjectPropertyInfoFragment
    }
    providerProperties
    networkHandlersConfig {
      ...NetworkHandlerConfigFragment
    }
    features
    navigatorSettings {
      ...NavigatorSettingsFragment
    }
    supportedDataFormats
    configurationType
    canViewSettings
    canEdit
    canDelete
    projectId
    requiredAuth
    defaultCatalogName
    defaultSchemaName
    tools
  }
}
Variables
{"projectId": 4, "id": 4}
Response
{
  "data": {
    "connectionInfo": {
      "id": 4,
      "driverId": 4,
      "name": "abc123",
      "description": "xyz789",
      "host": "abc123",
      "port": "xyz789",
      "serverName": "xyz789",
      "databaseName": "xyz789",
      "url": "abc123",
      "mainPropertyValues": Object,
      "keepAliveInterval": 123,
      "autocommit": true,
      "properties": Object,
      "connected": true,
      "provided": true,
      "readOnly": false,
      "useUrl": true,
      "saveCredentials": false,
      "sharedCredentials": false,
      "sharedSecrets": [SecretInfo],
      "credentialsSaved": true,
      "authNeeded": true,
      "folder": 4,
      "nodePath": "abc123",
      "connectTime": "xyz789",
      "connectionError": ServerError,
      "serverVersion": "xyz789",
      "clientVersion": "abc123",
      "origin": ObjectOrigin,
      "authModel": "4",
      "authProperties": [ObjectPropertyInfo],
      "providerProperties": Object,
      "networkHandlersConfig": [NetworkHandlerConfig],
      "features": ["abc123"],
      "navigatorSettings": NavigatorSettings,
      "supportedDataFormats": ["resultset"],
      "configurationType": "MANUAL",
      "canViewSettings": false,
      "canEdit": true,
      "canDelete": true,
      "projectId": 4,
      "requiredAuth": "xyz789",
      "defaultCatalogName": "abc123",
      "defaultSchemaName": "xyz789",
      "tools": ["xyz789"]
    }
  }
}

createTeam

Description

Creates a new team with the specified teamId

Response

Returns an AdminTeamInfo!

Arguments
Name Description
teamId - ID!
teamName - String
description - String

Example

Query
query createTeam(
  $teamId: ID!,
  $teamName: String,
  $description: String
) {
  createTeam(
    teamId: $teamId,
    teamName: $teamName,
    description: $description
  ) {
    teamId
    teamName
    description
    metaParameters
    grantedUsers
    grantedUsersInfo {
      ...AdminUserTeamGrantInfoFragment
    }
    grantedConnections {
      ...AdminConnectionGrantInfoFragment
    }
    teamPermissions
  }
}
Variables
{
  "teamId": 4,
  "teamName": "xyz789",
  "description": "abc123"
}
Response
{
  "data": {
    "createTeam": {
      "teamId": 4,
      "teamName": "xyz789",
      "description": "abc123",
      "metaParameters": Object,
      "grantedUsers": ["4"],
      "grantedUsersInfo": [AdminUserTeamGrantInfo],
      "grantedConnections": [AdminConnectionGrantInfo],
      "teamPermissions": ["4"]
    }
  }
}

createUser

Description

Creates a new user with the specified userId

Response

Returns an AdminUserInfo!

Arguments
Name Description
userId - ID!
enabled - Boolean!
authRole - String

Example

Query
query createUser(
  $userId: ID!,
  $enabled: Boolean!,
  $authRole: String
) {
  createUser(
    userId: $userId,
    enabled: $enabled,
    authRole: $authRole
  ) {
    userId
    metaParameters
    configurationParameters
    grantedTeams
    grantedConnections {
      ...AdminConnectionGrantInfoFragment
    }
    origins {
      ...ObjectOriginFragment
    }
    linkedAuthProviders
    enabled
    authRole
    disableDate
    disabledBy
    disableReason
  }
}
Variables
{
  "userId": "4",
  "enabled": false,
  "authRole": "xyz789"
}
Response
{
  "data": {
    "createUser": {
      "userId": 4,
      "metaParameters": Object,
      "configurationParameters": Object,
      "grantedTeams": ["4"],
      "grantedConnections": [AdminConnectionGrantInfo],
      "origins": [ObjectOrigin],
      "linkedAuthProviders": ["xyz789"],
      "enabled": false,
      "authRole": "abc123",
      "disableDate": "2007-12-03T10:15:30Z",
      "disabledBy": "xyz789",
      "disableReason": "abc123"
    }
  }
}

dataTransferAvailableImportStreamProcessors

Description

Returns available transfer processors for data transfer import

Example

Query
query dataTransferAvailableImportStreamProcessors {
  dataTransferAvailableImportStreamProcessors {
    id
    name
    description
    fileExtension
    appFileExtension
    appName
    order
    icon
    properties {
      ...ObjectPropertyInfoFragment
    }
    isBinary
    isHTML
  }
}
Response
{
  "data": {
    "dataTransferAvailableImportStreamProcessors": [
      {
        "id": 4,
        "name": "abc123",
        "description": "abc123",
        "fileExtension": "xyz789",
        "appFileExtension": "xyz789",
        "appName": "abc123",
        "order": 987,
        "icon": "abc123",
        "properties": [ObjectPropertyInfo],
        "isBinary": true,
        "isHTML": false
      }
    ]
  }
}

dataTransferAvailableStreamProcessors

Description

Returns available transfer processors for data transfer export

Example

Query
query dataTransferAvailableStreamProcessors {
  dataTransferAvailableStreamProcessors {
    id
    name
    description
    fileExtension
    appFileExtension
    appName
    order
    icon
    properties {
      ...ObjectPropertyInfoFragment
    }
    isBinary
    isHTML
  }
}
Response
{
  "data": {
    "dataTransferAvailableStreamProcessors": [
      {
        "id": "4",
        "name": "xyz789",
        "description": "xyz789",
        "fileExtension": "abc123",
        "appFileExtension": "abc123",
        "appName": "abc123",
        "order": 123,
        "icon": "xyz789",
        "properties": [ObjectPropertyInfo],
        "isBinary": true,
        "isHTML": true
      }
    ]
  }
}

dataTransferDefaultExportSettings

Description

Returns default export settings for data transfer

Example

Query
query dataTransferDefaultExportSettings {
  dataTransferDefaultExportSettings {
    outputSettings {
      ...DataTransferOutputSettingsFragment
    }
    supportedEncodings
  }
}
Response
{
  "data": {
    "dataTransferDefaultExportSettings": {
      "outputSettings": DataTransferOutputSettings,
      "supportedEncodings": ["abc123"]
    }
  }
}

dataTransferExportDataFromContainer

Description

Creates async task for data transfer export from the container node path

Response

Returns an AsyncTaskInfo!

Arguments
Name Description
projectId - ID
connectionId - ID!
containerNodePath - ID!
parameters - DataTransferParameters!

Example

Query
query dataTransferExportDataFromContainer(
  $projectId: ID,
  $connectionId: ID!,
  $containerNodePath: ID!,
  $parameters: DataTransferParameters!
) {
  dataTransferExportDataFromContainer(
    projectId: $projectId,
    connectionId: $connectionId,
    containerNodePath: $containerNodePath,
    parameters: $parameters
  ) {
    id
    name
    running
    status
    error {
      ...ServerErrorFragment
    }
    taskResult
  }
}
Variables
{
  "projectId": 4,
  "connectionId": 4,
  "containerNodePath": 4,
  "parameters": DataTransferParameters
}
Response
{
  "data": {
    "dataTransferExportDataFromContainer": {
      "id": "xyz789",
      "name": "abc123",
      "running": true,
      "status": "abc123",
      "error": ServerError,
      "taskResult": Object
    }
  }
}

dataTransferExportDataFromResults

Description

Creates async task for data transfer export from results

Response

Returns an AsyncTaskInfo!

Arguments
Name Description
projectId - ID
connectionId - ID!
contextId - ID!
resultsId - ID!
parameters - DataTransferParameters!

Example

Query
query dataTransferExportDataFromResults(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $resultsId: ID!,
  $parameters: DataTransferParameters!
) {
  dataTransferExportDataFromResults(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    resultsId: $resultsId,
    parameters: $parameters
  ) {
    id
    name
    running
    status
    error {
      ...ServerErrorFragment
    }
    taskResult
  }
}
Variables
{
  "projectId": "4",
  "connectionId": 4,
  "contextId": 4,
  "resultsId": 4,
  "parameters": DataTransferParameters
}
Response
{
  "data": {
    "dataTransferExportDataFromResults": {
      "id": "abc123",
      "name": "xyz789",
      "running": false,
      "status": "abc123",
      "error": ServerError,
      "taskResult": Object
    }
  }
}

dataTransferRemoveDataFile

25.0.1
Description

Deletes data transfer file by ID

Response

Returns a Boolean

Arguments
Name Description
dataFileId - String!

Example

Query
query dataTransferRemoveDataFile($dataFileId: String!) {
  dataTransferRemoveDataFile(dataFileId: $dataFileId)
}
Variables
{"dataFileId": "xyz789"}
Response
{"data": {"dataTransferRemoveDataFile": true}}

dbSmTerminate

Description

Terminates database sessions for the specified connection.

Response

Returns a Boolean!

Arguments
Name Description
projectId - ID!
connectionId - ID!
sessionIds - [String!]!

Example

Query
query dbSmTerminate(
  $projectId: ID!,
  $connectionId: ID!,
  $sessionIds: [String!]!
) {
  dbSmTerminate(
    projectId: $projectId,
    connectionId: $connectionId,
    sessionIds: $sessionIds
  )
}
Variables
{
  "projectId": "4",
  "connectionId": 4,
  "sessionIds": ["abc123"]
}
Response
{"data": {"dbSmTerminate": true}}

deleteAuthProviderConfiguration

Description

Deletes auth provider configuration by id

Response

Returns a Boolean!

Arguments
Name Description
id - ID!

Example

Query
query deleteAuthProviderConfiguration($id: ID!) {
  deleteAuthProviderConfiguration(id: $id)
}
Variables
{"id": "4"}
Response
{"data": {"deleteAuthProviderConfiguration": false}}

deleteConnectionsAccess

Description

Deletes access to the connections for the specified subjects (users and teams)

Response

Returns a Boolean

Arguments
Name Description
projectId - ID!
connectionIds - [ID!]!
subjects - [ID!]!

Example

Query
query deleteConnectionsAccess(
  $projectId: ID!,
  $connectionIds: [ID!]!,
  $subjects: [ID!]!
) {
  deleteConnectionsAccess(
    projectId: $projectId,
    connectionIds: $connectionIds,
    subjects: $subjects
  )
}
Variables
{
  "projectId": 4,
  "connectionIds": [4],
  "subjects": ["4"]
}
Response
{"data": {"deleteConnectionsAccess": false}}

deleteSecretConfiguration

Description

Deletes a secret configuration by its ID. Returns true if the deletion was successful.

Response

Returns a Boolean!

Arguments
Name Description
configurationId - ID!

Example

Query
query deleteSecretConfiguration($configurationId: ID!) {
  deleteSecretConfiguration(configurationId: $configurationId)
}
Variables
{"configurationId": 4}
Response
{"data": {"deleteSecretConfiguration": true}}

deleteTeam

Description

Deletes team by teamId

Response

Returns a Boolean

Arguments
Name Description
teamId - ID!
force - Boolean

Example

Query
query deleteTeam(
  $teamId: ID!,
  $force: Boolean
) {
  deleteTeam(
    teamId: $teamId,
    force: $force
  )
}
Variables
{"teamId": "4", "force": false}
Response
{"data": {"deleteTeam": true}}

deleteUser

Description

Deletes user by userId

Response

Returns a Boolean

Arguments
Name Description
userId - ID!

Example

Query
query deleteUser($userId: ID!) {
  deleteUser(userId: $userId)
}
Variables
{"userId": "4"}
Response
{"data": {"deleteUser": false}}

deleteUserCredentials

Description

Deletes user credentials for the specified userId and providerId

Response

Returns a Boolean

Arguments
Name Description
userId - ID!
providerId - ID!

Example

Query
query deleteUserCredentials(
  $userId: ID!,
  $providerId: ID!
) {
  deleteUserCredentials(
    userId: $userId,
    providerId: $providerId
  )
}
Variables
{"userId": "4", "providerId": 4}
Response
{"data": {"deleteUserCredentials": true}}

deleteUserMetaParameter

Description

Not implemented yet

Response

Returns a Boolean!

Arguments
Name Description
id - ID!

Example

Query
query deleteUserMetaParameter($id: ID!) {
  deleteUserMetaParameter(id: $id)
}
Variables
{"id": "4"}
Response
{"data": {"deleteUserMetaParameter": true}}

dmCertificateType

Description

Returns the domain certificate type. Null if the certificate is not set.

Response

Returns a DomainCertificateType

Example

Query
query dmCertificateType {
  dmCertificateType
}
Response
{"data": {"dmCertificateType": "CUSTOM"}}

dmOrganization

Description

Returns the organization information for the domain manager.

Response

Returns an OrganizationInfo

Example

Query
query dmOrganization {
  dmOrganization {
    id
    baseDomain
    subdomain
    deployments {
      ...DeploymentInfoFragment
    }
    currentDeployment {
      ...DeploymentInfoFragment
    }
  }
}
Response
{
  "data": {
    "dmOrganization": {
      "id": "4",
      "baseDomain": "xyz789",
      "subdomain": "xyz789",
      "deployments": [DeploymentInfo],
      "currentDeployment": DeploymentInfo
    }
  }
}

dmStatusInfo

Description

Returns the domain manager availability status.

Response

Returns a DomainManagerAvailability!

Example

Query
query dmStatusInfo {
  dmStatusInfo {
    certbot
    server
    externalStatus
  }
}
Response
{
  "data": {
    "dmStatusInfo": {
      "certbot": true,
      "server": true,
      "externalStatus": "AWS_MARKETPLACE_AGREEMENT_NOT_FOUND"
    }
  }
}

dmVerifyDeploymentAddress

Description

Verifies the deployment address and returns information about its validity.

Arguments
Name Description
address - String!

Example

Query
query dmVerifyDeploymentAddress($address: String!) {
  dmVerifyDeploymentAddress(address: $address) {
    valid
    message
  }
}
Variables
{"address": "abc123"}
Response
{
  "data": {
    "dmVerifyDeploymentAddress": {
      "valid": true,
      "message": "abc123"
    }
  }
}

driverList

Description

Returns list of available drivers

Response

Returns [DriverInfo!]!

Arguments
Name Description
id - ID

Example

Query
query driverList($id: ID) {
  driverList(id: $id) {
    id
    name
    description
    icon
    iconBig
    driverId
    providerId
    driverClassName
    defaultHost
    defaultPort
    defaultDatabase
    defaultServer
    defaultUser
    sampleURL
    driverInfoURL
    driverPropertiesURL
    embedded
    enabled
    requiresServerName
    requiresDatabaseName
    useCustomPage
    licenseRequired
    license
    custom
    promotedScore
    driverProperties {
      ...ObjectPropertyInfoFragment
    }
    driverParameters
    mainProperties {
      ...ObjectPropertyInfoFragment
    }
    providerProperties {
      ...ObjectPropertyInfoFragment
    }
    anonymousAccess
    defaultAuthModel
    applicableAuthModels
    applicableNetworkHandlers
    configurationTypes
    downloadable
    driverInstalled
    driverLibraries {
      ...DriverLibraryInfoFragment
    }
    safeEmbeddedDriver
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "driverList": [
      {
        "id": 4,
        "name": "xyz789",
        "description": "abc123",
        "icon": "abc123",
        "iconBig": "xyz789",
        "driverId": "4",
        "providerId": 4,
        "driverClassName": "xyz789",
        "defaultHost": "abc123",
        "defaultPort": "xyz789",
        "defaultDatabase": "abc123",
        "defaultServer": "xyz789",
        "defaultUser": "abc123",
        "sampleURL": "xyz789",
        "driverInfoURL": "xyz789",
        "driverPropertiesURL": "xyz789",
        "embedded": true,
        "enabled": true,
        "requiresServerName": false,
        "requiresDatabaseName": false,
        "useCustomPage": false,
        "licenseRequired": true,
        "license": "xyz789",
        "custom": true,
        "promotedScore": 123,
        "driverProperties": [ObjectPropertyInfo],
        "driverParameters": Object,
        "mainProperties": [ObjectPropertyInfo],
        "providerProperties": [ObjectPropertyInfo],
        "anonymousAccess": false,
        "defaultAuthModel": "4",
        "applicableAuthModels": ["4"],
        "applicableNetworkHandlers": [4],
        "configurationTypes": ["MANUAL"],
        "downloadable": false,
        "driverInstalled": true,
        "driverLibraries": [DriverLibraryInfo],
        "safeEmbeddedDriver": true
      }
    ]
  }
}

driverProviderList

Description

Returns the list of available driver providers.

Response

Returns [DriverProviderInfo!]!

Example

Query
query driverProviderList {
  driverProviderList {
    id
    name
    icon
  }
}
Response
{
  "data": {
    "driverProviderList": [
      {
        "id": 4,
        "name": "xyz789",
        "icon": "abc123"
      }
    ]
  }
}

emptyEvent

Response

Returns a Boolean

Example

Query
query emptyEvent {
  emptyEvent
}
Response
{"data": {"emptyEvent": true}}

enableUser

Description

Enables or disables user by userId

Response

Returns a Boolean

Arguments
Name Description
userId - ID!
enabled - Boolean!

Example

Query
query enableUser(
  $userId: ID!,
  $enabled: Boolean!
) {
  enableUser(
    userId: $userId,
    enabled: $enabled
  )
}
Variables
{"userId": "4", "enabled": false}
Response
{"data": {"enableUser": false}}

federatedAuthTaskResult

Description

Returns result of federated authentication task

Response

Returns a FederatedAuthResult!

Arguments
Name Description
taskId - String!

Example

Query
query federatedAuthTaskResult($taskId: String!) {
  federatedAuthTaskResult(taskId: $taskId) {
    userTokens {
      ...UserAuthTokenFragment
    }
  }
}
Variables
{"taskId": "xyz789"}
Response
{
  "data": {
    "federatedAuthTaskResult": {
      "userTokens": [UserAuthToken]
    }
  }
}

fsFile

Description

Returns file info for the specified node path

Response

Returns an FSFile!

Arguments
Name Description
nodePath - String!

Example

Query
query fsFile($nodePath: String!) {
  fsFile(nodePath: $nodePath) {
    name
    length
    folder
    metaData
    nodePath
  }
}
Variables
{"nodePath": "abc123"}
Response
{
  "data": {
    "fsFile": {
      "name": "xyz789",
      "length": 987,
      "folder": false,
      "metaData": Object,
      "nodePath": "abc123"
    }
  }
}

fsFileSystem

Description

Returns file system information for the specified project and node path

Response

Returns an FSFileSystem!

Arguments
Name Description
projectId - ID!
nodePath - String!

Example

Query
query fsFileSystem(
  $projectId: ID!,
  $nodePath: String!
) {
  fsFileSystem(
    projectId: $projectId,
    nodePath: $nodePath
  ) {
    id
    nodePath
    requiredAuth
  }
}
Variables
{
  "projectId": "4",
  "nodePath": "xyz789"
}
Response
{
  "data": {
    "fsFileSystem": {
      "id": 4,
      "nodePath": "abc123",
      "requiredAuth": "xyz789"
    }
  }
}

fsListFileSystems

Description

Returns available file systems for the specified project

Response

Returns [FSFileSystem!]!

Arguments
Name Description
projectId - ID!

Example

Query
query fsListFileSystems($projectId: ID!) {
  fsListFileSystems(projectId: $projectId) {
    id
    nodePath
    requiredAuth
  }
}
Variables
{"projectId": 4}
Response
{
  "data": {
    "fsListFileSystems": [
      {
        "id": 4,
        "nodePath": "abc123",
        "requiredAuth": "abc123"
      }
    ]
  }
}

fsListFiles

Description

Returns list of files and folders in the specified folder path

Response

Returns [FSFile!]!

Arguments
Name Description
folderPath - String!

Example

Query
query fsListFiles($folderPath: String!) {
  fsListFiles(folderPath: $folderPath) {
    name
    length
    folder
    metaData
    nodePath
  }
}
Variables
{"folderPath": "abc123"}
Response
{
  "data": {
    "fsListFiles": [
      {
        "name": "xyz789",
        "length": 123,
        "folder": true,
        "metaData": Object,
        "nodePath": "abc123"
      }
    ]
  }
}

fsReadFileContentAsString

Description

Reads file contents as string in UTF-8

Response

Returns a String!

Arguments
Name Description
nodePath - String!

Example

Query
query fsReadFileContentAsString($nodePath: String!) {
  fsReadFileContentAsString(nodePath: $nodePath)
}
Variables
{"nodePath": "abc123"}
Response
{
  "data": {
    "fsReadFileContentAsString": "abc123"
  }
}

generateEntityDiagram

use generateEntityDiagramExtended (24.1.1)
Description

Returns ERD diagram information for the specified object node IDs.

Response

Returns an Object

Arguments
Name Description
objectNodeIds - [ID!]!

Example

Query
query generateEntityDiagram($objectNodeIds: [ID!]!) {
  generateEntityDiagram(objectNodeIds: $objectNodeIds)
}
Variables
{"objectNodeIds": ["4"]}
Response
{"data": {"generateEntityDiagram": Object}}

generateEntityDiagramExtended

Description

Returns ERD diagram information for the specified object node IDs.

Response

Returns an ERDDiagramInfo!

Arguments
Name Description
objectNodeIds - [ID!]!

Example

Query
query generateEntityDiagramExtended($objectNodeIds: [ID!]!) {
  generateEntityDiagramExtended(objectNodeIds: $objectNodeIds) {
    entities {
      ...ERDEntityInfoFragment
    }
    associations {
      ...ERDAssociationInfoFragment
    }
    data {
      ...ERDDiagramDataFragment
    }
    where
    orderBy
    selectItems
  }
}
Variables
{"objectNodeIds": [4]}
Response
{
  "data": {
    "generateEntityDiagramExtended": {
      "entities": [ERDEntityInfo],
      "associations": [ERDAssociationInfo],
      "data": ERDDiagramData,
      "where": "xyz789",
      "orderBy": ["abc123"],
      "selectItems": ["abc123"]
    }
  }
}

getConnectionSubjectAccess

Description

Returns all subjects (users and teams) that have access to the specified connection

Response

Returns [AdminConnectionGrantInfo!]!

Arguments
Name Description
projectId - ID!
connectionId - ID

Example

Query
query getConnectionSubjectAccess(
  $projectId: ID!,
  $connectionId: ID
) {
  getConnectionSubjectAccess(
    projectId: $projectId,
    connectionId: $connectionId
  ) {
    connectionId
    dataSourceId
    subjectId
    subjectType
  }
}
Variables
{"projectId": "4", "connectionId": 4}
Response
{
  "data": {
    "getConnectionSubjectAccess": [
      {
        "connectionId": 4,
        "dataSourceId": "4",
        "subjectId": 4,
        "subjectType": "user"
      }
    ]
  }
}

getSecretManagerConfigurationParameters

Description

Returns a list of secret configuration properties for a specific provider that can be used to create a new secret configuration.

Response

Returns [ObjectPropertyInfo!]!

Arguments
Name Description
providerId - ID!

Example

Query
query getSecretManagerConfigurationParameters($providerId: ID!) {
  getSecretManagerConfigurationParameters(providerId: $providerId) {
    id
    displayName
    description
    hint
    category
    dataType
    value
    validValues
    defaultValue
    length
    features
    order
    supportedConfigurationTypes
    required
    scopes
    conditions {
      ...ConditionFragment
    }
  }
}
Variables
{"providerId": "4"}
Response
{
  "data": {
    "getSecretManagerConfigurationParameters": [
      {
        "id": "abc123",
        "displayName": "abc123",
        "description": "abc123",
        "hint": "abc123",
        "category": "abc123",
        "dataType": "xyz789",
        "value": Object,
        "validValues": [Object],
        "defaultValue": Object,
        "length": "TINY",
        "features": ["xyz789"],
        "order": 123,
        "supportedConfigurationTypes": [
          "abc123"
        ],
        "required": true,
        "scopes": ["xyz789"],
        "conditions": [Condition]
      }
    ]
  }
}

getSubjectConnectionAccess

Description

Returns all connections that the subject (user or team) has access to

Response

Returns [AdminConnectionGrantInfo!]!

Arguments
Name Description
subjectId - ID!

Example

Query
query getSubjectConnectionAccess($subjectId: ID!) {
  getSubjectConnectionAccess(subjectId: $subjectId) {
    connectionId
    dataSourceId
    subjectId
    subjectType
  }
}
Variables
{"subjectId": "4"}
Response
{
  "data": {
    "getSubjectConnectionAccess": [
      {
        "connectionId": "4",
        "dataSourceId": "4",
        "subjectId": "4",
        "subjectType": "user"
      }
    ]
  }
}

gitGetGlobalSettings

Description

Returns the global git configuration settings. Null if git is not configured.

Response

Returns a GitGlobalSettings

Example

Query
query gitGetGlobalSettings {
  gitGetGlobalSettings {
    username
    email
    password
  }
}
Response
{
  "data": {
    "gitGetGlobalSettings": {
      "username": "xyz789",
      "email": "xyz789",
      "password": "abc123"
    }
  }
}

gitGetProjectSettings

Description

Returns the git configuration settings for a specific project. Null if git is not configured for the project.

Response

Returns a GitProjectSettings

Arguments
Name Description
projectId - ID!

Example

Query
query gitGetProjectSettings($projectId: ID!) {
  gitGetProjectSettings(projectId: $projectId) {
    enabled
    repositoryUrl
    branch
    gitIgnoreRules
  }
}
Variables
{"projectId": "4"}
Response
{
  "data": {
    "gitGetProjectSettings": {
      "enabled": true,
      "repositoryUrl": "xyz789",
      "branch": "xyz789",
      "gitIgnoreRules": ["DATASOURCES"]
    }
  }
}

grantUserTeam

Description

Grants user to team with the specified userId and teamId

Response

Returns a Boolean

Arguments
Name Description
userId - ID!
teamId - ID!

Example

Query
query grantUserTeam(
  $userId: ID!,
  $teamId: ID!
) {
  grantUserTeam(
    userId: $userId,
    teamId: $teamId
  )
}
Variables
{"userId": 4, "teamId": "4"}
Response
{"data": {"grantUserTeam": true}}

listAuthProviderConfigurationParameters

Description

Returns all properties of the auth provider with the specified providerId

Response

Returns [ObjectPropertyInfo!]!

Arguments
Name Description
providerId - ID!

Example

Query
query listAuthProviderConfigurationParameters($providerId: ID!) {
  listAuthProviderConfigurationParameters(providerId: $providerId) {
    id
    displayName
    description
    hint
    category
    dataType
    value
    validValues
    defaultValue
    length
    features
    order
    supportedConfigurationTypes
    required
    scopes
    conditions {
      ...ConditionFragment
    }
  }
}
Variables
{"providerId": "4"}
Response
{
  "data": {
    "listAuthProviderConfigurationParameters": [
      {
        "id": "abc123",
        "displayName": "abc123",
        "description": "xyz789",
        "hint": "xyz789",
        "category": "abc123",
        "dataType": "xyz789",
        "value": Object,
        "validValues": [Object],
        "defaultValue": Object,
        "length": "TINY",
        "features": ["xyz789"],
        "order": 123,
        "supportedConfigurationTypes": [
          "xyz789"
        ],
        "required": false,
        "scopes": ["xyz789"],
        "conditions": [Condition]
      }
    ]
  }
}

listAuthProviderConfigurations

Description

Returns all auth provider configurations for the specified providerId. If providerId is not provided, returns all configurations

Arguments
Name Description
providerId - ID

Example

Query
query listAuthProviderConfigurations($providerId: ID) {
  listAuthProviderConfigurations(providerId: $providerId) {
    providerId
    id
    displayName
    disabled
    iconURL
    description
    parameters
    signInLink
    signOutLink
    redirectLink
    metadataLink
    acsLink
    entityIdLink
  }
}
Variables
{"providerId": 4}
Response
{
  "data": {
    "listAuthProviderConfigurations": [
      {
        "providerId": "4",
        "id": 4,
        "displayName": "abc123",
        "disabled": true,
        "iconURL": "xyz789",
        "description": "abc123",
        "parameters": Object,
        "signInLink": "xyz789",
        "signOutLink": "xyz789",
        "redirectLink": "xyz789",
        "metadataLink": "xyz789",
        "acsLink": "xyz789",
        "entityIdLink": "abc123"
      }
    ]
  }
}

listAuthRoles

Description

Returns all auth roles based on the license

Response

Returns [String!]!

Example

Query
query listAuthRoles {
  listAuthRoles
}
Response
{"data": {"listAuthRoles": ["xyz789"]}}

listClouds

Description

List of available clouds (AWS, GCP, Azure, etc.)

Response

Returns [CBCloud!]

Example

Query
query listClouds {
  listClouds {
    id
    name
    authProvider
  }
}
Response
{
  "data": {
    "listClouds": [
      {
        "id": "abc123",
        "name": "abc123",
        "authProvider": "xyz789"
      }
    ]
  }
}

listFeatureSets

Description

Returns all available feature sets that can be enabled or disabled

Response

Returns [WebFeatureSet!]!

Example

Query
query listFeatureSets {
  listFeatureSets {
    id
    label
    description
    icon
    enabled
  }
}
Response
{
  "data": {
    "listFeatureSets": [
      {
        "id": "xyz789",
        "label": "xyz789",
        "description": "abc123",
        "icon": "xyz789",
        "enabled": false
      }
    ]
  }
}

listPermissions

Description

Returns all permissions

Response

Returns [AdminPermissionInfo!]!

Example

Query
query listPermissions {
  listPermissions {
    id
    label
    description
    provider
    category
  }
}
Response
{
  "data": {
    "listPermissions": [
      {
        "id": "4",
        "label": "abc123",
        "description": "abc123",
        "provider": "abc123",
        "category": "abc123"
      }
    ]
  }
}

listProjects

Description

Returns list of accessible user projects

Response

Returns [ProjectInfo!]!

Example

Query
query listProjects {
  listProjects {
    id
    global
    shared
    name
    description
    canEditDataSources
    canViewDataSources
    canEditResources
    canViewResources
    resourceTypes {
      ...RMResourceTypeFragment
    }
  }
}
Response
{
  "data": {
    "listProjects": [
      {
        "id": "xyz789",
        "global": true,
        "shared": true,
        "name": "abc123",
        "description": "abc123",
        "canEditDataSources": true,
        "canViewDataSources": true,
        "canEditResources": true,
        "canViewResources": true,
        "resourceTypes": [RMResourceType]
      }
    ]
  }
}

listTeamMetaParameters

Description

Returns teams meta parameters for displaying in the UI

Response

Returns [ObjectPropertyInfo!]!

Example

Query
query listTeamMetaParameters {
  listTeamMetaParameters {
    id
    displayName
    description
    hint
    category
    dataType
    value
    validValues
    defaultValue
    length
    features
    order
    supportedConfigurationTypes
    required
    scopes
    conditions {
      ...ConditionFragment
    }
  }
}
Response
{
  "data": {
    "listTeamMetaParameters": [
      {
        "id": "xyz789",
        "displayName": "xyz789",
        "description": "abc123",
        "hint": "xyz789",
        "category": "xyz789",
        "dataType": "xyz789",
        "value": Object,
        "validValues": [Object],
        "defaultValue": Object,
        "length": "TINY",
        "features": ["abc123"],
        "order": 123,
        "supportedConfigurationTypes": [
          "xyz789"
        ],
        "required": true,
        "scopes": ["abc123"],
        "conditions": [Condition]
      }
    ]
  }
}

listTeamRoles

Description

Returns all team roles

Response

Returns [String!]!

Example

Query
query listTeamRoles {
  listTeamRoles
}
Response
{"data": {"listTeamRoles": ["xyz789"]}}

listTeams

Description

Returns information about team by teamId. If teamId is not provided, returns information about all teams

Response

Returns [AdminTeamInfo!]!

Arguments
Name Description
teamId - ID

Example

Query
query listTeams($teamId: ID) {
  listTeams(teamId: $teamId) {
    teamId
    teamName
    description
    metaParameters
    grantedUsers
    grantedUsersInfo {
      ...AdminUserTeamGrantInfoFragment
    }
    grantedConnections {
      ...AdminConnectionGrantInfoFragment
    }
    teamPermissions
  }
}
Variables
{"teamId": 4}
Response
{
  "data": {
    "listTeams": [
      {
        "teamId": "4",
        "teamName": "xyz789",
        "description": "abc123",
        "metaParameters": Object,
        "grantedUsers": [4],
        "grantedUsersInfo": [AdminUserTeamGrantInfo],
        "grantedConnections": [AdminConnectionGrantInfo],
        "teamPermissions": ["4"]
      }
    ]
  }
}

listUserProfileProperties

Description

Returns properties that can be shown in user profile

Response

Returns [ObjectPropertyInfo!]!

Example

Query
query listUserProfileProperties {
  listUserProfileProperties {
    id
    displayName
    description
    hint
    category
    dataType
    value
    validValues
    defaultValue
    length
    features
    order
    supportedConfigurationTypes
    required
    scopes
    conditions {
      ...ConditionFragment
    }
  }
}
Response
{
  "data": {
    "listUserProfileProperties": [
      {
        "id": "abc123",
        "displayName": "xyz789",
        "description": "xyz789",
        "hint": "abc123",
        "category": "abc123",
        "dataType": "abc123",
        "value": Object,
        "validValues": [Object],
        "defaultValue": Object,
        "length": "TINY",
        "features": ["xyz789"],
        "order": 987,
        "supportedConfigurationTypes": [
          "abc123"
        ],
        "required": false,
        "scopes": ["abc123"],
        "conditions": [Condition]
      }
    ]
  }
}

listUsers

Description

Returns all users with pagination and filter

Response

Returns [AdminUserInfo!]!

Arguments
Name Description
page - PageInput!
filter - AdminUserFilterInput!

Example

Query
query listUsers(
  $page: PageInput!,
  $filter: AdminUserFilterInput!
) {
  listUsers(
    page: $page,
    filter: $filter
  ) {
    userId
    metaParameters
    configurationParameters
    grantedTeams
    grantedConnections {
      ...AdminConnectionGrantInfoFragment
    }
    origins {
      ...ObjectOriginFragment
    }
    linkedAuthProviders
    enabled
    authRole
    disableDate
    disabledBy
    disableReason
  }
}
Variables
{
  "page": PageInput,
  "filter": AdminUserFilterInput
}
Response
{
  "data": {
    "listUsers": [
      {
        "userId": 4,
        "metaParameters": Object,
        "configurationParameters": Object,
        "grantedTeams": [4],
        "grantedConnections": [AdminConnectionGrantInfo],
        "origins": [ObjectOrigin],
        "linkedAuthProviders": ["xyz789"],
        "enabled": true,
        "authRole": "abc123",
        "disableDate": "2007-12-03T10:15:30Z",
        "disabledBy": "abc123",
        "disableReason": "abc123"
      }
    ]
  }
}

metadataGetNodeDDL

Description

Returns node DDL for the specified node ID

Response

Returns a String

Arguments
Name Description
nodeId - ID!
options - Object

Example

Query
query metadataGetNodeDDL(
  $nodeId: ID!,
  $options: Object
) {
  metadataGetNodeDDL(
    nodeId: $nodeId,
    options: $options
  )
}
Variables
{"nodeId": 4, "options": Object}
Response
{"data": {"metadataGetNodeDDL": "xyz789"}}

metadataGetNodeExtendedDDL

Description

Returns extended node DDL for the specified node ID (e.g., Oracle or MySQL package)

Response

Returns a String

Arguments
Name Description
nodeId - ID!

Example

Query
query metadataGetNodeExtendedDDL($nodeId: ID!) {
  metadataGetNodeExtendedDDL(nodeId: $nodeId)
}
Variables
{"nodeId": 4}
Response
{
  "data": {
    "metadataGetNodeExtendedDDL": "xyz789"
  }
}

msGetServiceConfiguration

Response

Returns a String!

Arguments
Name Description
type - MSServiceType!

Example

Query
query msGetServiceConfiguration($type: MSServiceType!) {
  msGetServiceConfiguration(type: $type)
}
Variables
{"type": "DOMAIN_CONTROLLER"}
Response
{
  "data": {
    "msGetServiceConfiguration": "abc123"
  }
}

msListServices

Response

Returns an MSServiceInfo

Example

Query
query msListServices {
  msListServices {
    id
    type
    endpoint
    nodes {
      ...MSServiceNodeFragment
    }
  }
}
Response
{
  "data": {
    "msListServices": {
      "id": "xyz789",
      "type": "DOMAIN_CONTROLLER",
      "endpoint": "abc123",
      "nodes": [MSServiceNode]
    }
  }
}

navGetStructContainers

Description

contextId currently not using

Response

Returns a DatabaseStructContainers!

Arguments
Name Description
projectId - ID
connectionId - ID!
contextId - ID
catalog - ID

Example

Query
query navGetStructContainers(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID,
  $catalog: ID
) {
  navGetStructContainers(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    catalog: $catalog
  ) {
    parentNode {
      ...NavigatorNodeInfoFragment
    }
    catalogList {
      ...DatabaseCatalogFragment
    }
    schemaList {
      ...NavigatorNodeInfoFragment
    }
    supportsCatalogChange
    supportsSchemaChange
  }
}
Variables
{
  "projectId": 4,
  "connectionId": 4,
  "contextId": "4",
  "catalog": 4
}
Response
{
  "data": {
    "navGetStructContainers": {
      "parentNode": NavigatorNodeInfo,
      "catalogList": [DatabaseCatalog],
      "schemaList": [NavigatorNodeInfo],
      "supportsCatalogChange": false,
      "supportsSchemaChange": false
    }
  }
}

navNodeChildren

Description

Returns child nodes based on parent node path

Response

Returns [NavigatorNodeInfo!]!

Arguments
Name Description
parentPath - ID!
offset - Int
limit - Int
onlyFolders - Boolean

Example

Query
query navNodeChildren(
  $parentPath: ID!,
  $offset: Int,
  $limit: Int,
  $onlyFolders: Boolean
) {
  navNodeChildren(
    parentPath: $parentPath,
    offset: $offset,
    limit: $limit,
    onlyFolders: $onlyFolders
  ) {
    id
    uri
    name
    fullName
    plainName
    icon
    description
    nodeType
    hasChildren
    projectId
    object {
      ...DatabaseObjectInfoFragment
    }
    objectId
    features
    nodeDetails {
      ...ObjectPropertyInfoFragment
    }
    folder
    inline
    navigable
    filtered
    filter {
      ...NavigatorNodeFilterFragment
    }
  }
}
Variables
{"parentPath": 4, "offset": 987, "limit": 123, "onlyFolders": false}
Response
{
  "data": {
    "navNodeChildren": [
      {
        "id": 4,
        "uri": "4",
        "name": "xyz789",
        "fullName": "xyz789",
        "plainName": "abc123",
        "icon": "abc123",
        "description": "abc123",
        "nodeType": "xyz789",
        "hasChildren": false,
        "projectId": "abc123",
        "object": DatabaseObjectInfo,
        "objectId": "xyz789",
        "features": ["abc123"],
        "nodeDetails": [ObjectPropertyInfo],
        "folder": true,
        "inline": false,
        "navigable": true,
        "filtered": true,
        "filter": NavigatorNodeFilter
      }
    ]
  }
}

navNodeInfo

Description

Returns node info for the specified node path

Response

Returns a NavigatorNodeInfo!

Arguments
Name Description
nodePath - ID!

Example

Query
query navNodeInfo($nodePath: ID!) {
  navNodeInfo(nodePath: $nodePath) {
    id
    uri
    name
    fullName
    plainName
    icon
    description
    nodeType
    hasChildren
    projectId
    object {
      ...DatabaseObjectInfoFragment
    }
    objectId
    features
    nodeDetails {
      ...ObjectPropertyInfoFragment
    }
    folder
    inline
    navigable
    filtered
    filter {
      ...NavigatorNodeFilterFragment
    }
  }
}
Variables
{"nodePath": 4}
Response
{
  "data": {
    "navNodeInfo": {
      "id": 4,
      "uri": 4,
      "name": "xyz789",
      "fullName": "xyz789",
      "plainName": "xyz789",
      "icon": "xyz789",
      "description": "abc123",
      "nodeType": "abc123",
      "hasChildren": false,
      "projectId": "xyz789",
      "object": DatabaseObjectInfo,
      "objectId": "abc123",
      "features": ["xyz789"],
      "nodeDetails": [ObjectPropertyInfo],
      "folder": false,
      "inline": true,
      "navigable": true,
      "filtered": true,
      "filter": NavigatorNodeFilter
    }
  }
}

navNodeParents

Description

Returns parent nodes for the specified node path

Response

Returns [NavigatorNodeInfo!]!

Arguments
Name Description
nodePath - ID!

Example

Query
query navNodeParents($nodePath: ID!) {
  navNodeParents(nodePath: $nodePath) {
    id
    uri
    name
    fullName
    plainName
    icon
    description
    nodeType
    hasChildren
    projectId
    object {
      ...DatabaseObjectInfoFragment
    }
    objectId
    features
    nodeDetails {
      ...ObjectPropertyInfoFragment
    }
    folder
    inline
    navigable
    filtered
    filter {
      ...NavigatorNodeFilterFragment
    }
  }
}
Variables
{"nodePath": 4}
Response
{
  "data": {
    "navNodeParents": [
      {
        "id": "4",
        "uri": 4,
        "name": "xyz789",
        "fullName": "xyz789",
        "plainName": "xyz789",
        "icon": "xyz789",
        "description": "xyz789",
        "nodeType": "xyz789",
        "hasChildren": false,
        "projectId": "xyz789",
        "object": DatabaseObjectInfo,
        "objectId": "xyz789",
        "features": ["abc123"],
        "nodeDetails": [ObjectPropertyInfo],
        "folder": true,
        "inline": false,
        "navigable": true,
        "filtered": true,
        "filter": NavigatorNodeFilter
      }
    ]
  }
}

navRefreshNode

No longer supported
Description

Refreshes node based on the node path

Response

Returns a Boolean

Arguments
Name Description
nodePath - ID!

Example

Query
query navRefreshNode($nodePath: ID!) {
  navRefreshNode(nodePath: $nodePath)
}
Variables
{"nodePath": "4"}
Response
{"data": {"navRefreshNode": false}}

networkHandlers

Description

Returns list of available network handlers

Response

Returns [NetworkHandlerDescriptor!]!

Example

Query
query networkHandlers {
  networkHandlers {
    id
    codeName
    label
    description
    secured
    type
    properties {
      ...ObjectPropertyInfoFragment
    }
  }
}
Response
{
  "data": {
    "networkHandlers": [
      {
        "id": 4,
        "codeName": "abc123",
        "label": "abc123",
        "description": "abc123",
        "secured": true,
        "type": "TUNNEL",
        "properties": [ObjectPropertyInfo]
      }
    ]
  }
}

productSettings

Description

Returns product settings

Response

Returns a ProductSettings!

Example

Query
query productSettings {
  productSettings {
    groups {
      ...ProductSettingsGroupFragment
    }
    settings {
      ...ObjectPropertyInfoFragment
    }
  }
}
Response
{
  "data": {
    "productSettings": {
      "groups": [ProductSettingsGroup],
      "settings": [ObjectPropertyInfo]
    }
  }
}

provisioningListUsers

Description

Returns a list of users for provisioning based on the auth provider and configuration ID.

Response

Returns [ExternalUserInfo!]!

Arguments
Name Description
authProviderId - ID!
authConfigurationId - ID!
filter - ExternalUsersFilter!

Example

Query
query provisioningListUsers(
  $authProviderId: ID!,
  $authConfigurationId: ID!,
  $filter: ExternalUsersFilter!
) {
  provisioningListUsers(
    authProviderId: $authProviderId,
    authConfigurationId: $authConfigurationId,
    filter: $filter
  ) {
    userId
    metaParameters
    authRole
  }
}
Variables
{
  "authProviderId": "4",
  "authConfigurationId": 4,
  "filter": ExternalUsersFilter
}
Response
{
  "data": {
    "provisioningListUsers": [
      {
        "userId": "xyz789",
        "metaParameters": Object,
        "authRole": "xyz789"
      }
    ]
  }
}

qmAccessibleUsers

Description

Returns a list of QM user IDs that has access to all QM queries.

Response

Returns [String!]!

Example

Query
query qmAccessibleUsers {
  qmAccessibleUsers
}
Response
{"data": {"qmAccessibleUsers": ["abc123"]}}

qmQueriesSearchAdmin

Description

Returns a filtered list of QM queries used by the administrator.

Response

Returns an QMMFilterResponse!

Arguments
Name Description
filter - QMAdminSearchFilter!

Example

Query
query qmQueriesSearchAdmin($filter: QMAdminSearchFilter!) {
  qmQueriesSearchAdmin(filter: $filter) {
    hasMore
    objects {
      ...QMMObjectFragment
    }
  }
}
Variables
{"filter": QMAdminSearchFilter}
Response
{
  "data": {
    "qmQueriesSearchAdmin": {
      "hasMore": true,
      "objects": [QMMObject]
    }
  }
}

qmQueriesSearchSupervisor

Description

Returns a filtered list of QM queries used by the supervisor (has access to all QM queries).

Response

Returns an QMMFilterResponse!

Arguments
Name Description
filter - QMSupervisorSearchFilter!

Example

Query
query qmQueriesSearchSupervisor($filter: QMSupervisorSearchFilter!) {
  qmQueriesSearchSupervisor(filter: $filter) {
    hasMore
    objects {
      ...QMMObjectFragment
    }
  }
}
Variables
{"filter": QMSupervisorSearchFilter}
Response
{
  "data": {
    "qmQueriesSearchSupervisor": {
      "hasMore": false,
      "objects": [QMMObject]
    }
  }
}

qmQueriesSearchUser

Description

Returns a filtered list of QM queries used by the current user.

Response

Returns an QMMFilterResponse!

Arguments
Name Description
filter - QMSearchFilter!

Example

Query
query qmQueriesSearchUser($filter: QMSearchFilter!) {
  qmQueriesSearchUser(filter: $filter) {
    hasMore
    objects {
      ...QMMObjectFragment
    }
  }
}
Variables
{"filter": QMSearchFilter}
Response
{
  "data": {
    "qmQueriesSearchUser": {
      "hasMore": false,
      "objects": [QMMObject]
    }
  }
}

readSessionLog

Description

Reads session log entries

Response

Returns [LogEntry!]!

Arguments
Name Description
maxEntries - Int
clearEntries - Boolean

Example

Query
query readSessionLog(
  $maxEntries: Int,
  $clearEntries: Boolean
) {
  readSessionLog(
    maxEntries: $maxEntries,
    clearEntries: $clearEntries
  ) {
    time
    type
    message
    stackTrace
  }
}
Variables
{"maxEntries": 987, "clearEntries": true}
Response
{
  "data": {
    "readSessionLog": [
      {
        "time": "2007-12-03T10:15:30Z",
        "type": "abc123",
        "message": "xyz789",
        "stackTrace": "xyz789"
      }
    ]
  }
}

revokeUserTeam

Description

Revokes user from team with the specified userId and teamId

Response

Returns a Boolean

Arguments
Name Description
userId - ID!
teamId - ID!

Example

Query
query revokeUserTeam(
  $userId: ID!,
  $teamId: ID!
) {
  revokeUserTeam(
    userId: $userId,
    teamId: $teamId
  )
}
Variables
{
  "userId": "4",
  "teamId": "4"
}
Response
{"data": {"revokeUserTeam": true}}

rmGetDataSet

Description

Returns the dataset information for the specified project and dataset path.

Response

Returns a DataSetInfo!

Arguments
Name Description
projectId - ID!
datasetPath - String!

Example

Query
query rmGetDataSet(
  $projectId: ID!,
  $datasetPath: String!
) {
  rmGetDataSet(
    projectId: $projectId,
    datasetPath: $datasetPath
  ) {
    displayName
    description
    draft
    queries {
      ...DataSetQueryInfoFragment
    }
    datasetPath
    projectId
  }
}
Variables
{"projectId": 4, "datasetPath": "xyz789"}
Response
{
  "data": {
    "rmGetDataSet": {
      "displayName": "abc123",
      "description": "xyz789",
      "draft": false,
      "queries": [DataSetQueryInfo],
      "datasetPath": "abc123",
      "projectId": "4"
    }
  }
}

rmListProjectGrantedPermissions

Description

Returns project permissions for the specified project. Can be read only by users with admin permissions

Response

Returns [AdminObjectGrantInfo!]!

Arguments
Name Description
projectId - String!

Example

Query
query rmListProjectGrantedPermissions($projectId: String!) {
  rmListProjectGrantedPermissions(projectId: $projectId) {
    subjectId
    subjectType
    objectPermissions {
      ...AdminObjectPermissionsFragment
    }
  }
}
Variables
{"projectId": "abc123"}
Response
{
  "data": {
    "rmListProjectGrantedPermissions": [
      {
        "subjectId": 4,
        "subjectType": "user",
        "objectPermissions": AdminObjectPermissions
      }
    ]
  }
}

rmListProjectPermissions

Description

Returns available project permissions. Can be read only by users with admin permissions

Response

Returns [AdminPermissionInfo!]!

Example

Query
query rmListProjectPermissions {
  rmListProjectPermissions {
    id
    label
    description
    provider
    category
  }
}
Response
{
  "data": {
    "rmListProjectPermissions": [
      {
        "id": "4",
        "label": "abc123",
        "description": "xyz789",
        "provider": "abc123",
        "category": "abc123"
      }
    ]
  }
}

rmListProjects

Description

List accessible projects for a current user

Response

Returns [RMProject!]!

Example

Query
query rmListProjects {
  rmListProjects {
    id
    name
    description
    shared
    global
    createTime
    creator
    projectPermissions
    resourceTypes {
      ...RMResourceTypeFragment
    }
  }
}
Response
{
  "data": {
    "rmListProjects": [
      {
        "id": "4",
        "name": "abc123",
        "description": "xyz789",
        "shared": true,
        "global": false,
        "createTime": "2007-12-03T10:15:30Z",
        "creator": "abc123",
        "projectPermissions": ["xyz789"],
        "resourceTypes": [RMResourceType]
      }
    ]
  }
}

rmListResources

Description

Returns resources in the specified project and folder. If folder is not specified, returns resources in the root folder

Response

Returns [RMResource!]!

Arguments
Name Description
projectId - String!
folder - String
nameMask - String
readProperties - Boolean
readHistory - Boolean

Example

Query
query rmListResources(
  $projectId: String!,
  $folder: String,
  $nameMask: String,
  $readProperties: Boolean,
  $readHistory: Boolean
) {
  rmListResources(
    projectId: $projectId,
    folder: $folder,
    nameMask: $nameMask,
    readProperties: $readProperties,
    readHistory: $readHistory
  ) {
    name
    folder
    length
    properties
  }
}
Variables
{
  "projectId": "abc123",
  "folder": "abc123",
  "nameMask": "abc123",
  "readProperties": false,
  "readHistory": false
}
Response
{
  "data": {
    "rmListResources": [
      {
        "name": "xyz789",
        "folder": true,
        "length": 987,
        "properties": Object
      }
    ]
  }
}

rmListSharedProjects

Description

List shared projects for a current user

Response

Returns [RMProject!]!

Example

Query
query rmListSharedProjects {
  rmListSharedProjects {
    id
    name
    description
    shared
    global
    createTime
    creator
    projectPermissions
    resourceTypes {
      ...RMResourceTypeFragment
    }
  }
}
Response
{
  "data": {
    "rmListSharedProjects": [
      {
        "id": 4,
        "name": "abc123",
        "description": "xyz789",
        "shared": false,
        "global": true,
        "createTime": "2007-12-03T10:15:30Z",
        "creator": "abc123",
        "projectPermissions": ["xyz789"],
        "resourceTypes": [RMResourceType]
      }
    ]
  }
}

rmListSubjectProjectsPermissionGrants

Description

Returns all project grants bysubjectId. Can be read only by users with admin permissions

Response

Returns [AdminObjectGrantInfo!]!

Arguments
Name Description
subjectId - String!

Example

Query
query rmListSubjectProjectsPermissionGrants($subjectId: String!) {
  rmListSubjectProjectsPermissionGrants(subjectId: $subjectId) {
    subjectId
    subjectType
    objectPermissions {
      ...AdminObjectPermissionsFragment
    }
  }
}
Variables
{"subjectId": "abc123"}
Response
{
  "data": {
    "rmListSubjectProjectsPermissionGrants": [
      {
        "subjectId": 4,
        "subjectType": "user",
        "objectPermissions": AdminObjectPermissions
      }
    ]
  }
}

rmProject

Description

Returns project information by projectId

Response

Returns an RMProject!

Arguments
Name Description
projectId - String!

Example

Query
query rmProject($projectId: String!) {
  rmProject(projectId: $projectId) {
    id
    name
    description
    shared
    global
    createTime
    creator
    projectPermissions
    resourceTypes {
      ...RMResourceTypeFragment
    }
  }
}
Variables
{"projectId": "abc123"}
Response
{
  "data": {
    "rmProject": {
      "id": 4,
      "name": "xyz789",
      "description": "xyz789",
      "shared": false,
      "global": true,
      "createTime": "2007-12-03T10:15:30Z",
      "creator": "xyz789",
      "projectPermissions": ["xyz789"],
      "resourceTypes": [RMResourceType]
    }
  }
}

rmReadResourceAsString

Description

Reads resource contents as string in UTF-8

Response

Returns a String!

Arguments
Name Description
projectId - String!
resourcePath - String!

Example

Query
query rmReadResourceAsString(
  $projectId: String!,
  $resourcePath: String!
) {
  rmReadResourceAsString(
    projectId: $projectId,
    resourcePath: $resourcePath
  )
}
Variables
{
  "projectId": "xyz789",
  "resourcePath": "xyz789"
}
Response
{
  "data": {
    "rmReadResourceAsString": "abc123"
  }
}

saveAuthProviderConfiguration

Description

Saves auth provider configuration with the specified parameters

Response

Returns an AdminAuthProviderConfiguration!

Arguments
Name Description
providerId - ID!
id - ID!
displayName - String
disabled - Boolean
iconURL - String
description - String
parameters - Object

Example

Query
query saveAuthProviderConfiguration(
  $providerId: ID!,
  $id: ID!,
  $displayName: String,
  $disabled: Boolean,
  $iconURL: String,
  $description: String,
  $parameters: Object
) {
  saveAuthProviderConfiguration(
    providerId: $providerId,
    id: $id,
    displayName: $displayName,
    disabled: $disabled,
    iconURL: $iconURL,
    description: $description,
    parameters: $parameters
  ) {
    providerId
    id
    displayName
    disabled
    iconURL
    description
    parameters
    signInLink
    signOutLink
    redirectLink
    metadataLink
    acsLink
    entityIdLink
  }
}
Variables
{
  "providerId": 4,
  "id": "4",
  "displayName": "xyz789",
  "disabled": true,
  "iconURL": "xyz789",
  "description": "abc123",
  "parameters": Object
}
Response
{
  "data": {
    "saveAuthProviderConfiguration": {
      "providerId": "4",
      "id": 4,
      "displayName": "xyz789",
      "disabled": true,
      "iconURL": "abc123",
      "description": "abc123",
      "parameters": Object,
      "signInLink": "abc123",
      "signOutLink": "xyz789",
      "redirectLink": "xyz789",
      "metadataLink": "xyz789",
      "acsLink": "abc123",
      "entityIdLink": "xyz789"
    }
  }
}

saveSecretConfiguration

Description

Saves a new secret configuration or updates an existing one. Returns the saved secret configuration.

Response

Returns a SecretConfiguration!

Arguments
Name Description
secretConfigurationParameters - SecretConfigurationInput!

Example

Query
query saveSecretConfiguration($secretConfigurationParameters: SecretConfigurationInput!) {
  saveSecretConfiguration(secretConfigurationParameters: $secretConfigurationParameters) {
    configurationId
    configurationName
    providerId
    description
    parameters {
      ...ObjectPropertyInfoFragment
    }
  }
}
Variables
{
  "secretConfigurationParameters": SecretConfigurationInput
}
Response
{
  "data": {
    "saveSecretConfiguration": {
      "configurationId": "xyz789",
      "configurationName": "abc123",
      "providerId": "xyz789",
      "description": "abc123",
      "parameters": [ObjectPropertyInfo]
    }
  }
}

saveUserMetaParameter

Description

Not implemented yet

Response

Returns an ObjectPropertyInfo!

Arguments
Name Description
id - ID!
displayName - String!
description - String
required - Boolean!

Example

Query
query saveUserMetaParameter(
  $id: ID!,
  $displayName: String!,
  $description: String,
  $required: Boolean!
) {
  saveUserMetaParameter(
    id: $id,
    displayName: $displayName,
    description: $description,
    required: $required
  ) {
    id
    displayName
    description
    hint
    category
    dataType
    value
    validValues
    defaultValue
    length
    features
    order
    supportedConfigurationTypes
    required
    scopes
    conditions {
      ...ConditionFragment
    }
  }
}
Variables
{
  "id": 4,
  "displayName": "xyz789",
  "description": "abc123",
  "required": true
}
Response
{
  "data": {
    "saveUserMetaParameter": {
      "id": "xyz789",
      "displayName": "abc123",
      "description": "abc123",
      "hint": "xyz789",
      "category": "xyz789",
      "dataType": "abc123",
      "value": Object,
      "validValues": [Object],
      "defaultValue": Object,
      "length": "TINY",
      "features": ["abc123"],
      "order": 987,
      "supportedConfigurationTypes": [
        "abc123"
      ],
      "required": false,
      "scopes": ["xyz789"],
      "conditions": [Condition]
    }
  }
}

searchConnections

Description

Finds available connections by host names

Arguments
Name Description
hostNames - [String!]!

Example

Query
query searchConnections($hostNames: [String!]!) {
  searchConnections(hostNames: $hostNames) {
    displayName
    host
    port
    possibleDrivers
    defaultDriver
  }
}
Variables
{"hostNames": ["abc123"]}
Response
{
  "data": {
    "searchConnections": [
      {
        "displayName": "xyz789",
        "host": "abc123",
        "port": 123,
        "possibleDrivers": ["4"],
        "defaultDriver": "4"
      }
    ]
  }
}

secretGetManageableTeams

Description

Returns a list of teams that has access to manage secrets.

Response

Returns [TeamInfo!]!

Example

Query
query secretGetManageableTeams {
  secretGetManageableTeams {
    teamId
    teamName
  }
}
Response
{
  "data": {
    "secretGetManageableTeams": [
      {
        "teamId": "abc123",
        "teamName": "abc123"
      }
    ]
  }
}

secretListDataSourceSecrets

Description

Returns a list of secrets for a data source in the specified project and team.

Response

Returns [AdminSecretInfo!]!

Arguments
Name Description
projectId - ID!
dataSourceId - ID!

Example

Query
query secretListDataSourceSecrets(
  $projectId: ID!,
  $dataSourceId: ID!
) {
  secretListDataSourceSecrets(
    projectId: $projectId,
    dataSourceId: $dataSourceId
  ) {
    subjectId
    authProperties {
      ...ObjectPropertyInfoFragment
    }
  }
}
Variables
{
  "projectId": "4",
  "dataSourceId": "4"
}
Response
{
  "data": {
    "secretListDataSourceSecrets": [
      {
        "subjectId": "4",
        "authProperties": [ObjectPropertyInfo]
      }
    ]
  }
}

secretManagementList

Description

Returns a list of secret management configurations.

Response

Returns [SecretManagementInfo!]!

Example

Query
query secretManagementList {
  secretManagementList {
    id
    label
    description
    configurationId
    configurationName
  }
}
Response
{
  "data": {
    "secretManagementList": [
      {
        "id": "xyz789",
        "label": "xyz789",
        "description": "xyz789",
        "configurationId": "abc123",
        "configurationName": "abc123"
      }
    ]
  }
}

secretProviderConfiguration

Description

Returns a list of secret configurations for a specific provider by its ID.

Response

Returns [SecretConfiguration!]!

Arguments
Name Description
configurationId - ID

Example

Query
query secretProviderConfiguration($configurationId: ID) {
  secretProviderConfiguration(configurationId: $configurationId) {
    configurationId
    configurationName
    providerId
    description
    parameters {
      ...ObjectPropertyInfoFragment
    }
  }
}
Variables
{"configurationId": 4}
Response
{
  "data": {
    "secretProviderConfiguration": [
      {
        "configurationId": "abc123",
        "configurationName": "xyz789",
        "providerId": "abc123",
        "description": "abc123",
        "parameters": [ObjectPropertyInfo]
      }
    ]
  }
}

serverConfig

Description

Returns server config

Response

Returns a ServerConfig!

Example

Query
query serverConfig {
  serverConfig {
    name
    version
    workspaceId
    anonymousAccessEnabled
    supportsCustomConnections
    resourceManagerEnabled
    secretManagerEnabled
    publicCredentialsSaveEnabled
    adminCredentialsSaveEnabled
    licenseRequired
    licenseValid
    licenseStatus
    configurationMode
    developmentMode
    distributed
    enabledFeatures
    disabledBetaFeatures
    serverFeatures
    supportedLanguages {
      ...ServerLanguageFragment
    }
    productConfiguration
    productInfo {
      ...ProductInfoFragment
    }
    defaultNavigatorSettings {
      ...NavigatorSettingsFragment
    }
    disabledDrivers
    resourceQuotas
  }
}
Response
{
  "data": {
    "serverConfig": {
      "name": "abc123",
      "version": "xyz789",
      "workspaceId": 4,
      "anonymousAccessEnabled": true,
      "supportsCustomConnections": true,
      "resourceManagerEnabled": false,
      "secretManagerEnabled": false,
      "publicCredentialsSaveEnabled": true,
      "adminCredentialsSaveEnabled": false,
      "licenseRequired": false,
      "licenseValid": false,
      "licenseStatus": "xyz789",
      "configurationMode": true,
      "developmentMode": false,
      "distributed": true,
      "enabledFeatures": [4],
      "disabledBetaFeatures": [4],
      "serverFeatures": [4],
      "supportedLanguages": [ServerLanguage],
      "productConfiguration": Object,
      "productInfo": ProductInfo,
      "defaultNavigatorSettings": NavigatorSettings,
      "disabledDrivers": [4],
      "resourceQuotas": Object
    }
  }
}

sessionPermissions

Description

Returns session permissions

Response

Returns [ID]!

Example

Query
query sessionPermissions {
  sessionPermissions
}
Response
{"data": {"sessionPermissions": [4]}}

sessionState

Description

Returns session state ( initialize if not )

Response

Returns a SessionInfo!

Example

Query
query sessionState {
  sessionState {
    createTime
    lastAccessTime
    locale
    cacheExpired
    connections {
      ...ConnectionInfoFragment
    }
    actionParameters
    valid
    remainingTime
  }
}
Response
{
  "data": {
    "sessionState": {
      "createTime": "abc123",
      "lastAccessTime": "abc123",
      "locale": "abc123",
      "cacheExpired": false,
      "connections": [ConnectionInfo],
      "actionParameters": Object,
      "valid": true,
      "remainingTime": 123
    }
  }
}

setConnectionSubjectAccess

use addConnectionsAccess (23.2.2)
Description

Sets access to the connection for the specified subjects (users and teams)

Response

Returns a Boolean

Arguments
Name Description
projectId - ID!
connectionId - ID!
subjects - [ID!]!

Example

Query
query setConnectionSubjectAccess(
  $projectId: ID!,
  $connectionId: ID!,
  $subjects: [ID!]!
) {
  setConnectionSubjectAccess(
    projectId: $projectId,
    connectionId: $connectionId,
    subjects: $subjects
  )
}
Variables
{
  "projectId": 4,
  "connectionId": "4",
  "subjects": [4]
}
Response
{"data": {"setConnectionSubjectAccess": false}}

setDefaultNavigatorSettings

Description

Changes default navigator settings

Response

Returns a Boolean!

Arguments
Name Description
settings - NavigatorSettingsInput!

Example

Query
query setDefaultNavigatorSettings($settings: NavigatorSettingsInput!) {
  setDefaultNavigatorSettings(settings: $settings)
}
Variables
{"settings": NavigatorSettingsInput}
Response
{"data": {"setDefaultNavigatorSettings": true}}

setSubjectConnectionAccess

23.2.2
Description

Sets access for a subject (user or team) to the specified connections

Response

Returns a Boolean

Arguments
Name Description
subjectId - ID!
connections - [ID!]!

Example

Query
query setSubjectConnectionAccess(
  $subjectId: ID!,
  $connections: [ID!]!
) {
  setSubjectConnectionAccess(
    subjectId: $subjectId,
    connections: $connections
  )
}
Variables
{"subjectId": "4", "connections": [4]}
Response
{"data": {"setSubjectConnectionAccess": true}}

setSubjectPermissions

Description

Sets permissions to the subject (user or team) with the specified subjectId

Response

Returns [AdminPermissionInfo!]!

Arguments
Name Description
subjectId - ID!
permissions - [ID!]!

Example

Query
query setSubjectPermissions(
  $subjectId: ID!,
  $permissions: [ID!]!
) {
  setSubjectPermissions(
    subjectId: $subjectId,
    permissions: $permissions
  ) {
    id
    label
    description
    provider
    category
  }
}
Variables
{"subjectId": "4", "permissions": [4]}
Response
{
  "data": {
    "setSubjectPermissions": [
      {
        "id": "4",
        "label": "xyz789",
        "description": "abc123",
        "provider": "abc123",
        "category": "abc123"
      }
    ]
  }
}

setTeamMetaParameterValues

Description

Sets team meta parameters values for the specified teamId

Response

Returns a Boolean!

Arguments
Name Description
teamId - ID!
parameters - Object!

Example

Query
query setTeamMetaParameterValues(
  $teamId: ID!,
  $parameters: Object!
) {
  setTeamMetaParameterValues(
    teamId: $teamId,
    parameters: $parameters
  )
}
Variables
{
  "teamId": "4",
  "parameters": Object
}
Response
{"data": {"setTeamMetaParameterValues": false}}

setUserAuthRole

Description

Sets user auth role for the specified userId

Response

Returns a Boolean

Arguments
Name Description
userId - ID!
authRole - String

Example

Query
query setUserAuthRole(
  $userId: ID!,
  $authRole: String
) {
  setUserAuthRole(
    userId: $userId,
    authRole: $authRole
  )
}
Variables
{
  "userId": "4",
  "authRole": "xyz789"
}
Response
{"data": {"setUserAuthRole": false}}

setUserCredentials

Description

Sets user credentials for the specified userId and providerId

Response

Returns a Boolean

Arguments
Name Description
userId - ID!
providerId - ID!
credentials - Object!

Example

Query
query setUserCredentials(
  $userId: ID!,
  $providerId: ID!,
  $credentials: Object!
) {
  setUserCredentials(
    userId: $userId,
    providerId: $providerId,
    credentials: $credentials
  )
}
Variables
{
  "userId": "4",
  "providerId": "4",
  "credentials": Object
}
Response
{"data": {"setUserCredentials": true}}

setUserMetaParameterValues

Description

Sets user meta parameters values for the specified userId

Response

Returns a Boolean!

Arguments
Name Description
userId - ID!
parameters - Object!

Example

Query
query setUserMetaParameterValues(
  $userId: ID!,
  $parameters: Object!
) {
  setUserMetaParameterValues(
    userId: $userId,
    parameters: $parameters
  )
}
Variables
{"userId": 4, "parameters": Object}
Response
{"data": {"setUserMetaParameterValues": false}}

setUserTeamRole

Description

Sets user team role for the specified userId and teamId

Response

Returns a Boolean

Arguments
Name Description
userId - ID!
teamId - ID!
teamRole - String

Example

Query
query setUserTeamRole(
  $userId: ID!,
  $teamId: ID!,
  $teamRole: String
) {
  setUserTeamRole(
    userId: $userId,
    teamId: $teamId,
    teamRole: $teamRole
  )
}
Variables
{
  "userId": "4",
  "teamId": "4",
  "teamRole": "abc123"
}
Response
{"data": {"setUserTeamRole": false}}

sqlCompletionProposals

Description

Returns proposals for SQL completion at the specified position in the query

Response

Returns [SQLCompletionProposal]

Arguments
Name Description
projectId - ID
connectionId - ID!
contextId - ID!
query - String!
position - Int!
maxResults - Int
simpleMode - Boolean

Example

Query
query sqlCompletionProposals(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $query: String!,
  $position: Int!,
  $maxResults: Int,
  $simpleMode: Boolean
) {
  sqlCompletionProposals(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    query: $query,
    position: $position,
    maxResults: $maxResults,
    simpleMode: $simpleMode
  ) {
    displayString
    type
    score
    replacementString
    replacementOffset
    replacementLength
    cursorPosition
    icon
    nodePath
  }
}
Variables
{
  "projectId": 4,
  "connectionId": "4",
  "contextId": "4",
  "query": "abc123",
  "position": 987,
  "maxResults": 123,
  "simpleMode": true
}
Response
{
  "data": {
    "sqlCompletionProposals": [
      {
        "displayString": "abc123",
        "type": "xyz789",
        "score": 123,
        "replacementString": "abc123",
        "replacementOffset": 987,
        "replacementLength": 987,
        "cursorPosition": 123,
        "icon": "abc123",
        "nodePath": "abc123"
      }
    ]
  }
}

sqlDialectInfo

Description

Returns SQL dialect info for the specified connection

Response

Returns an SQLDialectInfo

Arguments
Name Description
projectId - ID
connectionId - ID!

Example

Query
query sqlDialectInfo(
  $projectId: ID,
  $connectionId: ID!
) {
  sqlDialectInfo(
    projectId: $projectId,
    connectionId: $connectionId
  ) {
    name
    dataTypes
    functions
    reservedWords
    quoteStrings
    singleLineComments
    multiLineComments
    catalogSeparator
    structSeparator
    scriptDelimiter
    supportsExplainExecutionPlan
  }
}
Variables
{"projectId": 4, "connectionId": "4"}
Response
{
  "data": {
    "sqlDialectInfo": {
      "name": "abc123",
      "dataTypes": ["xyz789"],
      "functions": ["abc123"],
      "reservedWords": ["abc123"],
      "quoteStrings": ["xyz789"],
      "singleLineComments": ["xyz789"],
      "multiLineComments": ["xyz789"],
      "catalogSeparator": "xyz789",
      "structSeparator": "xyz789",
      "scriptDelimiter": "xyz789",
      "supportsExplainExecutionPlan": true
    }
  }
}

sqlEntityQueryGenerators

Description

Returns list of all available entity query generators

Response

Returns [SQLQueryGenerator!]!

Arguments
Name Description
nodePathList - [String!]!

Example

Query
query sqlEntityQueryGenerators($nodePathList: [String!]!) {
  sqlEntityQueryGenerators(nodePathList: $nodePathList) {
    id
    label
    description
    order
    multiObject
  }
}
Variables
{"nodePathList": ["xyz789"]}
Response
{
  "data": {
    "sqlEntityQueryGenerators": [
      {
        "id": "abc123",
        "label": "abc123",
        "description": "abc123",
        "order": 987,
        "multiObject": true
      }
    ]
  }
}

sqlFormatQuery

Description

Formats SQL query and returns formatted query string

Response

Returns a String!

Arguments
Name Description
projectId - ID
connectionId - ID!
contextId - ID!
query - String!

Example

Query
query sqlFormatQuery(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $query: String!
) {
  sqlFormatQuery(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    query: $query
  )
}
Variables
{
  "projectId": 4,
  "connectionId": "4",
  "contextId": 4,
  "query": "xyz789"
}
Response
{"data": {"sqlFormatQuery": "abc123"}}

sqlGenerateEntityQuery

Description

Generates SQL query for the specified entity query generator. Available options: fullyQualifiedNames - Use fully qualified names for entities compactSQL - Use compact SQL format showComments - Show comments in generated SQL showPermissions - Show permissions in generated SQL showFullDdl - Show full DDL in generated SQL excludeAutoGeneratedColumn - Exclude auto-generated columns in generated SQL useCustomDataFormat - Use custom data format for generated SQL

Response

Returns a String!

Arguments
Name Description
generatorId - String!
options - Object!
nodePathList - [String!]!

Example

Query
query sqlGenerateEntityQuery(
  $generatorId: String!,
  $options: Object!,
  $nodePathList: [String!]!
) {
  sqlGenerateEntityQuery(
    generatorId: $generatorId,
    options: $options,
    nodePathList: $nodePathList
  )
}
Variables
{
  "generatorId": "xyz789",
  "options": Object,
  "nodePathList": ["abc123"]
}
Response
{
  "data": {
    "sqlGenerateEntityQuery": "abc123"
  }
}

sqlGenerateGroupingQuery

Description

Generates SQL query for grouping data in the specified results

Response

Returns a String!

Arguments
Name Description
projectId - ID
contextId - ID!
connectionId - ID!
resultsId - ID!
columnNames - [String!]
functions - [String!]
showDuplicatesOnly - Boolean

Example

Query
query sqlGenerateGroupingQuery(
  $projectId: ID,
  $contextId: ID!,
  $connectionId: ID!,
  $resultsId: ID!,
  $columnNames: [String!],
  $functions: [String!],
  $showDuplicatesOnly: Boolean
) {
  sqlGenerateGroupingQuery(
    projectId: $projectId,
    contextId: $contextId,
    connectionId: $connectionId,
    resultsId: $resultsId,
    columnNames: $columnNames,
    functions: $functions,
    showDuplicatesOnly: $showDuplicatesOnly
  )
}
Variables
{
  "projectId": 4,
  "contextId": "4",
  "connectionId": 4,
  "resultsId": 4,
  "columnNames": ["abc123"],
  "functions": ["abc123"],
  "showDuplicatesOnly": false
}
Response
{
  "data": {
    "sqlGenerateGroupingQuery": "xyz789"
  }
}

sqlListContexts

Description

Lists SQL contexts for a connection (optional) or returns the particular context info

Response

Returns [SQLContextInfo]!

Arguments
Name Description
projectId - ID
connectionId - ID
contextId - ID

Example

Query
query sqlListContexts(
  $projectId: ID,
  $connectionId: ID,
  $contextId: ID
) {
  sqlListContexts(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId
  ) {
    id
    projectId
    connectionId
    autoCommit
    defaultCatalog
    defaultSchema
  }
}
Variables
{
  "projectId": "4",
  "connectionId": "4",
  "contextId": "4"
}
Response
{
  "data": {
    "sqlListContexts": [
      {
        "id": "4",
        "projectId": "4",
        "connectionId": 4,
        "autoCommit": true,
        "defaultCatalog": "xyz789",
        "defaultSchema": "xyz789"
      }
    ]
  }
}

sqlParseQuery

Description

Parses SQL query and returns query info with start and end positions

Response

Returns an SQLScriptQuery!

Arguments
Name Description
projectId - ID
connectionId - ID!
script - String!
position - Int!

Example

Query
query sqlParseQuery(
  $projectId: ID,
  $connectionId: ID!,
  $script: String!,
  $position: Int!
) {
  sqlParseQuery(
    projectId: $projectId,
    connectionId: $connectionId,
    script: $script,
    position: $position
  ) {
    start
    end
  }
}
Variables
{
  "projectId": "4",
  "connectionId": "4",
  "script": "abc123",
  "position": 987
}
Response
{"data": {"sqlParseQuery": {"start": 123, "end": 987}}}

sqlParseScript

Description

Parses SQL script and returns script info with queries start and end positions

Response

Returns an SQLScriptInfo!

Arguments
Name Description
projectId - ID
connectionId - ID!
script - String!

Example

Query
query sqlParseScript(
  $projectId: ID,
  $connectionId: ID!,
  $script: String!
) {
  sqlParseScript(
    projectId: $projectId,
    connectionId: $connectionId,
    script: $script
  ) {
    queries {
      ...SQLScriptQueryFragment
    }
  }
}
Variables
{
  "projectId": "4",
  "connectionId": 4,
  "script": "xyz789"
}
Response
{
  "data": {
    "sqlParseScript": {"queries": [SQLScriptQuery]}
  }
}

sqlSupportedOperations

Description

Returns suported operations for the specified attribute index in the results

Response

Returns [DataTypeLogicalOperation!]!

Arguments
Name Description
projectId - ID
connectionId - ID!
contextId - ID!
resultsId - ID!
attributeIndex - Int!

Example

Query
query sqlSupportedOperations(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $resultsId: ID!,
  $attributeIndex: Int!
) {
  sqlSupportedOperations(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    resultsId: $resultsId,
    attributeIndex: $attributeIndex
  ) {
    id
    expression
    argumentCount
  }
}
Variables
{
  "projectId": 4,
  "connectionId": 4,
  "contextId": "4",
  "resultsId": "4",
  "attributeIndex": 123
}
Response
{
  "data": {
    "sqlSupportedOperations": [
      {
        "id": 4,
        "expression": "abc123",
        "argumentCount": 987
      }
    ]
  }
}

systemInfo

Description

Returns server system information properties

Response

Returns [ObjectPropertyInfo!]!

Example

Query
query systemInfo {
  systemInfo {
    id
    displayName
    description
    hint
    category
    dataType
    value
    validValues
    defaultValue
    length
    features
    order
    supportedConfigurationTypes
    required
    scopes
    conditions {
      ...ConditionFragment
    }
  }
}
Response
{
  "data": {
    "systemInfo": [
      {
        "id": "abc123",
        "displayName": "xyz789",
        "description": "abc123",
        "hint": "xyz789",
        "category": "abc123",
        "dataType": "abc123",
        "value": Object,
        "validValues": [Object],
        "defaultValue": Object,
        "length": "TINY",
        "features": ["xyz789"],
        "order": 123,
        "supportedConfigurationTypes": [
          "xyz789"
        ],
        "required": false,
        "scopes": ["abc123"],
        "conditions": [Condition]
      }
    ]
  }
}

tokenApiList

Description

Returns list of user API tokens

Response

Returns [APITokenInfo!]!

Example

Query
query tokenApiList {
  tokenApiList {
    tokenName
    createTime
    expireTime
  }
}
Response
{
  "data": {
    "tokenApiList": [
      {
        "tokenName": "xyz789",
        "createTime": "2007-12-03",
        "expireTime": "2007-12-03"
      }
    ]
  }
}

updateTeam

Description

Updates team information by teamId

Response

Returns an AdminTeamInfo!

Arguments
Name Description
teamId - ID!
teamName - String
description - String

Example

Query
query updateTeam(
  $teamId: ID!,
  $teamName: String,
  $description: String
) {
  updateTeam(
    teamId: $teamId,
    teamName: $teamName,
    description: $description
  ) {
    teamId
    teamName
    description
    metaParameters
    grantedUsers
    grantedUsersInfo {
      ...AdminUserTeamGrantInfoFragment
    }
    grantedConnections {
      ...AdminConnectionGrantInfoFragment
    }
    teamPermissions
  }
}
Variables
{
  "teamId": 4,
  "teamName": "abc123",
  "description": "abc123"
}
Response
{
  "data": {
    "updateTeam": {
      "teamId": "4",
      "teamName": "xyz789",
      "description": "abc123",
      "metaParameters": Object,
      "grantedUsers": [4],
      "grantedUsersInfo": [AdminUserTeamGrantInfo],
      "grantedConnections": [AdminConnectionGrantInfo],
      "teamPermissions": ["4"]
    }
  }
}

userConnections

Description

Returns list of user connections

Response

Returns [ConnectionInfo!]!

Arguments
Name Description
projectId - ID
id - ID
projectIds - [ID!]

Example

Query
query userConnections(
  $projectId: ID,
  $id: ID,
  $projectIds: [ID!]
) {
  userConnections(
    projectId: $projectId,
    id: $id,
    projectIds: $projectIds
  ) {
    id
    driverId
    name
    description
    host
    port
    serverName
    databaseName
    url
    mainPropertyValues
    keepAliveInterval
    autocommit
    properties
    connected
    provided
    readOnly
    useUrl
    saveCredentials
    sharedCredentials
    sharedSecrets {
      ...SecretInfoFragment
    }
    credentialsSaved
    authNeeded
    folder
    nodePath
    connectTime
    connectionError {
      ...ServerErrorFragment
    }
    serverVersion
    clientVersion
    origin {
      ...ObjectOriginFragment
    }
    authModel
    authProperties {
      ...ObjectPropertyInfoFragment
    }
    providerProperties
    networkHandlersConfig {
      ...NetworkHandlerConfigFragment
    }
    features
    navigatorSettings {
      ...NavigatorSettingsFragment
    }
    supportedDataFormats
    configurationType
    canViewSettings
    canEdit
    canDelete
    projectId
    requiredAuth
    defaultCatalogName
    defaultSchemaName
    tools
  }
}
Variables
{
  "projectId": 4,
  "id": 4,
  "projectIds": ["4"]
}
Response
{
  "data": {
    "userConnections": [
      {
        "id": 4,
        "driverId": "4",
        "name": "xyz789",
        "description": "xyz789",
        "host": "abc123",
        "port": "abc123",
        "serverName": "xyz789",
        "databaseName": "abc123",
        "url": "abc123",
        "mainPropertyValues": Object,
        "keepAliveInterval": 123,
        "autocommit": true,
        "properties": Object,
        "connected": false,
        "provided": false,
        "readOnly": false,
        "useUrl": true,
        "saveCredentials": false,
        "sharedCredentials": true,
        "sharedSecrets": [SecretInfo],
        "credentialsSaved": false,
        "authNeeded": false,
        "folder": "4",
        "nodePath": "xyz789",
        "connectTime": "abc123",
        "connectionError": ServerError,
        "serverVersion": "abc123",
        "clientVersion": "abc123",
        "origin": ObjectOrigin,
        "authModel": "4",
        "authProperties": [ObjectPropertyInfo],
        "providerProperties": Object,
        "networkHandlersConfig": [NetworkHandlerConfig],
        "features": ["xyz789"],
        "navigatorSettings": NavigatorSettings,
        "supportedDataFormats": ["resultset"],
        "configurationType": "MANUAL",
        "canViewSettings": true,
        "canEdit": true,
        "canDelete": false,
        "projectId": "4",
        "requiredAuth": "xyz789",
        "defaultCatalogName": "xyz789",
        "defaultSchemaName": "abc123",
        "tools": ["xyz789"]
      }
    ]
  }
}

vqbGenerateQuery

No longer supported
Description

Generates a query based on the provided VQB query configuration input.

Response

Returns a String!

Arguments
Name Description
projectId - ID
connectionId - ID!
contextId - ID!
queryConfig - VQBQueryConfigInput!

Example

Query
query vqbGenerateQuery(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $queryConfig: VQBQueryConfigInput!
) {
  vqbGenerateQuery(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    queryConfig: $queryConfig
  )
}
Variables
{
  "projectId": "4",
  "connectionId": "4",
  "contextId": 4,
  "queryConfig": VQBQueryConfigInput
}
Response
{"data": {"vqbGenerateQuery": "xyz789"}}

vqbParseQuery

use vqbParseQueryExtended instead
Description

Parses a query and returns information about database entities. Format is not defined.

Response

Returns an Object!

Arguments
Name Description
projectId - ID
connectionId - ID!
contextId - ID!
query - String!

Example

Query
query vqbParseQuery(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $query: String!
) {
  vqbParseQuery(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    query: $query
  )
}
Variables
{
  "projectId": "4",
  "connectionId": "4",
  "contextId": "4",
  "query": "xyz789"
}
Response
{"data": {"vqbParseQuery": Object}}

vqbParseQueryExtended

Description

Parses a query and returns ERD diagram information for the specified project, connection, and context.

Response

Returns an ERDDiagramInfo!

Arguments
Name Description
projectId - ID
connectionId - ID!
contextId - ID!
query - String!

Example

Query
query vqbParseQueryExtended(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $query: String!
) {
  vqbParseQueryExtended(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    query: $query
  ) {
    entities {
      ...ERDEntityInfoFragment
    }
    associations {
      ...ERDAssociationInfoFragment
    }
    data {
      ...ERDDiagramDataFragment
    }
    where
    orderBy
    selectItems
  }
}
Variables
{
  "projectId": 4,
  "connectionId": "4",
  "contextId": "4",
  "query": "abc123"
}
Response
{
  "data": {
    "vqbParseQueryExtended": {
      "entities": [ERDEntityInfo],
      "associations": [ERDAssociationInfo],
      "data": ERDDiagramData,
      "where": "xyz789",
      "orderBy": ["xyz789"],
      "selectItems": ["abc123"]
    }
  }
}

vqbReadEntityData

use vqbReadEntityDataExtended instead
Description

Reads information about database entities. Use vqbReadEntityDataExtended instead.

Response

Returns an Object!

Arguments
Name Description
objectNodeIds - [ID!]!

Example

Query
query vqbReadEntityData($objectNodeIds: [ID!]!) {
  vqbReadEntityData(objectNodeIds: $objectNodeIds)
}
Variables
{"objectNodeIds": [4]}
Response
{"data": {"vqbReadEntityData": Object}}

vqbReadEntityDataExtended

Description

Returns a ERD diagram information for the specified object node IDs.

Response

Returns an ERDDiagramInfo!

Arguments
Name Description
objectNodeIds - [ID!]!

Example

Query
query vqbReadEntityDataExtended($objectNodeIds: [ID!]!) {
  vqbReadEntityDataExtended(objectNodeIds: $objectNodeIds) {
    entities {
      ...ERDEntityInfoFragment
    }
    associations {
      ...ERDAssociationInfoFragment
    }
    data {
      ...ERDDiagramDataFragment
    }
    where
    orderBy
    selectItems
  }
}
Variables
{"objectNodeIds": ["4"]}
Response
{
  "data": {
    "vqbReadEntityDataExtended": {
      "entities": [ERDEntityInfo],
      "associations": [ERDAssociationInfo],
      "data": ERDDiagramData,
      "where": "abc123",
      "orderBy": ["abc123"],
      "selectItems": ["abc123"]
    }
  }
}

Mutations

adminUpdateProductConfiguration

Description

Updates product configuration

Response

Returns a Boolean!

Arguments
Name Description
configuration - Object!

Example

Query
mutation adminUpdateProductConfiguration($configuration: Object!) {
  adminUpdateProductConfiguration(configuration: $configuration)
}
Variables
{"configuration": Object}
Response
{"data": {"adminUpdateProductConfiguration": false}}

aiClearLastChatMessages

Description

Clears the chat messages in the AI chat conversation. The messages will be removed from the conversation.

Response

Returns a Boolean!

Arguments
Name Description
conversationId - ID!
messageId - ID!

Example

Query
mutation aiClearLastChatMessages(
  $conversationId: ID!,
  $messageId: ID!
) {
  aiClearLastChatMessages(
    conversationId: $conversationId,
    messageId: $messageId
  )
}
Variables
{"conversationId": "4", "messageId": 4}
Response
{"data": {"aiClearLastChatMessages": true}}

aiCreateChatConversation

Description

Creates a new AI chat conversation. Conversation is created in the context of a project and connection. If the connection and project are not specified, the conversation will be created without a context.

Response

Returns an AIChatConversationInfo!

Arguments
Name Description
config - AIChatConversationInput!

Example

Query
mutation aiCreateChatConversation($config: AIChatConversationInput!) {
  aiCreateChatConversation(config: $config) {
    dataSourceId {
      ...DataSourceIdFragment
    }
    id
    caption
    time
    messages {
      ...AIMessageFragment
    }
    settings {
      ...AIChatConversationSettingsFragment
    }
  }
}
Variables
{"config": AIChatConversationInput}
Response
{
  "data": {
    "aiCreateChatConversation": {
      "dataSourceId": DataSourceId,
      "id": "4",
      "caption": "xyz789",
      "time": "2007-12-03T10:15:30Z",
      "messages": [AIMessage],
      "settings": AIChatConversationSettings
    }
  }
}

aiDeleteChatConversation

Description

Deletes the specified AI chat conversation

Response

Returns a Boolean!

Arguments
Name Description
conversationId - ID!

Example

Query
mutation aiDeleteChatConversation($conversationId: ID!) {
  aiDeleteChatConversation(conversationId: $conversationId)
}
Variables
{"conversationId": 4}
Response
{"data": {"aiDeleteChatConversation": true}}

aiSaveEngineConfiguration

Description

Saves the configuration of the specified AI engine.

Response

Returns a Boolean!

Arguments
Name Description
engineId - ID!
settings - AIEngineConfig!

Example

Query
mutation aiSaveEngineConfiguration(
  $engineId: ID!,
  $settings: AIEngineConfig!
) {
  aiSaveEngineConfiguration(
    engineId: $engineId,
    settings: $settings
  )
}
Variables
{"engineId": 4, "settings": AIEngineConfig}
Response
{"data": {"aiSaveEngineConfiguration": false}}

aiSaveSettings

Description

Saves the global AI settings (active AI engine).

Response

Returns an AISettingsInfo!

Arguments
Name Description
settings - AISettingsConfig!

Example

Query
mutation aiSaveSettings($settings: AISettingsConfig!) {
  aiSaveSettings(settings: $settings) {
    activeEngine
  }
}
Variables
{"settings": AISettingsConfig}
Response
{
  "data": {
    "aiSaveSettings": {"activeEngine": "4"}
  }
}

aiSendChatMessage

Description

Sends a chat message to the AI chat conversation and returns a message ID from response. The response will be received partially via websockets.

Response

Returns an AISendChatMessageInfo!

Arguments
Name Description
conversationId - ID!
prompt - String!

Example

Query
mutation aiSendChatMessage(
  $conversationId: ID!,
  $prompt: String!
) {
  aiSendChatMessage(
    conversationId: $conversationId,
    prompt: $prompt
  ) {
    conversation {
      ...AIChatConversationInfoFragment
    }
    userMessage {
      ...AIMessageFragment
    }
    assistantMessage {
      ...AIMessageFragment
    }
  }
}
Variables
{
  "conversationId": "4",
  "prompt": "abc123"
}
Response
{
  "data": {
    "aiSendChatMessage": {
      "conversation": AIChatConversationInfo,
      "userMessage": AIMessage,
      "assistantMessage": AIMessage
    }
  }
}

aiUpdateChatConversation

Description

Updates the caption of the AI chat conversation

Response

Returns an AIChatConversationInfo!

Arguments
Name Description
conversationId - ID!
config - AIChatConversationInput!

Example

Query
mutation aiUpdateChatConversation(
  $conversationId: ID!,
  $config: AIChatConversationInput!
) {
  aiUpdateChatConversation(
    conversationId: $conversationId,
    config: $config
  ) {
    dataSourceId {
      ...DataSourceIdFragment
    }
    id
    caption
    time
    messages {
      ...AIMessageFragment
    }
    settings {
      ...AIChatConversationSettingsFragment
    }
  }
}
Variables
{"conversationId": 4, "config": AIChatConversationInput}
Response
{
  "data": {
    "aiUpdateChatConversation": {
      "dataSourceId": DataSourceId,
      "id": "4",
      "caption": "abc123",
      "time": "2007-12-03T10:15:30Z",
      "messages": [AIMessage],
      "settings": AIChatConversationSettings
    }
  }
}

asyncAiPerformQueryCompletion

Description

Creates an anync task to perform AI query completion.

Response

Returns an AsyncTaskInfo!

Arguments
Name Description
projectId - ID
connectionId - ID!
contextId - ID!
request - String!

Example

Query
mutation asyncAiPerformQueryCompletion(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $request: String!
) {
  asyncAiPerformQueryCompletion(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    request: $request
  ) {
    id
    name
    running
    status
    error {
      ...ServerErrorFragment
    }
    taskResult
  }
}
Variables
{
  "projectId": "4",
  "connectionId": "4",
  "contextId": "4",
  "request": "abc123"
}
Response
{
  "data": {
    "asyncAiPerformQueryCompletion": {
      "id": "abc123",
      "name": "abc123",
      "running": true,
      "status": "xyz789",
      "error": ServerError,
      "taskResult": Object
    }
  }
}

asyncAiPerformQueryCompletionResult

Description

Retrieves the result of an async AI query completion task.

Response

Returns a String

Arguments
Name Description
taskId - ID!

Example

Query
mutation asyncAiPerformQueryCompletionResult($taskId: ID!) {
  asyncAiPerformQueryCompletionResult(taskId: $taskId)
}
Variables
{"taskId": "4"}
Response
{
  "data": {
    "asyncAiPerformQueryCompletionResult": "abc123"
  }
}

asyncDmRegisterDeploymentDomain

Description

Creates an async task to register a new deployment domain and generate a certificate for it.

Response

Returns an AsyncTaskInfo!

Arguments
Name Description
organizationSubdomain - String!
deploymentSubdomain - String!
ipAddress - String!

Example

Query
mutation asyncDmRegisterDeploymentDomain(
  $organizationSubdomain: String!,
  $deploymentSubdomain: String!,
  $ipAddress: String!
) {
  asyncDmRegisterDeploymentDomain(
    organizationSubdomain: $organizationSubdomain,
    deploymentSubdomain: $deploymentSubdomain,
    ipAddress: $ipAddress
  ) {
    id
    name
    running
    status
    error {
      ...ServerErrorFragment
    }
    taskResult
  }
}
Variables
{
  "organizationSubdomain": "xyz789",
  "deploymentSubdomain": "xyz789",
  "ipAddress": "xyz789"
}
Response
{
  "data": {
    "asyncDmRegisterDeploymentDomain": {
      "id": "abc123",
      "name": "xyz789",
      "running": false,
      "status": "xyz789",
      "error": ServerError,
      "taskResult": Object
    }
  }
}

asyncDownloadDriverLibraries

Description

Creates the async task to download driver libraries for the specified driver.

Response

Returns an AsyncTaskInfo!

Arguments
Name Description
providerId - ID!
driverId - ID!

Example

Query
mutation asyncDownloadDriverLibraries(
  $providerId: ID!,
  $driverId: ID!
) {
  asyncDownloadDriverLibraries(
    providerId: $providerId,
    driverId: $driverId
  ) {
    id
    name
    running
    status
    error {
      ...ServerErrorFragment
    }
    taskResult
  }
}
Variables
{"providerId": 4, "driverId": 4}
Response
{
  "data": {
    "asyncDownloadDriverLibraries": {
      "id": "abc123",
      "name": "abc123",
      "running": false,
      "status": "abc123",
      "error": ServerError,
      "taskResult": Object
    }
  }
}

asyncReadDataFromChildEntity

Description

Creates an async task to read data from a child entity in Firestore

Response

Returns an AsyncTaskInfo!

Arguments
Name Description
projectId - ID
connectionId - ID!
contextId - ID!
path - ID
resultId - ID
filter - SQLDataFilter
dataFormat - ResultDataFormat

Example

Query
mutation asyncReadDataFromChildEntity(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $path: ID,
  $resultId: ID,
  $filter: SQLDataFilter,
  $dataFormat: ResultDataFormat
) {
  asyncReadDataFromChildEntity(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    path: $path,
    resultId: $resultId,
    filter: $filter,
    dataFormat: $dataFormat
  ) {
    id
    name
    running
    status
    error {
      ...ServerErrorFragment
    }
    taskResult
  }
}
Variables
{
  "projectId": "4",
  "connectionId": 4,
  "contextId": 4,
  "path": "4",
  "resultId": 4,
  "filter": SQLDataFilter,
  "dataFormat": "resultset"
}
Response
{
  "data": {
    "asyncReadDataFromChildEntity": {
      "id": "abc123",
      "name": "xyz789",
      "running": false,
      "status": "xyz789",
      "error": ServerError,
      "taskResult": Object
    }
  }
}

asyncReadDataFromContainer

Description

Creates async task for reading data from the container node

Response

Returns an AsyncTaskInfo!

Arguments
Name Description
projectId - ID
connectionId - ID!
contextId - ID!
containerNodePath - ID!
resultId - ID
filter - SQLDataFilter
dataFormat - ResultDataFormat

Example

Query
mutation asyncReadDataFromContainer(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $containerNodePath: ID!,
  $resultId: ID,
  $filter: SQLDataFilter,
  $dataFormat: ResultDataFormat
) {
  asyncReadDataFromContainer(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    containerNodePath: $containerNodePath,
    resultId: $resultId,
    filter: $filter,
    dataFormat: $dataFormat
  ) {
    id
    name
    running
    status
    error {
      ...ServerErrorFragment
    }
    taskResult
  }
}
Variables
{
  "projectId": "4",
  "connectionId": "4",
  "contextId": 4,
  "containerNodePath": "4",
  "resultId": "4",
  "filter": SQLDataFilter,
  "dataFormat": "resultset"
}
Response
{
  "data": {
    "asyncReadDataFromContainer": {
      "id": "abc123",
      "name": "xyz789",
      "running": true,
      "status": "abc123",
      "error": ServerError,
      "taskResult": Object
    }
  }
}

asyncSqlCommitTransaction

Description

Creates async task to commit transaction

Response

Returns an AsyncTaskInfo!

Arguments
Name Description
projectId - ID!
connectionId - ID!
contextId - ID!

Example

Query
mutation asyncSqlCommitTransaction(
  $projectId: ID!,
  $connectionId: ID!,
  $contextId: ID!
) {
  asyncSqlCommitTransaction(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId
  ) {
    id
    name
    running
    status
    error {
      ...ServerErrorFragment
    }
    taskResult
  }
}
Variables
{
  "projectId": 4,
  "connectionId": "4",
  "contextId": "4"
}
Response
{
  "data": {
    "asyncSqlCommitTransaction": {
      "id": "xyz789",
      "name": "xyz789",
      "running": true,
      "status": "xyz789",
      "error": ServerError,
      "taskResult": Object
    }
  }
}

asyncSqlExecuteQuery

Description

Creates async task for executing SQL query

Response

Returns an AsyncTaskInfo!

Arguments
Name Description
projectId - ID
connectionId - ID!
contextId - ID!
sql - String!
resultId - ID
filter - SQLDataFilter
dataFormat - ResultDataFormat
readLogs - Boolean

Example

Query
mutation asyncSqlExecuteQuery(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $sql: String!,
  $resultId: ID,
  $filter: SQLDataFilter,
  $dataFormat: ResultDataFormat,
  $readLogs: Boolean
) {
  asyncSqlExecuteQuery(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    sql: $sql,
    resultId: $resultId,
    filter: $filter,
    dataFormat: $dataFormat,
    readLogs: $readLogs
  ) {
    id
    name
    running
    status
    error {
      ...ServerErrorFragment
    }
    taskResult
  }
}
Variables
{
  "projectId": 4,
  "connectionId": 4,
  "contextId": 4,
  "sql": "abc123",
  "resultId": 4,
  "filter": SQLDataFilter,
  "dataFormat": "resultset",
  "readLogs": true
}
Response
{
  "data": {
    "asyncSqlExecuteQuery": {
      "id": "abc123",
      "name": "xyz789",
      "running": false,
      "status": "abc123",
      "error": ServerError,
      "taskResult": Object
    }
  }
}

asyncSqlExecuteResults

Description

Returns SQL execution results for async SQL execute task

Response

Returns an SQLExecuteInfo!

Arguments
Name Description
taskId - ID!

Example

Query
mutation asyncSqlExecuteResults($taskId: ID!) {
  asyncSqlExecuteResults(taskId: $taskId) {
    statusMessage
    duration
    filterText
    fullQuery
    results {
      ...SQLQueryResultsFragment
    }
  }
}
Variables
{"taskId": "4"}
Response
{
  "data": {
    "asyncSqlExecuteResults": {
      "statusMessage": "abc123",
      "duration": 987,
      "filterText": "xyz789",
      "fullQuery": "xyz789",
      "results": [SQLQueryResults]
    }
  }
}

asyncSqlExplainExecutionPlan

Description

Creates async task to generating SQL execution plan

Response

Returns an AsyncTaskInfo!

Arguments
Name Description
projectId - ID
connectionId - ID!
contextId - ID!
query - String!
configuration - Object!

Example

Query
mutation asyncSqlExplainExecutionPlan(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $query: String!,
  $configuration: Object!
) {
  asyncSqlExplainExecutionPlan(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    query: $query,
    configuration: $configuration
  ) {
    id
    name
    running
    status
    error {
      ...ServerErrorFragment
    }
    taskResult
  }
}
Variables
{
  "projectId": 4,
  "connectionId": 4,
  "contextId": "4",
  "query": "abc123",
  "configuration": Object
}
Response
{
  "data": {
    "asyncSqlExplainExecutionPlan": {
      "id": "xyz789",
      "name": "abc123",
      "running": false,
      "status": "xyz789",
      "error": ServerError,
      "taskResult": Object
    }
  }
}

asyncSqlExplainExecutionPlanResult

Description

Returns SQL execution plan for async SQL explain task

Response

Returns an SQLExecutionPlan!

Arguments
Name Description
taskId - ID!

Example

Query
mutation asyncSqlExplainExecutionPlanResult($taskId: ID!) {
  asyncSqlExplainExecutionPlanResult(taskId: $taskId) {
    query
    nodes {
      ...SQLExecutionPlanNodeFragment
    }
  }
}
Variables
{"taskId": "4"}
Response
{
  "data": {
    "asyncSqlExplainExecutionPlanResult": {
      "query": "abc123",
      "nodes": [SQLExecutionPlanNode]
    }
  }
}

asyncSqlRollbackTransaction

Description

Creates async task to rollback transaction

Response

Returns an AsyncTaskInfo!

Arguments
Name Description
projectId - ID!
connectionId - ID!
contextId - ID!

Example

Query
mutation asyncSqlRollbackTransaction(
  $projectId: ID!,
  $connectionId: ID!,
  $contextId: ID!
) {
  asyncSqlRollbackTransaction(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId
  ) {
    id
    name
    running
    status
    error {
      ...ServerErrorFragment
    }
    taskResult
  }
}
Variables
{
  "projectId": "4",
  "connectionId": "4",
  "contextId": "4"
}
Response
{
  "data": {
    "asyncSqlRollbackTransaction": {
      "id": "xyz789",
      "name": "xyz789",
      "running": false,
      "status": "xyz789",
      "error": ServerError,
      "taskResult": Object
    }
  }
}

asyncSqlRowDataCount

Description

Creates async task to count rows in SQL results

Response

Returns an AsyncTaskInfo!

Arguments
Name Description
projectId - ID
connectionId - ID!
contextId - ID!
resultsId - ID!

Example

Query
mutation asyncSqlRowDataCount(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $resultsId: ID!
) {
  asyncSqlRowDataCount(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    resultsId: $resultsId
  ) {
    id
    name
    running
    status
    error {
      ...ServerErrorFragment
    }
    taskResult
  }
}
Variables
{
  "projectId": "4",
  "connectionId": 4,
  "contextId": 4,
  "resultsId": 4
}
Response
{
  "data": {
    "asyncSqlRowDataCount": {
      "id": "abc123",
      "name": "xyz789",
      "running": false,
      "status": "xyz789",
      "error": ServerError,
      "taskResult": Object
    }
  }
}

asyncSqlRowDataCountResult

Description

Returns row count for async SQL row data count task

Response

Returns an Int!

Arguments
Name Description
taskId - ID!

Example

Query
mutation asyncSqlRowDataCountResult($taskId: ID!) {
  asyncSqlRowDataCountResult(taskId: $taskId)
}
Variables
{"taskId": "4"}
Response
{"data": {"asyncSqlRowDataCountResult": 123}}

asyncSqlSetAutoCommit

Description

Creates async task to set auto-commit mode

Response

Returns an AsyncTaskInfo!

Arguments
Name Description
projectId - ID!
connectionId - ID!
contextId - ID!
autoCommit - Boolean!

Example

Query
mutation asyncSqlSetAutoCommit(
  $projectId: ID!,
  $connectionId: ID!,
  $contextId: ID!,
  $autoCommit: Boolean!
) {
  asyncSqlSetAutoCommit(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    autoCommit: $autoCommit
  ) {
    id
    name
    running
    status
    error {
      ...ServerErrorFragment
    }
    taskResult
  }
}
Variables
{
  "projectId": "4",
  "connectionId": 4,
  "contextId": 4,
  "autoCommit": false
}
Response
{
  "data": {
    "asyncSqlSetAutoCommit": {
      "id": "abc123",
      "name": "abc123",
      "running": false,
      "status": "xyz789",
      "error": ServerError,
      "taskResult": Object
    }
  }
}

asyncTaskCancel

Description

Cancel async task by ID

Response

Returns a Boolean

Arguments
Name Description
id - String!

Example

Query
mutation asyncTaskCancel($id: String!) {
  asyncTaskCancel(id: $id)
}
Variables
{"id": "xyz789"}
Response
{"data": {"asyncTaskCancel": true}}

asyncTaskInfo

Description

Get async task info by ID

Response

Returns an AsyncTaskInfo!

Arguments
Name Description
id - String!
removeOnFinish - Boolean!

Example

Query
mutation asyncTaskInfo(
  $id: String!,
  $removeOnFinish: Boolean!
) {
  asyncTaskInfo(
    id: $id,
    removeOnFinish: $removeOnFinish
  ) {
    id
    name
    running
    status
    error {
      ...ServerErrorFragment
    }
    taskResult
  }
}
Variables
{"id": "xyz789", "removeOnFinish": false}
Response
{
  "data": {
    "asyncTaskInfo": {
      "id": "abc123",
      "name": "xyz789",
      "running": false,
      "status": "xyz789",
      "error": ServerError,
      "taskResult": Object
    }
  }
}

asyncUpdateResultsDataBatch

Description

Creates async task for updating results data in batch mode

Response

Returns an AsyncTaskInfo!

Arguments
Name Description
projectId - ID!
connectionId - ID!
contextId - ID!
resultsId - ID!
updatedRows - [SQLResultRow!]
deletedRows - [SQLResultRow!]
addedRows - [SQLResultRow!]

Example

Query
mutation asyncUpdateResultsDataBatch(
  $projectId: ID!,
  $connectionId: ID!,
  $contextId: ID!,
  $resultsId: ID!,
  $updatedRows: [SQLResultRow!],
  $deletedRows: [SQLResultRow!],
  $addedRows: [SQLResultRow!]
) {
  asyncUpdateResultsDataBatch(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    resultsId: $resultsId,
    updatedRows: $updatedRows,
    deletedRows: $deletedRows,
    addedRows: $addedRows
  ) {
    id
    name
    running
    status
    error {
      ...ServerErrorFragment
    }
    taskResult
  }
}
Variables
{
  "projectId": 4,
  "connectionId": "4",
  "contextId": 4,
  "resultsId": "4",
  "updatedRows": [SQLResultRow],
  "deletedRows": [SQLResultRow],
  "addedRows": [SQLResultRow]
}
Response
{
  "data": {
    "asyncUpdateResultsDataBatch": {
      "id": "abc123",
      "name": "xyz789",
      "running": false,
      "status": "xyz789",
      "error": ServerError,
      "taskResult": Object
    }
  }
}

awsEnableFederatedAccess

No longer supported
Response

Returns a Boolean

Arguments
Name Description
enable - Boolean

Example

Query
mutation awsEnableFederatedAccess($enable: Boolean) {
  awsEnableFederatedAccess(enable: $enable)
}
Variables
{"enable": true}
Response
{"data": {"awsEnableFederatedAccess": false}}

awsEnableGovRegions

use awsUpdateCloudConfiguration (24.3.1)
Description

Allows or disallows the use of AWS GovCloud regions.

Response

Returns a Boolean!

Arguments
Name Description
enable - Boolean!

Example

Query
mutation awsEnableGovRegions($enable: Boolean!) {
  awsEnableGovRegions(enable: $enable)
}
Variables
{"enable": false}
Response
{"data": {"awsEnableGovRegions": true}}

awsSetAssumeRoleName

use awsUpdateCloudConfiguration (24.3.1)
Description

Sets assume role name for the global credentials

Response

Returns a Boolean!

Arguments
Name Description
roleName - String

Example

Query
mutation awsSetAssumeRoleName($roleName: String) {
  awsSetAssumeRoleName(roleName: $roleName)
}
Variables
{"roleName": "abc123"}
Response
{"data": {"awsSetAssumeRoleName": true}}

awsSetProxyUser

No longer supported
Response

Returns a Boolean

Arguments
Name Description
useSessionUser - Boolean
accessKey - String
secretKey - String

Example

Query
mutation awsSetProxyUser(
  $useSessionUser: Boolean,
  $accessKey: String,
  $secretKey: String
) {
  awsSetProxyUser(
    useSessionUser: $useSessionUser,
    accessKey: $accessKey,
    secretKey: $secretKey
  )
}
Variables
{
  "useSessionUser": true,
  "accessKey": "xyz789",
  "secretKey": "abc123"
}
Response
{"data": {"awsSetProxyUser": true}}

awsSetRegions

use awsUpdateCloudConfiguration (24.3.1)
Description

Updates regions in cloud configuration

Response

Returns a Boolean!

Arguments
Name Description
regions - [String!]!

Example

Query
mutation awsSetRegions($regions: [String!]!) {
  awsSetRegions(regions: $regions)
}
Variables
{"regions": ["xyz789"]}
Response
{"data": {"awsSetRegions": true}}

awsUpdateCloudConfiguration

Description

Updates AWS cloud configuration. Use this mutation to update regions, credentials, and other AWS settings.

Response

Returns an AWSConfiguration!

Arguments
Name Description
config - AWSConfigurationInput!

Example

Query
mutation awsUpdateCloudConfiguration($config: AWSConfigurationInput!) {
  awsUpdateCloudConfiguration(config: $config) {
    cloudId
    cloudName
    allowedAccounts
    regions
    federatedAccessEnabled
    govRegionsEnabled
    proxyUser {
      ...AWSUserInfoFragment
    }
    useDefaultCredentials
    assumeRoleName
  }
}
Variables
{"config": AWSConfigurationInput}
Response
{
  "data": {
    "awsUpdateCloudConfiguration": {
      "cloudId": "abc123",
      "cloudName": "xyz789",
      "allowedAccounts": ["xyz789"],
      "regions": ["abc123"],
      "federatedAccessEnabled": false,
      "govRegionsEnabled": false,
      "proxyUser": AWSUserInfo,
      "useDefaultCredentials": true,
      "assumeRoleName": "abc123"
    }
  }
}

awsUpdateInstallConfiguration

Description

Updates AWS install configuration. Use this mutation to update the agreement ID for AWS installation.

Response

Returns an AWSInstallInfo!

Arguments
Name Description
config - AWSInstallConfigurationInput!

Example

Query
mutation awsUpdateInstallConfiguration($config: AWSInstallConfigurationInput!) {
  awsUpdateInstallConfiguration(config: $config) {
    instanceId
    instanceType
    instanceRole
    accountId
    version
    marketplaceProductCodes
    amiId
    agreementId
    defaultRegion
    accountRegions
  }
}
Variables
{"config": AWSInstallConfigurationInput}
Response
{
  "data": {
    "awsUpdateInstallConfiguration": {
      "instanceId": "xyz789",
      "instanceType": "xyz789",
      "instanceRole": "xyz789",
      "accountId": "xyz789",
      "version": "abc123",
      "marketplaceProductCodes": ["xyz789"],
      "amiId": "xyz789",
      "agreementId": "xyz789",
      "defaultRegion": "abc123",
      "accountRegions": ["xyz789"]
    }
  }
}

awsUseDefaultCredentials

use awsUpdateCloudConfiguration (24.3.1)
Description

Enables or disables use of the default AWS credentials (e.g., a role with credentials is set to EC2 machine).

Response

Returns a Boolean!

Arguments
Name Description
enable - Boolean!

Example

Query
mutation awsUseDefaultCredentials($enable: Boolean!) {
  awsUseDefaultCredentials(enable: $enable)
}
Variables
{"enable": true}
Response
{"data": {"awsUseDefaultCredentials": true}}

changeSessionLanguage

Description

Change session language to specified

Response

Returns a Boolean

Arguments
Name Description
locale - String

Example

Query
mutation changeSessionLanguage($locale: String) {
  changeSessionLanguage(locale: $locale)
}
Variables
{"locale": "xyz789"}
Response
{"data": {"changeSessionLanguage": false}}

closeConnection

Description

Disconnect from database

Response

Returns a ConnectionInfo!

Arguments
Name Description
id - ID!
projectId - ID

Example

Query
mutation closeConnection(
  $id: ID!,
  $projectId: ID
) {
  closeConnection(
    id: $id,
    projectId: $projectId
  ) {
    id
    driverId
    name
    description
    host
    port
    serverName
    databaseName
    url
    mainPropertyValues
    keepAliveInterval
    autocommit
    properties
    connected
    provided
    readOnly
    useUrl
    saveCredentials
    sharedCredentials
    sharedSecrets {
      ...SecretInfoFragment
    }
    credentialsSaved
    authNeeded
    folder
    nodePath
    connectTime
    connectionError {
      ...ServerErrorFragment
    }
    serverVersion
    clientVersion
    origin {
      ...ObjectOriginFragment
    }
    authModel
    authProperties {
      ...ObjectPropertyInfoFragment
    }
    providerProperties
    networkHandlersConfig {
      ...NetworkHandlerConfigFragment
    }
    features
    navigatorSettings {
      ...NavigatorSettingsFragment
    }
    supportedDataFormats
    configurationType
    canViewSettings
    canEdit
    canDelete
    projectId
    requiredAuth
    defaultCatalogName
    defaultSchemaName
    tools
  }
}
Variables
{"id": 4, "projectId": "4"}
Response
{
  "data": {
    "closeConnection": {
      "id": "4",
      "driverId": "4",
      "name": "xyz789",
      "description": "abc123",
      "host": "xyz789",
      "port": "abc123",
      "serverName": "xyz789",
      "databaseName": "abc123",
      "url": "xyz789",
      "mainPropertyValues": Object,
      "keepAliveInterval": 123,
      "autocommit": true,
      "properties": Object,
      "connected": false,
      "provided": true,
      "readOnly": false,
      "useUrl": true,
      "saveCredentials": true,
      "sharedCredentials": true,
      "sharedSecrets": [SecretInfo],
      "credentialsSaved": false,
      "authNeeded": false,
      "folder": "4",
      "nodePath": "abc123",
      "connectTime": "xyz789",
      "connectionError": ServerError,
      "serverVersion": "xyz789",
      "clientVersion": "abc123",
      "origin": ObjectOrigin,
      "authModel": 4,
      "authProperties": [ObjectPropertyInfo],
      "providerProperties": Object,
      "networkHandlersConfig": [NetworkHandlerConfig],
      "features": ["xyz789"],
      "navigatorSettings": NavigatorSettings,
      "supportedDataFormats": ["resultset"],
      "configurationType": "MANUAL",
      "canViewSettings": true,
      "canEdit": true,
      "canDelete": true,
      "projectId": "4",
      "requiredAuth": "abc123",
      "defaultCatalogName": "xyz789",
      "defaultSchemaName": "xyz789",
      "tools": ["abc123"]
    }
  }
}

closeSession

Description

Destroy session

Response

Returns a Boolean

Example

Query
mutation closeSession {
  closeSession
}
Response
{"data": {"closeSession": true}}

copyConnectionFromNode

Description

Copies connection configuration from node

Response

Returns a ConnectionInfo!

Arguments
Name Description
nodePath - String!
config - ConnectionConfig
projectId - ID

Example

Query
mutation copyConnectionFromNode(
  $nodePath: String!,
  $config: ConnectionConfig,
  $projectId: ID
) {
  copyConnectionFromNode(
    nodePath: $nodePath,
    config: $config,
    projectId: $projectId
  ) {
    id
    driverId
    name
    description
    host
    port
    serverName
    databaseName
    url
    mainPropertyValues
    keepAliveInterval
    autocommit
    properties
    connected
    provided
    readOnly
    useUrl
    saveCredentials
    sharedCredentials
    sharedSecrets {
      ...SecretInfoFragment
    }
    credentialsSaved
    authNeeded
    folder
    nodePath
    connectTime
    connectionError {
      ...ServerErrorFragment
    }
    serverVersion
    clientVersion
    origin {
      ...ObjectOriginFragment
    }
    authModel
    authProperties {
      ...ObjectPropertyInfoFragment
    }
    providerProperties
    networkHandlersConfig {
      ...NetworkHandlerConfigFragment
    }
    features
    navigatorSettings {
      ...NavigatorSettingsFragment
    }
    supportedDataFormats
    configurationType
    canViewSettings
    canEdit
    canDelete
    projectId
    requiredAuth
    defaultCatalogName
    defaultSchemaName
    tools
  }
}
Variables
{
  "nodePath": "abc123",
  "config": ConnectionConfig,
  "projectId": 4
}
Response
{
  "data": {
    "copyConnectionFromNode": {
      "id": 4,
      "driverId": "4",
      "name": "xyz789",
      "description": "xyz789",
      "host": "xyz789",
      "port": "abc123",
      "serverName": "abc123",
      "databaseName": "xyz789",
      "url": "abc123",
      "mainPropertyValues": Object,
      "keepAliveInterval": 987,
      "autocommit": false,
      "properties": Object,
      "connected": false,
      "provided": false,
      "readOnly": true,
      "useUrl": true,
      "saveCredentials": true,
      "sharedCredentials": true,
      "sharedSecrets": [SecretInfo],
      "credentialsSaved": false,
      "authNeeded": false,
      "folder": "4",
      "nodePath": "abc123",
      "connectTime": "abc123",
      "connectionError": ServerError,
      "serverVersion": "abc123",
      "clientVersion": "abc123",
      "origin": ObjectOrigin,
      "authModel": 4,
      "authProperties": [ObjectPropertyInfo],
      "providerProperties": Object,
      "networkHandlersConfig": [NetworkHandlerConfig],
      "features": ["xyz789"],
      "navigatorSettings": NavigatorSettings,
      "supportedDataFormats": ["resultset"],
      "configurationType": "MANUAL",
      "canViewSettings": true,
      "canEdit": true,
      "canDelete": false,
      "projectId": 4,
      "requiredAuth": "xyz789",
      "defaultCatalogName": "abc123",
      "defaultSchemaName": "abc123",
      "tools": ["abc123"]
    }
  }
}

createConnection

Description

Create new custom connection

Response

Returns a ConnectionInfo!

Arguments
Name Description
config - ConnectionConfig!
projectId - ID

Example

Query
mutation createConnection(
  $config: ConnectionConfig!,
  $projectId: ID
) {
  createConnection(
    config: $config,
    projectId: $projectId
  ) {
    id
    driverId
    name
    description
    host
    port
    serverName
    databaseName
    url
    mainPropertyValues
    keepAliveInterval
    autocommit
    properties
    connected
    provided
    readOnly
    useUrl
    saveCredentials
    sharedCredentials
    sharedSecrets {
      ...SecretInfoFragment
    }
    credentialsSaved
    authNeeded
    folder
    nodePath
    connectTime
    connectionError {
      ...ServerErrorFragment
    }
    serverVersion
    clientVersion
    origin {
      ...ObjectOriginFragment
    }
    authModel
    authProperties {
      ...ObjectPropertyInfoFragment
    }
    providerProperties
    networkHandlersConfig {
      ...NetworkHandlerConfigFragment
    }
    features
    navigatorSettings {
      ...NavigatorSettingsFragment
    }
    supportedDataFormats
    configurationType
    canViewSettings
    canEdit
    canDelete
    projectId
    requiredAuth
    defaultCatalogName
    defaultSchemaName
    tools
  }
}
Variables
{"config": ConnectionConfig, "projectId": 4}
Response
{
  "data": {
    "createConnection": {
      "id": 4,
      "driverId": 4,
      "name": "xyz789",
      "description": "abc123",
      "host": "abc123",
      "port": "abc123",
      "serverName": "abc123",
      "databaseName": "abc123",
      "url": "abc123",
      "mainPropertyValues": Object,
      "keepAliveInterval": 123,
      "autocommit": true,
      "properties": Object,
      "connected": true,
      "provided": true,
      "readOnly": false,
      "useUrl": false,
      "saveCredentials": false,
      "sharedCredentials": false,
      "sharedSecrets": [SecretInfo],
      "credentialsSaved": false,
      "authNeeded": false,
      "folder": 4,
      "nodePath": "xyz789",
      "connectTime": "abc123",
      "connectionError": ServerError,
      "serverVersion": "abc123",
      "clientVersion": "abc123",
      "origin": ObjectOrigin,
      "authModel": "4",
      "authProperties": [ObjectPropertyInfo],
      "providerProperties": Object,
      "networkHandlersConfig": [NetworkHandlerConfig],
      "features": ["abc123"],
      "navigatorSettings": NavigatorSettings,
      "supportedDataFormats": ["resultset"],
      "configurationType": "MANUAL",
      "canViewSettings": false,
      "canEdit": true,
      "canDelete": false,
      "projectId": 4,
      "requiredAuth": "abc123",
      "defaultCatalogName": "xyz789",
      "defaultSchemaName": "abc123",
      "tools": ["abc123"]
    }
  }
}

createConnectionFolder

Description

Create new folder for connections

Response

Returns a ConnectionFolderInfo!

Arguments
Name Description
parentFolderPath - ID
folderName - String!
projectId - ID

Example

Query
mutation createConnectionFolder(
  $parentFolderPath: ID,
  $folderName: String!,
  $projectId: ID
) {
  createConnectionFolder(
    parentFolderPath: $parentFolderPath,
    folderName: $folderName,
    projectId: $projectId
  ) {
    id
    projectId
    description
  }
}
Variables
{
  "parentFolderPath": 4,
  "folderName": "xyz789",
  "projectId": "4"
}
Response
{
  "data": {
    "createConnectionFolder": {
      "id": "4",
      "projectId": 4,
      "description": "xyz789"
    }
  }
}

createConnectionFromCloudStorageFile

Description

Creates new custom connection from a cloud storage file

Response

Returns a FileBasedConnectionInfo!

Arguments
Name Description
objectId - String!
projectId - String!

Example

Query
mutation createConnectionFromCloudStorageFile(
  $objectId: String!,
  $projectId: String!
) {
  createConnectionFromCloudStorageFile(
    objectId: $objectId,
    projectId: $projectId
  ) {
    connectionInfo {
      ...ConnectionInfoFragment
    }
    nodePathToOpen
  }
}
Variables
{
  "objectId": "xyz789",
  "projectId": "abc123"
}
Response
{
  "data": {
    "createConnectionFromCloudStorageFile": {
      "connectionInfo": ConnectionInfo,
      "nodePathToOpen": "abc123"
    }
  }
}

createDriver

Description

Creates a new driver based on the provided configuration.

Response

Returns a DriverInfo!

Arguments
Name Description
config - DriverConfig!

Example

Query
mutation createDriver($config: DriverConfig!) {
  createDriver(config: $config) {
    id
    name
    description
    icon
    iconBig
    driverId
    providerId
    driverClassName
    defaultHost
    defaultPort
    defaultDatabase
    defaultServer
    defaultUser
    sampleURL
    driverInfoURL
    driverPropertiesURL
    embedded
    enabled
    requiresServerName
    requiresDatabaseName
    useCustomPage
    licenseRequired
    license
    custom
    promotedScore
    driverProperties {
      ...ObjectPropertyInfoFragment
    }
    driverParameters
    mainProperties {
      ...ObjectPropertyInfoFragment
    }
    providerProperties {
      ...ObjectPropertyInfoFragment
    }
    anonymousAccess
    defaultAuthModel
    applicableAuthModels
    applicableNetworkHandlers
    configurationTypes
    downloadable
    driverInstalled
    driverLibraries {
      ...DriverLibraryInfoFragment
    }
    safeEmbeddedDriver
  }
}
Variables
{"config": DriverConfig}
Response
{
  "data": {
    "createDriver": {
      "id": 4,
      "name": "xyz789",
      "description": "abc123",
      "icon": "xyz789",
      "iconBig": "abc123",
      "driverId": "4",
      "providerId": 4,
      "driverClassName": "abc123",
      "defaultHost": "xyz789",
      "defaultPort": "abc123",
      "defaultDatabase": "xyz789",
      "defaultServer": "xyz789",
      "defaultUser": "xyz789",
      "sampleURL": "xyz789",
      "driverInfoURL": "xyz789",
      "driverPropertiesURL": "abc123",
      "embedded": true,
      "enabled": true,
      "requiresServerName": false,
      "requiresDatabaseName": true,
      "useCustomPage": true,
      "licenseRequired": true,
      "license": "abc123",
      "custom": false,
      "promotedScore": 123,
      "driverProperties": [ObjectPropertyInfo],
      "driverParameters": Object,
      "mainProperties": [ObjectPropertyInfo],
      "providerProperties": [ObjectPropertyInfo],
      "anonymousAccess": false,
      "defaultAuthModel": "4",
      "applicableAuthModels": ["4"],
      "applicableNetworkHandlers": [4],
      "configurationTypes": ["MANUAL"],
      "downloadable": true,
      "driverInstalled": false,
      "driverLibraries": [DriverLibraryInfo],
      "safeEmbeddedDriver": false
    }
  }
}

deleteConnection

Description

Delete specified connection

Response

Returns a Boolean!

Arguments
Name Description
id - ID!
projectId - ID

Example

Query
mutation deleteConnection(
  $id: ID!,
  $projectId: ID
) {
  deleteConnection(
    id: $id,
    projectId: $projectId
  )
}
Variables
{
  "id": "4",
  "projectId": "4"
}
Response
{"data": {"deleteConnection": false}}

deleteConnectionFolder

Description

Delete specified connection folder

Response

Returns a Boolean!

Arguments
Name Description
folderPath - ID!
projectId - ID

Example

Query
mutation deleteConnectionFolder(
  $folderPath: ID!,
  $projectId: ID
) {
  deleteConnectionFolder(
    folderPath: $folderPath,
    projectId: $projectId
  )
}
Variables
{"folderPath": "4", "projectId": 4}
Response
{"data": {"deleteConnectionFolder": true}}

deleteDriver

Description

Deletes a driver by its ID. Only custom drivers can be deleted.

Response

Returns a Boolean!

Arguments
Name Description
id - ID!

Example

Query
mutation deleteDriver($id: ID!) {
  deleteDriver(id: $id)
}
Variables
{"id": 4}
Response
{"data": {"deleteDriver": true}}

deleteDriverLibraries

Description

Removes driver libraries by their IDs from the driver configuration. Driver files are not deleted from the server.

Response

Returns a Boolean!

Arguments
Name Description
driverId - ID!
libraryIds - [ID!]!

Example

Query
mutation deleteDriverLibraries(
  $driverId: ID!,
  $libraryIds: [ID!]!
) {
  deleteDriverLibraries(
    driverId: $driverId,
    libraryIds: $libraryIds
  )
}
Variables
{"driverId": "4", "libraryIds": [4]}
Response
{"data": {"deleteDriverLibraries": false}}

dmAddCustomCertificate

Description

Adds or updates a custom certificate for the domain manager server.

Response

Returns a Boolean!

Arguments
Name Description
config - CustomCertificateConfig!

Example

Query
mutation dmAddCustomCertificate($config: CustomCertificateConfig!) {
  dmAddCustomCertificate(config: $config)
}
Variables
{"config": CustomCertificateConfig}
Response
{"data": {"dmAddCustomCertificate": false}}

dmDeleteCustomCertificate

Description

Deletes a custom certificate for the domain manager server.

Response

Returns a Boolean!

Arguments
Name Description
address - String!

Example

Query
mutation dmDeleteCustomCertificate($address: String!) {
  dmDeleteCustomCertificate(address: $address)
}
Variables
{"address": "xyz789"}
Response
{"data": {"dmDeleteCustomCertificate": true}}

dmDeleteDeployment

Description

Deletes the information about the deployment. Can be used if the deployment is not available anymore and the amount of servers number from the license is reached.

Response

Returns an OrganizationInfo!

Arguments
Name Description
id - ID!

Example

Query
mutation dmDeleteDeployment($id: ID!) {
  dmDeleteDeployment(id: $id) {
    id
    baseDomain
    subdomain
    deployments {
      ...DeploymentInfoFragment
    }
    currentDeployment {
      ...DeploymentInfoFragment
    }
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "dmDeleteDeployment": {
      "id": "4",
      "baseDomain": "abc123",
      "subdomain": "abc123",
      "deployments": [DeploymentInfo],
      "currentDeployment": DeploymentInfo
    }
  }
}

dmDeleteDeploymentDomain

Description

Deletes the automatically registered deployment domain.

Response

Returns a DeploymentInfo

Example

Query
mutation dmDeleteDeploymentDomain {
  dmDeleteDeploymentDomain {
    id
    ipAddress
    publicAddress
    subdomain
    dateOfExpire
    domainRenewalError {
      ...DomainRenewalErrorFragment
    }
  }
}
Response
{
  "data": {
    "dmDeleteDeploymentDomain": {
      "id": "4",
      "ipAddress": "xyz789",
      "publicAddress": "abc123",
      "subdomain": "xyz789",
      "dateOfExpire": "xyz789",
      "domainRenewalError": DomainRenewalError
    }
  }
}

emptyEventMutation

Response

Returns a Boolean

Example

Query
mutation emptyEventMutation {
  emptyEventMutation
}
Response
{"data": {"emptyEventMutation": false}}

fakeFunction

Response

Returns an Object

Example

Query
mutation fakeFunction {
  fakeFunction
}
Response
{"data": {"fakeFunction": Object}}

fakeFunctionAWS

Response

Returns an Object

Example

Query
mutation fakeFunctionAWS {
  fakeFunctionAWS
}
Response
{"data": {"fakeFunctionAWS": Object}}

fakeFunctionQM

Response

Returns an Object

Example

Query
mutation fakeFunctionQM {
  fakeFunctionQM
}
Response
{"data": {"fakeFunctionQM": Object}}

federatedLogin

Description

Creates async task for federated login. Returns redirect link to the task info page.

Response

Returns a FederatedAuthInfo!

Arguments
Name Description
provider - ID!
configuration - ID
linkUser - Boolean
forceSessionsLogout - Boolean

Example

Query
mutation federatedLogin(
  $provider: ID!,
  $configuration: ID,
  $linkUser: Boolean,
  $forceSessionsLogout: Boolean
) {
  federatedLogin(
    provider: $provider,
    configuration: $configuration,
    linkUser: $linkUser,
    forceSessionsLogout: $forceSessionsLogout
  ) {
    redirectLink
    taskInfo {
      ...AsyncTaskInfoFragment
    }
  }
}
Variables
{
  "provider": "4",
  "configuration": "4",
  "linkUser": true,
  "forceSessionsLogout": false
}
Response
{
  "data": {
    "federatedLogin": {
      "redirectLink": "abc123",
      "taskInfo": AsyncTaskInfo
    }
  }
}

fsCopy

Description

Copies file or folder to the specified parent path. Returns updated file info

Response

Returns an FSFile!

Arguments
Name Description
nodePath - String!
toParentNodePath - String!

Example

Query
mutation fsCopy(
  $nodePath: String!,
  $toParentNodePath: String!
) {
  fsCopy(
    nodePath: $nodePath,
    toParentNodePath: $toParentNodePath
  ) {
    name
    length
    folder
    metaData
    nodePath
  }
}
Variables
{
  "nodePath": "abc123",
  "toParentNodePath": "abc123"
}
Response
{
  "data": {
    "fsCopy": {
      "name": "xyz789",
      "length": 987,
      "folder": true,
      "metaData": Object,
      "nodePath": "xyz789"
    }
  }
}

fsCreateFile

Description

Creates a new file in the specified parent path

Response

Returns an FSFile!

Arguments
Name Description
parentPath - String!
fileName - String!

Example

Query
mutation fsCreateFile(
  $parentPath: String!,
  $fileName: String!
) {
  fsCreateFile(
    parentPath: $parentPath,
    fileName: $fileName
  ) {
    name
    length
    folder
    metaData
    nodePath
  }
}
Variables
{
  "parentPath": "abc123",
  "fileName": "abc123"
}
Response
{
  "data": {
    "fsCreateFile": {
      "name": "xyz789",
      "length": 123,
      "folder": false,
      "metaData": Object,
      "nodePath": "xyz789"
    }
  }
}

fsCreateFolder

Description

Creates a new folder in the specified parent path

Response

Returns an FSFile!

Arguments
Name Description
parentPath - String!
folderName - String!

Example

Query
mutation fsCreateFolder(
  $parentPath: String!,
  $folderName: String!
) {
  fsCreateFolder(
    parentPath: $parentPath,
    folderName: $folderName
  ) {
    name
    length
    folder
    metaData
    nodePath
  }
}
Variables
{
  "parentPath": "xyz789",
  "folderName": "abc123"
}
Response
{
  "data": {
    "fsCreateFolder": {
      "name": "xyz789",
      "length": 123,
      "folder": true,
      "metaData": Object,
      "nodePath": "xyz789"
    }
  }
}

fsDelete

Description

Deletes file or folder by node path. Returns true if file was deleted, false if file not found

Response

Returns a Boolean!

Arguments
Name Description
nodePath - String!

Example

Query
mutation fsDelete($nodePath: String!) {
  fsDelete(nodePath: $nodePath)
}
Variables
{"nodePath": "xyz789"}
Response
{"data": {"fsDelete": false}}

fsMove

Description

Moves file or folder to the specified parent path. Returns updated file info

Response

Returns an FSFile!

Arguments
Name Description
nodePath - String!
toParentNodePath - String!

Example

Query
mutation fsMove(
  $nodePath: String!,
  $toParentNodePath: String!
) {
  fsMove(
    nodePath: $nodePath,
    toParentNodePath: $toParentNodePath
  ) {
    name
    length
    folder
    metaData
    nodePath
  }
}
Variables
{
  "nodePath": "abc123",
  "toParentNodePath": "abc123"
}
Response
{
  "data": {
    "fsMove": {
      "name": "xyz789",
      "length": 123,
      "folder": true,
      "metaData": Object,
      "nodePath": "abc123"
    }
  }
}

fsRename

Description

Renames file or folder by node path. Returns updated file info

Response

Returns an FSFile!

Arguments
Name Description
nodePath - String!
newName - String!

Example

Query
mutation fsRename(
  $nodePath: String!,
  $newName: String!
) {
  fsRename(
    nodePath: $nodePath,
    newName: $newName
  ) {
    name
    length
    folder
    metaData
    nodePath
  }
}
Variables
{
  "nodePath": "abc123",
  "newName": "xyz789"
}
Response
{
  "data": {
    "fsRename": {
      "name": "abc123",
      "length": 123,
      "folder": true,
      "metaData": Object,
      "nodePath": "abc123"
    }
  }
}

fsWriteFileStringContent

Description

Writes string content to the file. If forceOverwrite is true then overwrites existing file, otherwise throws an error if file already exists

Response

Returns an FSFile!

Arguments
Name Description
nodePath - String!
data - String!
forceOverwrite - Boolean!

Example

Query
mutation fsWriteFileStringContent(
  $nodePath: String!,
  $data: String!,
  $forceOverwrite: Boolean!
) {
  fsWriteFileStringContent(
    nodePath: $nodePath,
    data: $data,
    forceOverwrite: $forceOverwrite
  ) {
    name
    length
    folder
    metaData
    nodePath
  }
}
Variables
{
  "nodePath": "abc123",
  "data": "xyz789",
  "forceOverwrite": false
}
Response
{
  "data": {
    "fsWriteFileStringContent": {
      "name": "xyz789",
      "length": 123,
      "folder": false,
      "metaData": Object,
      "nodePath": "abc123"
    }
  }
}

getChildrenCollections

Description

Returns a list of subcollections for the given collection in Firestore

Response

Returns [SubCollectionInfo!]!

Arguments
Name Description
projectId - ID
connectionId - ID
contextId - ID!
resultsId - ID!
row - SQLResultRowMetaDataInput!

Example

Query
mutation getChildrenCollections(
  $projectId: ID,
  $connectionId: ID,
  $contextId: ID!,
  $resultsId: ID!,
  $row: SQLResultRowMetaDataInput!
) {
  getChildrenCollections(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    resultsId: $resultsId,
    row: $row
  ) {
    icon
    name
    path
  }
}
Variables
{
  "projectId": "4",
  "connectionId": "4",
  "contextId": "4",
  "resultsId": 4,
  "row": SQLResultRowMetaDataInput
}
Response
{
  "data": {
    "getChildrenCollections": [
      {
        "icon": "abc123",
        "name": "abc123",
        "path": "xyz789"
      }
    ]
  }
}

getTransactionLogInfo

Description

Returns transaction log info for the specified project, connection and context

Response

Returns a TransactionLogInfos!

Arguments
Name Description
projectId - ID!
connectionId - ID!
contextId - ID!

Example

Query
mutation getTransactionLogInfo(
  $projectId: ID!,
  $connectionId: ID!,
  $contextId: ID!
) {
  getTransactionLogInfo(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId
  ) {
    count
    transactionLogInfos {
      ...TransactionLogInfoItemFragment
    }
  }
}
Variables
{
  "projectId": "4",
  "connectionId": "4",
  "contextId": "4"
}
Response
{
  "data": {
    "getTransactionLogInfo": {
      "count": 987,
      "transactionLogInfos": [TransactionLogInfoItem]
    }
  }
}

gitSaveGlobalSettings

Description

Saves the global git configuration settings.

Response

Returns a GitGlobalSettings!

Arguments
Name Description
settings - GitGlobalSettingsInput!

Example

Query
mutation gitSaveGlobalSettings($settings: GitGlobalSettingsInput!) {
  gitSaveGlobalSettings(settings: $settings) {
    username
    email
    password
  }
}
Variables
{"settings": GitGlobalSettingsInput}
Response
{
  "data": {
    "gitSaveGlobalSettings": {
      "username": "abc123",
      "email": "xyz789",
      "password": "abc123"
    }
  }
}

gitSaveProjectSettings

Description

Saves the git configuration settings for a specific project.

Response

Returns a GitProjectSettings!

Arguments
Name Description
projectId - ID!
settings - GitProjectSettingsInput!

Example

Query
mutation gitSaveProjectSettings(
  $projectId: ID!,
  $settings: GitProjectSettingsInput!
) {
  gitSaveProjectSettings(
    projectId: $projectId,
    settings: $settings
  ) {
    enabled
    repositoryUrl
    branch
    gitIgnoreRules
  }
}
Variables
{"projectId": 4, "settings": GitProjectSettingsInput}
Response
{
  "data": {
    "gitSaveProjectSettings": {
      "enabled": true,
      "repositoryUrl": "abc123",
      "branch": "xyz789",
      "gitIgnoreRules": ["DATASOURCES"]
    }
  }
}

gitTestRemoteRepositoryAccess

Description

Tests the global git configuration settings.

Response

Returns a Boolean!

Arguments
Name Description
settings - GitGlobalSettingsTestInput
repositoryUrl - String!

Example

Query
mutation gitTestRemoteRepositoryAccess(
  $settings: GitGlobalSettingsTestInput,
  $repositoryUrl: String!
) {
  gitTestRemoteRepositoryAccess(
    settings: $settings,
    repositoryUrl: $repositoryUrl
  )
}
Variables
{
  "settings": GitGlobalSettingsTestInput,
  "repositoryUrl": "abc123"
}
Response
{"data": {"gitTestRemoteRepositoryAccess": true}}

importProductLicense

Description

Imports a new product license key.

Response

Returns an LMLicenseInfo!

Arguments
Name Description
licenseText - String

Example

Query
mutation importProductLicense($licenseText: String) {
  importProductLicense(licenseText: $licenseText) {
    id
    licenseType
    ownerCompany
    ownerName
    ownerEmail
    usersNumber
    yearsNumber
    subscription
    unlimitedServers
    multiInstance
    serversNumber
    licenseIssueTime
    licenseStartTime
    licenseEndTime
    licenseRoles {
      ...LMLicenseRoleFragment
    }
    licenseStatus {
      ...LMLicenseStatusDetailsFragment
    }
  }
}
Variables
{"licenseText": "xyz789"}
Response
{
  "data": {
    "importProductLicense": {
      "id": "abc123",
      "licenseType": "abc123",
      "ownerCompany": "xyz789",
      "ownerName": "xyz789",
      "ownerEmail": "abc123",
      "usersNumber": 987,
      "yearsNumber": 987,
      "subscription": false,
      "unlimitedServers": false,
      "multiInstance": true,
      "serversNumber": 987,
      "licenseIssueTime": "xyz789",
      "licenseStartTime": "xyz789",
      "licenseEndTime": "abc123",
      "licenseRoles": [LMLicenseRole],
      "licenseStatus": LMLicenseStatusDetails
    }
  }
}

initConnection

Description

Initiate existing connection

Response

Returns a ConnectionInfo!

Arguments
Name Description
id - ID!
projectId - ID
credentials - Object
networkCredentials - [NetworkHandlerConfigInput!]
saveCredentials - Boolean
sharedCredentials - Boolean
selectedSecretId - String

Example

Query
mutation initConnection(
  $id: ID!,
  $projectId: ID,
  $credentials: Object,
  $networkCredentials: [NetworkHandlerConfigInput!],
  $saveCredentials: Boolean,
  $sharedCredentials: Boolean,
  $selectedSecretId: String
) {
  initConnection(
    id: $id,
    projectId: $projectId,
    credentials: $credentials,
    networkCredentials: $networkCredentials,
    saveCredentials: $saveCredentials,
    sharedCredentials: $sharedCredentials,
    selectedSecretId: $selectedSecretId
  ) {
    id
    driverId
    name
    description
    host
    port
    serverName
    databaseName
    url
    mainPropertyValues
    keepAliveInterval
    autocommit
    properties
    connected
    provided
    readOnly
    useUrl
    saveCredentials
    sharedCredentials
    sharedSecrets {
      ...SecretInfoFragment
    }
    credentialsSaved
    authNeeded
    folder
    nodePath
    connectTime
    connectionError {
      ...ServerErrorFragment
    }
    serverVersion
    clientVersion
    origin {
      ...ObjectOriginFragment
    }
    authModel
    authProperties {
      ...ObjectPropertyInfoFragment
    }
    providerProperties
    networkHandlersConfig {
      ...NetworkHandlerConfigFragment
    }
    features
    navigatorSettings {
      ...NavigatorSettingsFragment
    }
    supportedDataFormats
    configurationType
    canViewSettings
    canEdit
    canDelete
    projectId
    requiredAuth
    defaultCatalogName
    defaultSchemaName
    tools
  }
}
Variables
{
  "id": "4",
  "projectId": "4",
  "credentials": Object,
  "networkCredentials": [NetworkHandlerConfigInput],
  "saveCredentials": true,
  "sharedCredentials": false,
  "selectedSecretId": "xyz789"
}
Response
{
  "data": {
    "initConnection": {
      "id": "4",
      "driverId": 4,
      "name": "xyz789",
      "description": "abc123",
      "host": "abc123",
      "port": "abc123",
      "serverName": "xyz789",
      "databaseName": "abc123",
      "url": "abc123",
      "mainPropertyValues": Object,
      "keepAliveInterval": 987,
      "autocommit": false,
      "properties": Object,
      "connected": true,
      "provided": false,
      "readOnly": false,
      "useUrl": false,
      "saveCredentials": false,
      "sharedCredentials": false,
      "sharedSecrets": [SecretInfo],
      "credentialsSaved": true,
      "authNeeded": false,
      "folder": 4,
      "nodePath": "xyz789",
      "connectTime": "abc123",
      "connectionError": ServerError,
      "serverVersion": "xyz789",
      "clientVersion": "xyz789",
      "origin": ObjectOrigin,
      "authModel": 4,
      "authProperties": [ObjectPropertyInfo],
      "providerProperties": Object,
      "networkHandlersConfig": [NetworkHandlerConfig],
      "features": ["xyz789"],
      "navigatorSettings": NavigatorSettings,
      "supportedDataFormats": ["resultset"],
      "configurationType": "MANUAL",
      "canViewSettings": false,
      "canEdit": false,
      "canDelete": false,
      "projectId": 4,
      "requiredAuth": "xyz789",
      "defaultCatalogName": "xyz789",
      "defaultSchemaName": "xyz789",
      "tools": ["abc123"]
    }
  }
}

lmDeleteProductLicense

Description

Deletes a product license by its identifier.

Response

Returns a Boolean!

Arguments
Name Description
id - ID!

Example

Query
mutation lmDeleteProductLicense($id: ID!) {
  lmDeleteProductLicense(id: $id)
}
Variables
{"id": "4"}
Response
{"data": {"lmDeleteProductLicense": false}}

msSetServiceConfiguration

Response

Returns a String!

Arguments
Name Description
type - MSServiceType!
configuration - String!

Example

Query
mutation msSetServiceConfiguration(
  $type: MSServiceType!,
  $configuration: String!
) {
  msSetServiceConfiguration(
    type: $type,
    configuration: $configuration
  )
}
Variables
{
  "type": "DOMAIN_CONTROLLER",
  "configuration": "xyz789"
}
Response
{
  "data": {
    "msSetServiceConfiguration": "xyz789"
  }
}

navDeleteNodes

Description

Deletes nodes with specified IDs and returns number of deleted nodes

Response

Returns an Int

Arguments
Name Description
nodePaths - [ID!]!

Example

Query
mutation navDeleteNodes($nodePaths: [ID!]!) {
  navDeleteNodes(nodePaths: $nodePaths)
}
Variables
{"nodePaths": ["4"]}
Response
{"data": {"navDeleteNodes": 123}}

navMoveNodesToFolder

Description

Moves nodes with specified IDs to the connection folder

Response

Returns a Boolean!

Arguments
Name Description
nodePaths - [ID!]!
folderPath - ID!

Example

Query
mutation navMoveNodesToFolder(
  $nodePaths: [ID!]!,
  $folderPath: ID!
) {
  navMoveNodesToFolder(
    nodePaths: $nodePaths,
    folderPath: $folderPath
  )
}
Variables
{"nodePaths": [4], "folderPath": 4}
Response
{"data": {"navMoveNodesToFolder": false}}

navReloadNode

Description

Reloads node and returns updated node info

Response

Returns a NavigatorNodeInfo!

Arguments
Name Description
nodePath - ID!

Example

Query
mutation navReloadNode($nodePath: ID!) {
  navReloadNode(nodePath: $nodePath) {
    id
    uri
    name
    fullName
    plainName
    icon
    description
    nodeType
    hasChildren
    projectId
    object {
      ...DatabaseObjectInfoFragment
    }
    objectId
    features
    nodeDetails {
      ...ObjectPropertyInfoFragment
    }
    folder
    inline
    navigable
    filtered
    filter {
      ...NavigatorNodeFilterFragment
    }
  }
}
Variables
{"nodePath": "4"}
Response
{
  "data": {
    "navReloadNode": {
      "id": "4",
      "uri": "4",
      "name": "abc123",
      "fullName": "abc123",
      "plainName": "xyz789",
      "icon": "abc123",
      "description": "xyz789",
      "nodeType": "abc123",
      "hasChildren": true,
      "projectId": "abc123",
      "object": DatabaseObjectInfo,
      "objectId": "abc123",
      "features": ["xyz789"],
      "nodeDetails": [ObjectPropertyInfo],
      "folder": true,
      "inline": true,
      "navigable": false,
      "filtered": false,
      "filter": NavigatorNodeFilter
    }
  }
}

navRenameNode

Description

Renames node and returns new node name

Response

Returns a String

Arguments
Name Description
nodePath - ID!
newName - String!

Example

Query
mutation navRenameNode(
  $nodePath: ID!,
  $newName: String!
) {
  navRenameNode(
    nodePath: $nodePath,
    newName: $newName
  )
}
Variables
{"nodePath": 4, "newName": "abc123"}
Response
{"data": {"navRenameNode": "abc123"}}

navSetFolderFilter

Description

Sets filter for the folder node. If both include and exclude are null then filter is removed. Node must be refreshed after applying filters. Node children can be changed

Response

Returns a Boolean!

Arguments
Name Description
nodePath - ID!
include - [String!]
exclude - [String!]

Example

Query
mutation navSetFolderFilter(
  $nodePath: ID!,
  $include: [String!],
  $exclude: [String!]
) {
  navSetFolderFilter(
    nodePath: $nodePath,
    include: $include,
    exclude: $exclude
  )
}
Variables
{
  "nodePath": "4",
  "include": ["abc123"],
  "exclude": ["abc123"]
}
Response
{"data": {"navSetFolderFilter": false}}

openSession

Description

Initialize session

Response

Returns a SessionInfo!

Arguments
Name Description
defaultLocale - String

Example

Query
mutation openSession($defaultLocale: String) {
  openSession(defaultLocale: $defaultLocale) {
    createTime
    lastAccessTime
    locale
    cacheExpired
    connections {
      ...ConnectionInfoFragment
    }
    actionParameters
    valid
    remainingTime
  }
}
Variables
{"defaultLocale": "abc123"}
Response
{
  "data": {
    "openSession": {
      "createTime": "xyz789",
      "lastAccessTime": "abc123",
      "locale": "abc123",
      "cacheExpired": false,
      "connections": [ConnectionInfo],
      "actionParameters": Object,
      "valid": false,
      "remainingTime": 123
    }
  }
}

provisioningImportUsers

Description

Imports users for provisioning based on the provided user import list.

Response

Returns a Boolean!

Arguments
Name Description
userImportList - UserImportList!

Example

Query
mutation provisioningImportUsers($userImportList: UserImportList!) {
  provisioningImportUsers(userImportList: $userImportList)
}
Variables
{"userImportList": UserImportList}
Response
{"data": {"provisioningImportUsers": true}}

readLobValue

use sqlReadLobValue (23.3.3)
Description

Returns BLOB value

Response

Returns a String!

Arguments
Name Description
projectId - ID
connectionId - ID!
contextId - ID!
resultsId - ID!
lobColumnIndex - Int!
row - [SQLResultRow!]!

Example

Query
mutation readLobValue(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $resultsId: ID!,
  $lobColumnIndex: Int!,
  $row: [SQLResultRow!]!
) {
  readLobValue(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    resultsId: $resultsId,
    lobColumnIndex: $lobColumnIndex,
    row: $row
  )
}
Variables
{
  "projectId": 4,
  "connectionId": 4,
  "contextId": 4,
  "resultsId": "4",
  "lobColumnIndex": 987,
  "row": [SQLResultRow]
}
Response
{"data": {"readLobValue": "xyz789"}}

refreshSessionConnections

Description

Refresh session connection list

Response

Returns a Boolean

Example

Query
mutation refreshSessionConnections {
  refreshSessionConnections
}
Response
{"data": {"refreshSessionConnections": false}}

resetDriver

Description

Resets the driver to its default state.

Response

Returns a DriverInfo!

Arguments
Name Description
id - ID!

Example

Query
mutation resetDriver($id: ID!) {
  resetDriver(id: $id) {
    id
    name
    description
    icon
    iconBig
    driverId
    providerId
    driverClassName
    defaultHost
    defaultPort
    defaultDatabase
    defaultServer
    defaultUser
    sampleURL
    driverInfoURL
    driverPropertiesURL
    embedded
    enabled
    requiresServerName
    requiresDatabaseName
    useCustomPage
    licenseRequired
    license
    custom
    promotedScore
    driverProperties {
      ...ObjectPropertyInfoFragment
    }
    driverParameters
    mainProperties {
      ...ObjectPropertyInfoFragment
    }
    providerProperties {
      ...ObjectPropertyInfoFragment
    }
    anonymousAccess
    defaultAuthModel
    applicableAuthModels
    applicableNetworkHandlers
    configurationTypes
    downloadable
    driverInstalled
    driverLibraries {
      ...DriverLibraryInfoFragment
    }
    safeEmbeddedDriver
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "resetDriver": {
      "id": 4,
      "name": "xyz789",
      "description": "abc123",
      "icon": "xyz789",
      "iconBig": "xyz789",
      "driverId": "4",
      "providerId": 4,
      "driverClassName": "abc123",
      "defaultHost": "xyz789",
      "defaultPort": "abc123",
      "defaultDatabase": "xyz789",
      "defaultServer": "xyz789",
      "defaultUser": "xyz789",
      "sampleURL": "xyz789",
      "driverInfoURL": "abc123",
      "driverPropertiesURL": "abc123",
      "embedded": true,
      "enabled": true,
      "requiresServerName": false,
      "requiresDatabaseName": false,
      "useCustomPage": true,
      "licenseRequired": false,
      "license": "xyz789",
      "custom": true,
      "promotedScore": 123,
      "driverProperties": [ObjectPropertyInfo],
      "driverParameters": Object,
      "mainProperties": [ObjectPropertyInfo],
      "providerProperties": [ObjectPropertyInfo],
      "anonymousAccess": true,
      "defaultAuthModel": 4,
      "applicableAuthModels": ["4"],
      "applicableNetworkHandlers": [4],
      "configurationTypes": ["MANUAL"],
      "downloadable": true,
      "driverInstalled": false,
      "driverLibraries": [DriverLibraryInfo],
      "safeEmbeddedDriver": false
    }
  }
}

rmAddProjectsPermissions

Description

Adds project permissions to the specified projects based on subject IDs and permissions. Returns true if permissions were added successfully.

Response

Returns a Boolean

Arguments
Name Description
projectIds - [ID!]!
subjectIds - [ID!]!
permissions - [String!]!

Example

Query
mutation rmAddProjectsPermissions(
  $projectIds: [ID!]!,
  $subjectIds: [ID!]!,
  $permissions: [String!]!
) {
  rmAddProjectsPermissions(
    projectIds: $projectIds,
    subjectIds: $subjectIds,
    permissions: $permissions
  )
}
Variables
{
  "projectIds": ["4"],
  "subjectIds": [4],
  "permissions": ["xyz789"]
}
Response
{"data": {"rmAddProjectsPermissions": true}}

rmCreateDataSet

Description

Creates or updates a dataset in the specified project.

Response

Returns a DataSetInfo!

Arguments
Name Description
projectId - ID!
datasetPath - String!
datasetConfig - DataSetConfig
forceOverwrite - Boolean

Example

Query
mutation rmCreateDataSet(
  $projectId: ID!,
  $datasetPath: String!,
  $datasetConfig: DataSetConfig,
  $forceOverwrite: Boolean
) {
  rmCreateDataSet(
    projectId: $projectId,
    datasetPath: $datasetPath,
    datasetConfig: $datasetConfig,
    forceOverwrite: $forceOverwrite
  ) {
    displayName
    description
    draft
    queries {
      ...DataSetQueryInfoFragment
    }
    datasetPath
    projectId
  }
}
Variables
{
  "projectId": 4,
  "datasetPath": "xyz789",
  "datasetConfig": DataSetConfig,
  "forceOverwrite": false
}
Response
{
  "data": {
    "rmCreateDataSet": {
      "displayName": "xyz789",
      "description": "xyz789",
      "draft": true,
      "queries": [DataSetQueryInfo],
      "datasetPath": "abc123",
      "projectId": 4
    }
  }
}

rmCreateProject

Description

Creates a new project with the specified projectId and projectName.

Response

Returns an RMProject!

Arguments
Name Description
projectId - ID
projectName - String!
description - String

Example

Query
mutation rmCreateProject(
  $projectId: ID,
  $projectName: String!,
  $description: String
) {
  rmCreateProject(
    projectId: $projectId,
    projectName: $projectName,
    description: $description
  ) {
    id
    name
    description
    shared
    global
    createTime
    creator
    projectPermissions
    resourceTypes {
      ...RMResourceTypeFragment
    }
  }
}
Variables
{
  "projectId": "4",
  "projectName": "xyz789",
  "description": "xyz789"
}
Response
{
  "data": {
    "rmCreateProject": {
      "id": "4",
      "name": "abc123",
      "description": "xyz789",
      "shared": false,
      "global": true,
      "createTime": "2007-12-03T10:15:30Z",
      "creator": "xyz789",
      "projectPermissions": ["xyz789"],
      "resourceTypes": [RMResourceType]
    }
  }
}

rmCreateResource

Description

Creates a new resource in the specified project and folder. If isFolder is true then creates a folder, otherwise creates a file

Response

Returns a String!

Arguments
Name Description
projectId - String!
resourcePath - String!
isFolder - Boolean!

Example

Query
mutation rmCreateResource(
  $projectId: String!,
  $resourcePath: String!,
  $isFolder: Boolean!
) {
  rmCreateResource(
    projectId: $projectId,
    resourcePath: $resourcePath,
    isFolder: $isFolder
  )
}
Variables
{
  "projectId": "abc123",
  "resourcePath": "abc123",
  "isFolder": true
}
Response
{"data": {"rmCreateResource": "xyz789"}}

rmDeleteProject

Description

Deletes project by projectId. Returns true if project was deleted, false if project not found

Response

Returns a Boolean!

Arguments
Name Description
projectId - ID!

Example

Query
mutation rmDeleteProject($projectId: ID!) {
  rmDeleteProject(projectId: $projectId)
}
Variables
{"projectId": 4}
Response
{"data": {"rmDeleteProject": false}}

rmDeleteProjectsPermissions

Description

Deletes project permissions from the specified projects based on subject IDs and permissions. Returns true if permissions were deleted successfully.

Response

Returns a Boolean

Arguments
Name Description
projectIds - [ID!]!
subjectIds - [ID!]!
permissions - [String!]!

Example

Query
mutation rmDeleteProjectsPermissions(
  $projectIds: [ID!]!,
  $subjectIds: [ID!]!,
  $permissions: [String!]!
) {
  rmDeleteProjectsPermissions(
    projectIds: $projectIds,
    subjectIds: $subjectIds,
    permissions: $permissions
  )
}
Variables
{
  "projectIds": ["4"],
  "subjectIds": [4],
  "permissions": ["abc123"]
}
Response
{"data": {"rmDeleteProjectsPermissions": true}}

rmDeleteResource

Description

Deletes resource by path in the specified project. If recursive is true then deletes all sub-resources in the folder

Response

Returns a Boolean

Arguments
Name Description
projectId - String!
resourcePath - String!
recursive - Boolean!

Example

Query
mutation rmDeleteResource(
  $projectId: String!,
  $resourcePath: String!,
  $recursive: Boolean!
) {
  rmDeleteResource(
    projectId: $projectId,
    resourcePath: $resourcePath,
    recursive: $recursive
  )
}
Variables
{
  "projectId": "xyz789",
  "resourcePath": "xyz789",
  "recursive": true
}
Response
{"data": {"rmDeleteResource": true}}

rmMoveResource

Description

Moves resource to the specified new path in the same project. Can be used to rename a resource

Response

Returns a String!

Arguments
Name Description
projectId - String!
oldResourcePath - String!
newResourcePath - String

Example

Query
mutation rmMoveResource(
  $projectId: String!,
  $oldResourcePath: String!,
  $newResourcePath: String
) {
  rmMoveResource(
    projectId: $projectId,
    oldResourcePath: $oldResourcePath,
    newResourcePath: $newResourcePath
  )
}
Variables
{
  "projectId": "abc123",
  "oldResourcePath": "abc123",
  "newResourcePath": "xyz789"
}
Response
{"data": {"rmMoveResource": "abc123"}}

rmSetProjectPermissions

use setConnectionSubjectAccess
Response

Returns a Boolean!

Arguments
Name Description
projectId - String!
permissions - [RMSubjectProjectPermissions!]!

Example

Query
mutation rmSetProjectPermissions(
  $projectId: String!,
  $permissions: [RMSubjectProjectPermissions!]!
) {
  rmSetProjectPermissions(
    projectId: $projectId,
    permissions: $permissions
  )
}
Variables
{
  "projectId": "xyz789",
  "permissions": [RMSubjectProjectPermissions]
}
Response
{"data": {"rmSetProjectPermissions": true}}

rmSetResourceProperty

Description

Sets resource property by name. If value is null then removes the property (e.g., sets relation between resource and connection).

Response

Returns a Boolean!

Arguments
Name Description
projectId - String!
resourcePath - String!
name - ID!
value - String

Example

Query
mutation rmSetResourceProperty(
  $projectId: String!,
  $resourcePath: String!,
  $name: ID!,
  $value: String
) {
  rmSetResourceProperty(
    projectId: $projectId,
    resourcePath: $resourcePath,
    name: $name,
    value: $value
  )
}
Variables
{
  "projectId": "abc123",
  "resourcePath": "xyz789",
  "name": 4,
  "value": "xyz789"
}
Response
{"data": {"rmSetResourceProperty": false}}

rmSetSubjectProjectPermissions

No longer supported
Response

Returns a Boolean!

Arguments
Name Description
subjectId - String!
permissions - [RMProjectPermissions!]!

Example

Query
mutation rmSetSubjectProjectPermissions(
  $subjectId: String!,
  $permissions: [RMProjectPermissions!]!
) {
  rmSetSubjectProjectPermissions(
    subjectId: $subjectId,
    permissions: $permissions
  )
}
Variables
{
  "subjectId": "abc123",
  "permissions": [RMProjectPermissions]
}
Response
{"data": {"rmSetSubjectProjectPermissions": true}}

rmWriteResourceStringContent

Description

Writes string content to the resource. If forceOverwrite is true then overwrites existing resource, otherwise throws an error if resource already exists

Response

Returns a String!

Arguments
Name Description
projectId - String!
resourcePath - String!
data - String!
forceOverwrite - Boolean!

Example

Query
mutation rmWriteResourceStringContent(
  $projectId: String!,
  $resourcePath: String!,
  $data: String!,
  $forceOverwrite: Boolean!
) {
  rmWriteResourceStringContent(
    projectId: $projectId,
    resourcePath: $resourcePath,
    data: $data,
    forceOverwrite: $forceOverwrite
  )
}
Variables
{
  "projectId": "abc123",
  "resourcePath": "abc123",
  "data": "xyz789",
  "forceOverwrite": false
}
Response
{
  "data": {
    "rmWriteResourceStringContent": "xyz789"
  }
}

secretDeleteFromTeam

Description

Deletes a secret from a data source. Returns true if the deletion was successful.

Response

Returns a Boolean!

Arguments
Name Description
teamId - ID!
projectId - ID!
dataSourceId - ID!

Example

Query
mutation secretDeleteFromTeam(
  $teamId: ID!,
  $projectId: ID!,
  $dataSourceId: ID!
) {
  secretDeleteFromTeam(
    teamId: $teamId,
    projectId: $projectId,
    dataSourceId: $dataSourceId
  )
}
Variables
{
  "teamId": 4,
  "projectId": "4",
  "dataSourceId": "4"
}
Response
{"data": {"secretDeleteFromTeam": false}}

secretSetToTeam

Description

Sets a secret (credentials) for a data source in the specified project and team. Returns the secret information.

Response

Returns an AdminSecretInfo!

Arguments
Name Description
teamId - ID!
projectId - ID!
dataSourceId - ID!
credentials - Object

Example

Query
mutation secretSetToTeam(
  $teamId: ID!,
  $projectId: ID!,
  $dataSourceId: ID!,
  $credentials: Object
) {
  secretSetToTeam(
    teamId: $teamId,
    projectId: $projectId,
    dataSourceId: $dataSourceId,
    credentials: $credentials
  ) {
    subjectId
    authProperties {
      ...ObjectPropertyInfoFragment
    }
  }
}
Variables
{
  "teamId": "4",
  "projectId": "4",
  "dataSourceId": 4,
  "credentials": Object
}
Response
{
  "data": {
    "secretSetToTeam": {
      "subjectId": "4",
      "authProperties": [ObjectPropertyInfo]
    }
  }
}

setConnectionNavigatorSettings

Description

Change navigator settings for connection

Response

Returns a ConnectionInfo!

Arguments
Name Description
id - ID!
projectId - ID
settings - NavigatorSettingsInput!

Example

Query
mutation setConnectionNavigatorSettings(
  $id: ID!,
  $projectId: ID,
  $settings: NavigatorSettingsInput!
) {
  setConnectionNavigatorSettings(
    id: $id,
    projectId: $projectId,
    settings: $settings
  ) {
    id
    driverId
    name
    description
    host
    port
    serverName
    databaseName
    url
    mainPropertyValues
    keepAliveInterval
    autocommit
    properties
    connected
    provided
    readOnly
    useUrl
    saveCredentials
    sharedCredentials
    sharedSecrets {
      ...SecretInfoFragment
    }
    credentialsSaved
    authNeeded
    folder
    nodePath
    connectTime
    connectionError {
      ...ServerErrorFragment
    }
    serverVersion
    clientVersion
    origin {
      ...ObjectOriginFragment
    }
    authModel
    authProperties {
      ...ObjectPropertyInfoFragment
    }
    providerProperties
    networkHandlersConfig {
      ...NetworkHandlerConfigFragment
    }
    features
    navigatorSettings {
      ...NavigatorSettingsFragment
    }
    supportedDataFormats
    configurationType
    canViewSettings
    canEdit
    canDelete
    projectId
    requiredAuth
    defaultCatalogName
    defaultSchemaName
    tools
  }
}
Variables
{
  "id": 4,
  "projectId": 4,
  "settings": NavigatorSettingsInput
}
Response
{
  "data": {
    "setConnectionNavigatorSettings": {
      "id": 4,
      "driverId": 4,
      "name": "abc123",
      "description": "abc123",
      "host": "abc123",
      "port": "xyz789",
      "serverName": "abc123",
      "databaseName": "xyz789",
      "url": "abc123",
      "mainPropertyValues": Object,
      "keepAliveInterval": 987,
      "autocommit": true,
      "properties": Object,
      "connected": false,
      "provided": true,
      "readOnly": true,
      "useUrl": false,
      "saveCredentials": false,
      "sharedCredentials": false,
      "sharedSecrets": [SecretInfo],
      "credentialsSaved": true,
      "authNeeded": true,
      "folder": "4",
      "nodePath": "xyz789",
      "connectTime": "abc123",
      "connectionError": ServerError,
      "serverVersion": "abc123",
      "clientVersion": "abc123",
      "origin": ObjectOrigin,
      "authModel": "4",
      "authProperties": [ObjectPropertyInfo],
      "providerProperties": Object,
      "networkHandlersConfig": [NetworkHandlerConfig],
      "features": ["xyz789"],
      "navigatorSettings": NavigatorSettings,
      "supportedDataFormats": ["resultset"],
      "configurationType": "MANUAL",
      "canViewSettings": true,
      "canEdit": false,
      "canDelete": true,
      "projectId": "4",
      "requiredAuth": "abc123",
      "defaultCatalogName": "xyz789",
      "defaultSchemaName": "xyz789",
      "tools": ["xyz789"]
    }
  }
}

setUserConfigurationParameter

Description

Set user config parameter. If parameter value is null then removes the parameter

Response

Returns a Boolean!

Arguments
Name Description
name - String!
value - Object

Example

Query
mutation setUserConfigurationParameter(
  $name: String!,
  $value: Object
) {
  setUserConfigurationParameter(
    name: $name,
    value: $value
  )
}
Variables
{
  "name": "xyz789",
  "value": Object
}
Response
{"data": {"setUserConfigurationParameter": false}}

setUserPreferences

Description

Updates user preferences

Response

Returns a UserInfo!

Arguments
Name Description
preferences - Object!

Example

Query
mutation setUserPreferences($preferences: Object!) {
  setUserPreferences(preferences: $preferences) {
    userId
    displayName
    authRole
    authTokens {
      ...UserAuthTokenFragment
    }
    linkedAuthProviders
    metaParameters
    configurationParameters
    teams {
      ...UserTeamInfoFragment
    }
    isAnonymous
  }
}
Variables
{"preferences": Object}
Response
{
  "data": {
    "setUserPreferences": {
      "userId": 4,
      "displayName": "xyz789",
      "authRole": "4",
      "authTokens": [UserAuthToken],
      "linkedAuthProviders": ["abc123"],
      "metaParameters": Object,
      "configurationParameters": Object,
      "teams": [UserTeamInfo],
      "isAnonymous": false
    }
  }
}

sqlContextCreate

Description

Creates SQL context for the specified connection

Response

Returns an SQLContextInfo!

Arguments
Name Description
projectId - ID
connectionId - ID!
defaultCatalog - String
defaultSchema - String

Example

Query
mutation sqlContextCreate(
  $projectId: ID,
  $connectionId: ID!,
  $defaultCatalog: String,
  $defaultSchema: String
) {
  sqlContextCreate(
    projectId: $projectId,
    connectionId: $connectionId,
    defaultCatalog: $defaultCatalog,
    defaultSchema: $defaultSchema
  ) {
    id
    projectId
    connectionId
    autoCommit
    defaultCatalog
    defaultSchema
  }
}
Variables
{
  "projectId": "4",
  "connectionId": 4,
  "defaultCatalog": "xyz789",
  "defaultSchema": "xyz789"
}
Response
{
  "data": {
    "sqlContextCreate": {
      "id": "4",
      "projectId": 4,
      "connectionId": 4,
      "autoCommit": true,
      "defaultCatalog": "abc123",
      "defaultSchema": "xyz789"
    }
  }
}

sqlContextDestroy

Description

Destroys SQL context and closes all results

Response

Returns a Boolean!

Arguments
Name Description
projectId - ID
connectionId - ID!
contextId - ID!

Example

Query
mutation sqlContextDestroy(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!
) {
  sqlContextDestroy(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId
  )
}
Variables
{
  "projectId": 4,
  "connectionId": "4",
  "contextId": 4
}
Response
{"data": {"sqlContextDestroy": true}}

sqlContextSetDefaults

Description

Sets SQL context defaults

Response

Returns a Boolean!

Arguments
Name Description
projectId - ID
connectionId - ID!
contextId - ID!
defaultCatalog - ID
defaultSchema - ID

Example

Query
mutation sqlContextSetDefaults(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $defaultCatalog: ID,
  $defaultSchema: ID
) {
  sqlContextSetDefaults(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    defaultCatalog: $defaultCatalog,
    defaultSchema: $defaultSchema
  )
}
Variables
{
  "projectId": "4",
  "connectionId": 4,
  "contextId": "4",
  "defaultCatalog": "4",
  "defaultSchema": "4"
}
Response
{"data": {"sqlContextSetDefaults": false}}

sqlGetDynamicTrace

Description

Reads dynamic trace from provided database results

Response

Returns [DynamicTraceProperty!]!

Arguments
Name Description
projectId - ID
connectionId - ID!
contextId - ID!
resultsId - ID!

Example

Query
mutation sqlGetDynamicTrace(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $resultsId: ID!
) {
  sqlGetDynamicTrace(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    resultsId: $resultsId
  ) {
    name
    value
    description
  }
}
Variables
{
  "projectId": "4",
  "connectionId": "4",
  "contextId": "4",
  "resultsId": "4"
}
Response
{
  "data": {
    "sqlGetDynamicTrace": [
      {
        "name": "abc123",
        "value": "xyz789",
        "description": "xyz789"
      }
    ]
  }
}

sqlReadLobValue

Description

Returns BLOB value as Base64 encoded string

Response

Returns a String!

Arguments
Name Description
projectId - ID
connectionId - ID!
contextId - ID!
resultsId - ID!
lobColumnIndex - Int!
row - SQLResultRow!

Example

Query
mutation sqlReadLobValue(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $resultsId: ID!,
  $lobColumnIndex: Int!,
  $row: SQLResultRow!
) {
  sqlReadLobValue(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    resultsId: $resultsId,
    lobColumnIndex: $lobColumnIndex,
    row: $row
  )
}
Variables
{
  "projectId": 4,
  "connectionId": 4,
  "contextId": "4",
  "resultsId": "4",
  "lobColumnIndex": 987,
  "row": SQLResultRow
}
Response
{"data": {"sqlReadLobValue": "abc123"}}

sqlReadStringValue

Description

Returns full string value ignoring any limits

Response

Returns a String!

Arguments
Name Description
projectId - ID
connectionId - ID!
contextId - ID!
resultsId - ID!
columnIndex - Int!
row - SQLResultRow!

Example

Query
mutation sqlReadStringValue(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $resultsId: ID!,
  $columnIndex: Int!,
  $row: SQLResultRow!
) {
  sqlReadStringValue(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    resultsId: $resultsId,
    columnIndex: $columnIndex,
    row: $row
  )
}
Variables
{
  "projectId": 4,
  "connectionId": 4,
  "contextId": "4",
  "resultsId": "4",
  "columnIndex": 123,
  "row": SQLResultRow
}
Response
{"data": {"sqlReadStringValue": "abc123"}}

sqlResultClose

Description

Closes SQL results (free resources)

Response

Returns a Boolean!

Arguments
Name Description
projectId - ID
connectionId - ID!
contextId - ID!
resultId - ID!

Example

Query
mutation sqlResultClose(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $resultId: ID!
) {
  sqlResultClose(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    resultId: $resultId
  )
}
Variables
{
  "projectId": "4",
  "connectionId": "4",
  "contextId": "4",
  "resultId": "4"
}
Response
{"data": {"sqlResultClose": true}}

testConnection

Description

Test connection configuration. Returns remote server version

Response

Returns a ConnectionInfo!

Arguments
Name Description
config - ConnectionConfig!
projectId - ID

Example

Query
mutation testConnection(
  $config: ConnectionConfig!,
  $projectId: ID
) {
  testConnection(
    config: $config,
    projectId: $projectId
  ) {
    id
    driverId
    name
    description
    host
    port
    serverName
    databaseName
    url
    mainPropertyValues
    keepAliveInterval
    autocommit
    properties
    connected
    provided
    readOnly
    useUrl
    saveCredentials
    sharedCredentials
    sharedSecrets {
      ...SecretInfoFragment
    }
    credentialsSaved
    authNeeded
    folder
    nodePath
    connectTime
    connectionError {
      ...ServerErrorFragment
    }
    serverVersion
    clientVersion
    origin {
      ...ObjectOriginFragment
    }
    authModel
    authProperties {
      ...ObjectPropertyInfoFragment
    }
    providerProperties
    networkHandlersConfig {
      ...NetworkHandlerConfigFragment
    }
    features
    navigatorSettings {
      ...NavigatorSettingsFragment
    }
    supportedDataFormats
    configurationType
    canViewSettings
    canEdit
    canDelete
    projectId
    requiredAuth
    defaultCatalogName
    defaultSchemaName
    tools
  }
}
Variables
{"config": ConnectionConfig, "projectId": 4}
Response
{
  "data": {
    "testConnection": {
      "id": 4,
      "driverId": "4",
      "name": "abc123",
      "description": "xyz789",
      "host": "xyz789",
      "port": "xyz789",
      "serverName": "abc123",
      "databaseName": "xyz789",
      "url": "abc123",
      "mainPropertyValues": Object,
      "keepAliveInterval": 987,
      "autocommit": false,
      "properties": Object,
      "connected": false,
      "provided": true,
      "readOnly": true,
      "useUrl": false,
      "saveCredentials": false,
      "sharedCredentials": false,
      "sharedSecrets": [SecretInfo],
      "credentialsSaved": true,
      "authNeeded": false,
      "folder": "4",
      "nodePath": "abc123",
      "connectTime": "xyz789",
      "connectionError": ServerError,
      "serverVersion": "abc123",
      "clientVersion": "xyz789",
      "origin": ObjectOrigin,
      "authModel": "4",
      "authProperties": [ObjectPropertyInfo],
      "providerProperties": Object,
      "networkHandlersConfig": [NetworkHandlerConfig],
      "features": ["xyz789"],
      "navigatorSettings": NavigatorSettings,
      "supportedDataFormats": ["resultset"],
      "configurationType": "MANUAL",
      "canViewSettings": false,
      "canEdit": false,
      "canDelete": false,
      "projectId": "4",
      "requiredAuth": "xyz789",
      "defaultCatalogName": "xyz789",
      "defaultSchemaName": "abc123",
      "tools": ["abc123"]
    }
  }
}

testNetworkHandler

Description

Test network handler

Response

Returns a NetworkEndpointInfo!

Arguments
Name Description
config - NetworkHandlerConfigInput!

Example

Query
mutation testNetworkHandler($config: NetworkHandlerConfigInput!) {
  testNetworkHandler(config: $config) {
    message
    clientVersion
    serverVersion
  }
}
Variables
{"config": NetworkHandlerConfigInput}
Response
{
  "data": {
    "testNetworkHandler": {
      "message": "xyz789",
      "clientVersion": "xyz789",
      "serverVersion": "abc123"
    }
  }
}

tokenApiCreate

Description

Creates API token for user. If periodDays is not specified, token will not expire

Response

Returns an APIFullTokenInfo!

Arguments
Name Description
tokenName - String!
periodDays - Int

Example

Query
mutation tokenApiCreate(
  $tokenName: String!,
  $periodDays: Int
) {
  tokenApiCreate(
    tokenName: $tokenName,
    periodDays: $periodDays
  ) {
    tokenName
    token
    createTime
    expireTime
  }
}
Variables
{"tokenName": "abc123", "periodDays": 123}
Response
{
  "data": {
    "tokenApiCreate": {
      "tokenName": "abc123",
      "token": "xyz789",
      "createTime": "2007-12-03",
      "expireTime": "2007-12-03"
    }
  }
}

tokenApiDelete

Description

Deletes API token for user based on its name

Response

Returns a Boolean!

Arguments
Name Description
tokenName - String!

Example

Query
mutation tokenApiDelete($tokenName: String!) {
  tokenApiDelete(tokenName: $tokenName)
}
Variables
{"tokenName": "abc123"}
Response
{"data": {"tokenApiDelete": false}}

touchSession

use events to update session
Description

Refreshes session on server and returns its state

Response

Returns a Boolean

Example

Query
mutation touchSession {
  touchSession
}
Response
{"data": {"touchSession": false}}

updateConnection

Description

Update specified connection

Response

Returns a ConnectionInfo!

Arguments
Name Description
config - ConnectionConfig!
projectId - ID

Example

Query
mutation updateConnection(
  $config: ConnectionConfig!,
  $projectId: ID
) {
  updateConnection(
    config: $config,
    projectId: $projectId
  ) {
    id
    driverId
    name
    description
    host
    port
    serverName
    databaseName
    url
    mainPropertyValues
    keepAliveInterval
    autocommit
    properties
    connected
    provided
    readOnly
    useUrl
    saveCredentials
    sharedCredentials
    sharedSecrets {
      ...SecretInfoFragment
    }
    credentialsSaved
    authNeeded
    folder
    nodePath
    connectTime
    connectionError {
      ...ServerErrorFragment
    }
    serverVersion
    clientVersion
    origin {
      ...ObjectOriginFragment
    }
    authModel
    authProperties {
      ...ObjectPropertyInfoFragment
    }
    providerProperties
    networkHandlersConfig {
      ...NetworkHandlerConfigFragment
    }
    features
    navigatorSettings {
      ...NavigatorSettingsFragment
    }
    supportedDataFormats
    configurationType
    canViewSettings
    canEdit
    canDelete
    projectId
    requiredAuth
    defaultCatalogName
    defaultSchemaName
    tools
  }
}
Variables
{"config": ConnectionConfig, "projectId": 4}
Response
{
  "data": {
    "updateConnection": {
      "id": "4",
      "driverId": 4,
      "name": "xyz789",
      "description": "xyz789",
      "host": "xyz789",
      "port": "xyz789",
      "serverName": "abc123",
      "databaseName": "abc123",
      "url": "xyz789",
      "mainPropertyValues": Object,
      "keepAliveInterval": 987,
      "autocommit": false,
      "properties": Object,
      "connected": false,
      "provided": false,
      "readOnly": false,
      "useUrl": true,
      "saveCredentials": false,
      "sharedCredentials": false,
      "sharedSecrets": [SecretInfo],
      "credentialsSaved": true,
      "authNeeded": false,
      "folder": 4,
      "nodePath": "xyz789",
      "connectTime": "xyz789",
      "connectionError": ServerError,
      "serverVersion": "abc123",
      "clientVersion": "xyz789",
      "origin": ObjectOrigin,
      "authModel": 4,
      "authProperties": [ObjectPropertyInfo],
      "providerProperties": Object,
      "networkHandlersConfig": [NetworkHandlerConfig],
      "features": ["xyz789"],
      "navigatorSettings": NavigatorSettings,
      "supportedDataFormats": ["resultset"],
      "configurationType": "MANUAL",
      "canViewSettings": true,
      "canEdit": false,
      "canDelete": false,
      "projectId": "4",
      "requiredAuth": "abc123",
      "defaultCatalogName": "abc123",
      "defaultSchemaName": "abc123",
      "tools": ["abc123"]
    }
  }
}

updateDriver

Description

Updates an existing driver with the provided configuration.

Response

Returns a DriverInfo!

Arguments
Name Description
config - DriverConfig!

Example

Query
mutation updateDriver($config: DriverConfig!) {
  updateDriver(config: $config) {
    id
    name
    description
    icon
    iconBig
    driverId
    providerId
    driverClassName
    defaultHost
    defaultPort
    defaultDatabase
    defaultServer
    defaultUser
    sampleURL
    driverInfoURL
    driverPropertiesURL
    embedded
    enabled
    requiresServerName
    requiresDatabaseName
    useCustomPage
    licenseRequired
    license
    custom
    promotedScore
    driverProperties {
      ...ObjectPropertyInfoFragment
    }
    driverParameters
    mainProperties {
      ...ObjectPropertyInfoFragment
    }
    providerProperties {
      ...ObjectPropertyInfoFragment
    }
    anonymousAccess
    defaultAuthModel
    applicableAuthModels
    applicableNetworkHandlers
    configurationTypes
    downloadable
    driverInstalled
    driverLibraries {
      ...DriverLibraryInfoFragment
    }
    safeEmbeddedDriver
  }
}
Variables
{"config": DriverConfig}
Response
{
  "data": {
    "updateDriver": {
      "id": 4,
      "name": "xyz789",
      "description": "xyz789",
      "icon": "abc123",
      "iconBig": "abc123",
      "driverId": 4,
      "providerId": "4",
      "driverClassName": "xyz789",
      "defaultHost": "xyz789",
      "defaultPort": "abc123",
      "defaultDatabase": "abc123",
      "defaultServer": "abc123",
      "defaultUser": "xyz789",
      "sampleURL": "xyz789",
      "driverInfoURL": "xyz789",
      "driverPropertiesURL": "abc123",
      "embedded": false,
      "enabled": false,
      "requiresServerName": true,
      "requiresDatabaseName": true,
      "useCustomPage": true,
      "licenseRequired": false,
      "license": "abc123",
      "custom": true,
      "promotedScore": 123,
      "driverProperties": [ObjectPropertyInfo],
      "driverParameters": Object,
      "mainProperties": [ObjectPropertyInfo],
      "providerProperties": [ObjectPropertyInfo],
      "anonymousAccess": false,
      "defaultAuthModel": "4",
      "applicableAuthModels": [4],
      "applicableNetworkHandlers": [4],
      "configurationTypes": ["MANUAL"],
      "downloadable": false,
      "driverInstalled": false,
      "driverLibraries": [DriverLibraryInfo],
      "safeEmbeddedDriver": false
    }
  }
}

updateResultsDataBatch

use async function (25.0.0)
Description

Synchronously updates results data in batch mode

Response

Returns an SQLExecuteInfo!

Arguments
Name Description
projectId - ID
connectionId - ID!
contextId - ID!
resultsId - ID!
updatedRows - [SQLResultRow!]
deletedRows - [SQLResultRow!]
addedRows - [SQLResultRow!]

Example

Query
mutation updateResultsDataBatch(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $resultsId: ID!,
  $updatedRows: [SQLResultRow!],
  $deletedRows: [SQLResultRow!],
  $addedRows: [SQLResultRow!]
) {
  updateResultsDataBatch(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    resultsId: $resultsId,
    updatedRows: $updatedRows,
    deletedRows: $deletedRows,
    addedRows: $addedRows
  ) {
    statusMessage
    duration
    filterText
    fullQuery
    results {
      ...SQLQueryResultsFragment
    }
  }
}
Variables
{
  "projectId": "4",
  "connectionId": 4,
  "contextId": 4,
  "resultsId": 4,
  "updatedRows": [SQLResultRow],
  "deletedRows": [SQLResultRow],
  "addedRows": [SQLResultRow]
}
Response
{
  "data": {
    "updateResultsDataBatch": {
      "statusMessage": "abc123",
      "duration": 123,
      "filterText": "xyz789",
      "fullQuery": "xyz789",
      "results": [SQLQueryResults]
    }
  }
}

updateResultsDataBatchScript

Description

Returns SQL script for cell values update

Response

Returns a String!

Arguments
Name Description
projectId - ID
connectionId - ID!
contextId - ID!
resultsId - ID!
updatedRows - [SQLResultRow!]
deletedRows - [SQLResultRow!]
addedRows - [SQLResultRow!]

Example

Query
mutation updateResultsDataBatchScript(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $resultsId: ID!,
  $updatedRows: [SQLResultRow!],
  $deletedRows: [SQLResultRow!],
  $addedRows: [SQLResultRow!]
) {
  updateResultsDataBatchScript(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    resultsId: $resultsId,
    updatedRows: $updatedRows,
    deletedRows: $deletedRows,
    addedRows: $addedRows
  )
}
Variables
{
  "projectId": "4",
  "connectionId": 4,
  "contextId": "4",
  "resultsId": "4",
  "updatedRows": [SQLResultRow],
  "deletedRows": [SQLResultRow],
  "addedRows": [SQLResultRow]
}
Response
{
  "data": {
    "updateResultsDataBatchScript": "xyz789"
  }
}

updateSession

use events to update session
Description

Refreshes session on server and returns session state

Response

Returns a SessionInfo!

Example

Query
mutation updateSession {
  updateSession {
    createTime
    lastAccessTime
    locale
    cacheExpired
    connections {
      ...ConnectionInfoFragment
    }
    actionParameters
    valid
    remainingTime
  }
}
Response
{
  "data": {
    "updateSession": {
      "createTime": "xyz789",
      "lastAccessTime": "xyz789",
      "locale": "xyz789",
      "cacheExpired": true,
      "connections": [ConnectionInfo],
      "actionParameters": Object,
      "valid": false,
      "remainingTime": 987
    }
  }
}

vqbFakeFunction

Response

Returns an Object

Example

Query
mutation vqbFakeFunction {
  vqbFakeFunction
}
Response
{"data": {"vqbFakeFunction": Object}}

Types

AIChatConversationInfo

Fields
Field Name Description
dataSourceId - DataSourceId
id - ID!
caption - String!
time - DateTime!
messages - [AIMessage!]!
settings - AIChatConversationSettings
Example
{
  "dataSourceId": DataSourceId,
  "id": "4",
  "caption": "xyz789",
  "time": "2007-12-03T10:15:30Z",
  "messages": [AIMessage],
  "settings": AIChatConversationSettings
}

AIChatConversationInput

Fields
Input Field Description
dataSourceId - DataSourceIdInput
caption - String
settings - AIChatConversationSettingsInput
Example
{
  "dataSourceId": DataSourceIdInput,
  "caption": "abc123",
  "settings": AIChatConversationSettingsInput
}

AIChatConversationSettings

Fields
Field Name Description
metaTransferConfirmed - Boolean!
scope - AIDatabaseScope
customObjectIds - [ID!] If the scope is set to CUSTOM, this field is required.
Example
{
  "metaTransferConfirmed": true,
  "scope": "CURRENT_SCHEMA",
  "customObjectIds": ["4"]
}

AIChatConversationSettingsInput

Fields
Input Field Description
metaTransferConfirmed - Boolean
scope - AIDatabaseScope
customObjectIds - [ID!]
Example
{
  "metaTransferConfirmed": false,
  "scope": "CURRENT_SCHEMA",
  "customObjectIds": [4]
}

AIDatabaseScope

Description

Scope of the AI chat conversation. Can be a database connection, a current database, a current schema or a custom scope.

Values
Enum Value Description

CURRENT_SCHEMA

CURRENT_DATABASE

CURRENT_DATASOURCE

CUSTOM

Example
"CURRENT_SCHEMA"

AIEngineConfig

Fields
Input Field Description
properties - Object
Example
{"properties": Object}

AIEngineInfo

Fields
Field Name Description
id - ID! Unique identifier of the AI engine.
name - String! Name of the AI engine.
Example
{
  "id": "4",
  "name": "xyz789"
}

AIMessage

Fields
Field Name Description
conversationId - ID!
id - ID!
role - AIMessageType!
content - String!
displayMessage - String!
time - DateTime!
Example
{
  "conversationId": "4",
  "id": 4,
  "role": "SYSTEM",
  "content": "abc123",
  "displayMessage": "xyz789",
  "time": "2007-12-03T10:15:30Z"
}

AIMessageType

Description

AI admin queries

Values
Enum Value Description

SYSTEM

USER

ASSISTANT

ERROR

Example
"SYSTEM"

AISendChatMessageInfo

Fields
Field Name Description
conversation - AIChatConversationInfo!
userMessage - AIMessage!
assistantMessage - AIMessage! Message that would be received via websockets.
Example
{
  "conversation": AIChatConversationInfo,
  "userMessage": AIMessage,
  "assistantMessage": AIMessage
}

AISettingsConfig

Fields
Input Field Description
activeEngine - ID!
Example
{"activeEngine": "4"}

AISettingsInfo

Fields
Field Name Description
activeEngine - ID!
Example
{"activeEngine": "4"}

APIFullTokenInfo

Fields
Field Name Description
tokenName - String!
token - String!
createTime - Date!
expireTime - Date
Example
{
  "tokenName": "xyz789",
  "token": "abc123",
  "createTime": "2007-12-03",
  "expireTime": "2007-12-03"
}

APITokenInfo

Fields
Field Name Description
tokenName - String!
createTime - Date!
expireTime - Date
Example
{
  "tokenName": "xyz789",
  "createTime": "2007-12-03",
  "expireTime": "2007-12-03"
}

AWSConfiguration

Fields
Field Name Description
cloudId - String! Unique identifier of the AWS cloud configuration.
cloudName - String! Name of the AWS cloud configuration.
allowedAccounts - [String!]! List of AWS account ids that are allowed to access the AWS cloud configuration.
regions - [String!] List of AWS regions that are allowed to access the AWS cloud configuration.
federatedAccessEnabled - Boolean! Indicates if federated access is enabled for the AWS cloud configuration.
govRegionsEnabled - Boolean! Indicates if AWS GovCloud regions are enabled for the AWS cloud configuration.
proxyUser - AWSUserInfo
useDefaultCredentials - Boolean! Indicates if the default AWS credentials are used for the AWS cloud configuration.
assumeRoleName - String The role name to assume for global credentials.
Example
{
  "cloudId": "xyz789",
  "cloudName": "abc123",
  "allowedAccounts": ["abc123"],
  "regions": ["abc123"],
  "federatedAccessEnabled": true,
  "govRegionsEnabled": true,
  "proxyUser": AWSUserInfo,
  "useDefaultCredentials": false,
  "assumeRoleName": "xyz789"
}

AWSConfigurationInput

Fields
Input Field Description
regions - [String!]
credentials - AWSCredentialsConfigurationInput
Example
{
  "regions": ["abc123"],
  "credentials": AWSCredentialsConfigurationInput
}

AWSCredentialsConfigurationInput

Fields
Input Field Description
useDefaultCredentials - Boolean Enable using default credentials from AWS machine (e.g., IAM role on EC2 instance).
assumeRoleName - String The role name to assume for global credentials.
Example
{
  "useDefaultCredentials": false,
  "assumeRoleName": "abc123"
}

AWSInstallConfigurationInput

Fields
Input Field Description
agreementId - ID
Example
{"agreementId": 4}

AWSInstallInfo

Fields
Field Name Description
instanceId - String
instanceType - String
instanceRole - String
accountId - String
version - String
marketplaceProductCodes - [String!]
amiId - String
agreementId - String
defaultRegion - String
accountRegions - [String!] use regions from AWSConfiguration (24.3.1)
Example
{
  "instanceId": "abc123",
  "instanceType": "xyz789",
  "instanceRole": "xyz789",
  "accountId": "abc123",
  "version": "xyz789",
  "marketplaceProductCodes": ["xyz789"],
  "amiId": "xyz789",
  "agreementId": "xyz789",
  "defaultRegion": "abc123",
  "accountRegions": ["xyz789"]
}

AWSPartition

Fields
Field Name Description
id - ID!
name - String!
Example
{
  "id": "4",
  "name": "xyz789"
}

AWSRegion

Fields
Field Name Description
id - String! Unique identifier of the region, such as 'us-east-1', 'eu-west-1', etc.
displayName - String Name of the region, such as 'US East (N. Virginia)', 'EU (Ireland)', etc.
superRegion - String Returns the region group, such as Europe, Asia Pacific, etc.
global - Boolean! Indicates if the region is global or not. Global regions are used for AWS services that are not region-specific, such as IAM.
partition - String! Returns the partition ID of the region, such as 'aws', 'aws-cn', or 'aws-us-gov'.
domain - String
Example
{
  "id": "abc123",
  "displayName": "abc123",
  "superRegion": "xyz789",
  "global": true,
  "partition": "xyz789",
  "domain": "abc123"
}

AWSTag

Fields
Field Name Description
name - String!
value - String
Example
{
  "name": "abc123",
  "value": "xyz789"
}

AWSUserInfo

Fields
Field Name Description
userId - String
userName - String
userPath - String
userArn - String
accountId - String
organizationName - String
createDate - DateTime
tags - [AWSTag!]
Example
{
  "userId": "xyz789",
  "userName": "abc123",
  "userPath": "xyz789",
  "userArn": "xyz789",
  "accountId": "xyz789",
  "organizationName": "abc123",
  "createDate": "2007-12-03T10:15:30Z",
  "tags": [AWSTag]
}

AdminAuthProviderConfiguration

Fields
Field Name Description
providerId - ID!
id - ID!
displayName - String!
disabled - Boolean!
iconURL - String
description - String
parameters - Object!
signInLink - String
signOutLink - String
redirectLink - String
metadataLink - String
acsLink - String
entityIdLink - String
Example
{
  "providerId": 4,
  "id": 4,
  "displayName": "xyz789",
  "disabled": true,
  "iconURL": "abc123",
  "description": "xyz789",
  "parameters": Object,
  "signInLink": "abc123",
  "signOutLink": "xyz789",
  "redirectLink": "xyz789",
  "metadataLink": "abc123",
  "acsLink": "abc123",
  "entityIdLink": "abc123"
}

AdminConnectionGrantInfo

Fields
Field Name Description
connectionId - ID! use dataSourceId instead
dataSourceId - ID!
subjectId - ID!
subjectType - AdminSubjectType!
Example
{
  "connectionId": 4,
  "dataSourceId": 4,
  "subjectId": "4",
  "subjectType": "user"
}

AdminConnectionSearchInfo

Fields
Field Name Description
displayName - String!
host - String!
port - Int!
possibleDrivers - [ID!]!
defaultDriver - ID!
Example
{
  "displayName": "xyz789",
  "host": "abc123",
  "port": 123,
  "possibleDrivers": ["4"],
  "defaultDriver": 4
}

AdminObjectGrantInfo

Fields
Field Name Description
subjectId - ID!
subjectType - AdminSubjectType!
objectPermissions - AdminObjectPermissions!
Example
{
  "subjectId": 4,
  "subjectType": "user",
  "objectPermissions": AdminObjectPermissions
}

AdminObjectPermissions

Fields
Field Name Description
objectId - ID!
permissions - [String!]!
Example
{
  "objectId": "4",
  "permissions": ["xyz789"]
}

AdminPermissionInfo

Fields
Field Name Description
id - ID!
label - String
description - String
provider - String!
category - String
Example
{
  "id": "4",
  "label": "xyz789",
  "description": "abc123",
  "provider": "xyz789",
  "category": "xyz789"
}

AdminSecretInfo

Description

Information about a secret (credentials) for a data source.

Fields
Field Name Description
subjectId - ID! ID of the subject (user or team) that owns the secret.
authProperties - [ObjectPropertyInfo!]! List of properties that contain the secret information.
Example
{"subjectId": 4, "authProperties": [ObjectPropertyInfo]}

AdminSubjectType

Values
Enum Value Description

user

team

Example
"user"

AdminTeamInfo

Fields
Field Name Description
teamId - ID!
teamName - String
description - String
metaParameters - Object!
grantedUsers - [ID!]!
grantedUsersInfo - [AdminUserTeamGrantInfo!]!
grantedConnections - [AdminConnectionGrantInfo!]!
teamPermissions - [ID!]!
Example
{
  "teamId": "4",
  "teamName": "xyz789",
  "description": "xyz789",
  "metaParameters": Object,
  "grantedUsers": [4],
  "grantedUsersInfo": [AdminUserTeamGrantInfo],
  "grantedConnections": [AdminConnectionGrantInfo],
  "teamPermissions": ["4"]
}

AdminUserFilterInput

Fields
Input Field Description
userIdMask - String
enabledState - Boolean
Example
{
  "userIdMask": "xyz789",
  "enabledState": false
}

AdminUserInfo

Fields
Field Name Description
userId - ID!
metaParameters - Object!
configurationParameters - Object!
grantedTeams - [ID!]!
grantedConnections - [AdminConnectionGrantInfo!]!
origins - [ObjectOrigin!]!
linkedAuthProviders - [String!]!
enabled - Boolean!
authRole - String
disableDate - DateTime
disabledBy - String
disableReason - String
Example
{
  "userId": 4,
  "metaParameters": Object,
  "configurationParameters": Object,
  "grantedTeams": ["4"],
  "grantedConnections": [AdminConnectionGrantInfo],
  "origins": [ObjectOrigin],
  "linkedAuthProviders": ["abc123"],
  "enabled": false,
  "authRole": "abc123",
  "disableDate": "2007-12-03T10:15:30Z",
  "disabledBy": "xyz789",
  "disableReason": "abc123"
}

AdminUserTeamGrantInfo

Fields
Field Name Description
userId - ID!
teamRole - String
Example
{"userId": 4, "teamRole": "abc123"}

AsyncTaskInfo

Description

Async types

Fields
Field Name Description
id - String! Task unique identifier
name - String Async task name
running - Boolean! Indicates if the task is currently running
status - String Current status of the async task
error - ServerError Error information if the task failed
taskResult - Object Task result. Can be some kind of identifier to obtain real result using another API function
Example
{
  "id": "abc123",
  "name": "xyz789",
  "running": true,
  "status": "xyz789",
  "error": ServerError,
  "taskResult": Object
}

AuthCredentialEncryption

Values
Enum Value Description

none

plain

hash

Example
"none"

AuthCredentialInfo

Fields
Field Name Description
id - ID!
displayName - String!
description - String
admin - Boolean! This field must be shown in admin panel
user - Boolean! This field must be shown in login form
identifying - Boolean!
possibleValues - [String]
encryption - AuthCredentialEncryption
Example
{
  "id": 4,
  "displayName": "xyz789",
  "description": "xyz789",
  "admin": false,
  "user": false,
  "identifying": false,
  "possibleValues": ["xyz789"],
  "encryption": "none"
}

AuthInfo

Fields
Field Name Description
redirectLink - String No longer supported
authId - String No longer supported
authStatus - AuthStatus! No longer supported
userTokens - [UserAuthToken!]
Example
{
  "redirectLink": "xyz789",
  "authId": "xyz789",
  "authStatus": "SUCCESS",
  "userTokens": [UserAuthToken]
}

AuthProviderConfiguration

Fields
Field Name Description
id - ID!
displayName - String!
disabled - Boolean!
authRoleProvided - Boolean
iconURL - String
description - String
signInLink - String URL to external authentication service. If specified then it is external authentication provider (SSO). Otherwise authLogin function must be called.
signOutLink - String
redirectLink - String
metadataLink - String
acsLink - String
entityIdLink - String
Example
{
  "id": "4",
  "displayName": "xyz789",
  "disabled": false,
  "authRoleProvided": true,
  "iconURL": "abc123",
  "description": "xyz789",
  "signInLink": "xyz789",
  "signOutLink": "xyz789",
  "redirectLink": "abc123",
  "metadataLink": "xyz789",
  "acsLink": "abc123",
  "entityIdLink": "xyz789"
}

AuthProviderCredentialsProfile

Fields
Field Name Description
id - String
label - String
description - String
credentialParameters - [AuthCredentialInfo!]!
Example
{
  "id": "abc123",
  "label": "abc123",
  "description": "abc123",
  "credentialParameters": [AuthCredentialInfo]
}

AuthProviderInfo

Fields
Field Name Description
id - ID!
label - String!
icon - ID
description - String
defaultProvider - Boolean!
trusted - Boolean!
private - Boolean!
authHidden - Boolean!
supportProvisioning - Boolean!
configurable - Boolean! Configurable providers must be configured first. See configurations field.
federated - Boolean! Federated providers means authorization must occur asynchronously through redirects.
configurations - [AuthProviderConfiguration!] Provider configurations (applicable only if configurable=true)
templateConfiguration - AuthProviderConfiguration!
credentialProfiles - [AuthProviderCredentialsProfile!]!
requiredFeatures - [String!]!
required - Boolean!
Example
{
  "id": 4,
  "label": "abc123",
  "icon": 4,
  "description": "abc123",
  "defaultProvider": false,
  "trusted": true,
  "private": true,
  "authHidden": true,
  "supportProvisioning": false,
  "configurable": true,
  "federated": false,
  "configurations": [AuthProviderConfiguration],
  "templateConfiguration": AuthProviderConfiguration,
  "credentialProfiles": [AuthProviderCredentialsProfile],
  "requiredFeatures": ["abc123"],
  "required": false
}

AuthStatus

Values
Enum Value Description

SUCCESS

IN_PROGRESS

ERROR

Example
"SUCCESS"

Boolean

Description

The Boolean scalar type represents true or false.

CBCloud

Fields
Field Name Description
id - String! Unique identifier of the cloud.
name - String! Display name of the cloud.
authProvider - String! Auth provider ID used for the cloud (see AuthProviderInfo).
Example
{
  "id": "xyz789",
  "name": "xyz789",
  "authProvider": "xyz789"
}

Condition

Description

Represents a dynamic condition for a property, such as visibility or read-only state

Fields
Field Name Description
expression - String! The logical expression that defines when the condition applies
conditionType - ConditionType! The type of condition (e.g., HIDE or READ_ONLY)
Example
{
  "expression": "abc123",
  "conditionType": "HIDE"
}

ConditionType

Values
Enum Value Description

HIDE

hiding property condition

READ_ONLY

restriction for setting a property value
Example
"HIDE"

ConnectionConfig

Description

Configuration of particular connection. Used for new connection create. Includes auth info

Fields
Input Field Description
externalParameters - ExternalParameters
connectionId - String used only for testing created connection
name - String
description - String
driverId - ID ID of database driver
host - String Custom connection parameters (all optional)
port - String
serverName - String
databaseName - String
mainPropertyValues - Object Host, port, serverName, databaseName are also stored in mainPropertyValues for custom pages
url - String Sets connection URL jdbc:{driver}://{host}[:{port}]/[{database}]
properties - Object Set properties list
keepAliveInterval - Int Set keep-alive interval
autocommit - Boolean Sets auto-commit connection state
readOnly - Boolean Sets read-only connection state
saveCredentials - Boolean Flag for saving credentials in secure storage
sharedCredentials - Boolean Flag for using shared credentials.
authModelId - ID Auth model ID that will be used for connection
selectedSecretId - ID Secret ID that will be used for connection
credentials - Object Credentials for the connection (usually user name and password but it may vary for different auth models)
providerProperties - Object Returns map of provider properties (name/value)
networkHandlersConfig - [NetworkHandlerConfigInput!] Returns network handlers configuration. Map of id->property map (name/value).
folder - ID Defines in which connection folder the connection should be created
configurationType - DriverConfigurationType Configuration type (MANUAL, URL)
defaultCatalogName - String Sets catalog name for the connection
defaultSchemaName - String Sets schema name for the connection
Example
{
  "externalParameters": ExternalParameters,
  "connectionId": "abc123",
  "name": "abc123",
  "description": "abc123",
  "driverId": "4",
  "host": "abc123",
  "port": "xyz789",
  "serverName": "abc123",
  "databaseName": "xyz789",
  "mainPropertyValues": Object,
  "url": "xyz789",
  "properties": Object,
  "keepAliveInterval": 987,
  "autocommit": true,
  "readOnly": true,
  "saveCredentials": false,
  "sharedCredentials": false,
  "authModelId": 4,
  "selectedSecretId": 4,
  "credentials": Object,
  "providerProperties": Object,
  "networkHandlersConfig": [NetworkHandlerConfigInput],
  "folder": "4",
  "configurationType": "MANUAL",
  "defaultCatalogName": "abc123",
  "defaultSchemaName": "xyz789"
}

ConnectionFolderInfo

Fields
Field Name Description
id - ID!
projectId - ID!
description - String
Example
{
  "id": "4",
  "projectId": "4",
  "description": "abc123"
}

ConnectionInfo

Description

Connection instance

Fields
Field Name Description
id - ID! Connection unique ID
driverId - ID! ID of the driver that is used for this connection (see DriverInfo)
name - String! Connection name
description - String Connection description
host - String
port - String
serverName - String
databaseName - String
url - String
mainPropertyValues - Object Main connection properties. Contains host, port, database, server name fields
keepAliveInterval - Int! Connection keep-alive interval in seconds
autocommit - Boolean Defines if the connection is in auto-commit mode
properties - Object
connected - Boolean! Indicates if the connection is already connected to the database
provided - Boolean!
readOnly - Boolean! Indicates if the connection is read-only (no data modification allowed)
useUrl - Boolean! Forces connection URL use, host/port/database parameters will be ignored
saveCredentials - Boolean! Forces credentials save. This flag doesn't work in shared projects.
sharedCredentials - Boolean! Shared credentials - the same for all users, stored in secure storage.
sharedSecrets - [SecretInfo!]!
credentialsSaved - Boolean! Determines that credentials were saved for current user. This field read is slow, it should be read only when it really needed
authNeeded - Boolean! Determines that additional credentials are needed to connect This field read is slow, it should be read only when it really needed
folder - ID ID of the connection folder where this connection is stored
nodePath - String Node path of the connection in the navigator
connectTime - String Connection time in ISO format
connectionError - ServerError Connection error if any
serverVersion - String Server version that is used for this connection
clientVersion - String Client version that is used for this connection
origin - ObjectOrigin!
authModel - ID ID of the auth model that is used for this connection (see authModels)
authProperties - [ObjectPropertyInfo!]!
providerProperties - Object!
networkHandlersConfig - [NetworkHandlerConfig!]!
features - [String!]! Supported features (provided etc)
navigatorSettings - NavigatorSettings!
supportedDataFormats - [ResultDataFormat!]!
configurationType - DriverConfigurationType
canViewSettings - Boolean! Access properties
canEdit - Boolean!
canDelete - Boolean!
projectId - ID!
requiredAuth - String
defaultCatalogName - String
defaultSchemaName - String
tools - [String!]! List of tools that can be used with this connection. Returns empty list if no tools are available
Example
{
  "id": "4",
  "driverId": 4,
  "name": "abc123",
  "description": "abc123",
  "host": "xyz789",
  "port": "abc123",
  "serverName": "xyz789",
  "databaseName": "xyz789",
  "url": "xyz789",
  "mainPropertyValues": Object,
  "keepAliveInterval": 987,
  "autocommit": true,
  "properties": Object,
  "connected": true,
  "provided": false,
  "readOnly": false,
  "useUrl": true,
  "saveCredentials": false,
  "sharedCredentials": true,
  "sharedSecrets": [SecretInfo],
  "credentialsSaved": false,
  "authNeeded": true,
  "folder": "4",
  "nodePath": "abc123",
  "connectTime": "xyz789",
  "connectionError": ServerError,
  "serverVersion": "xyz789",
  "clientVersion": "abc123",
  "origin": ObjectOrigin,
  "authModel": 4,
  "authProperties": [ObjectPropertyInfo],
  "providerProperties": Object,
  "networkHandlersConfig": [NetworkHandlerConfig],
  "features": ["abc123"],
  "navigatorSettings": NavigatorSettings,
  "supportedDataFormats": ["resultset"],
  "configurationType": "MANUAL",
  "canViewSettings": true,
  "canEdit": false,
  "canDelete": true,
  "projectId": 4,
  "requiredAuth": "xyz789",
  "defaultCatalogName": "xyz789",
  "defaultSchemaName": "xyz789",
  "tools": ["abc123"]
}

CustomCertificateConfig

Fields
Input Field Description
domainName - String!
certificate - String!
privateKey - String!
certificateChain - String
Example
{
  "domainName": "xyz789",
  "certificate": "xyz789",
  "privateKey": "xyz789",
  "certificateChain": "abc123"
}

DataSetConfig

Fields
Input Field Description
displayName - String!
description - String
draft - Boolean
queries - [DataSetQueryConfig!]!
Example
{
  "displayName": "xyz789",
  "description": "abc123",
  "draft": true,
  "queries": [DataSetQueryConfig]
}

DataSetInfo

Fields
Field Name Description
displayName - String!
description - String
draft - Boolean!
queries - [DataSetQueryInfo!]!
datasetPath - String!
projectId - ID!
Example
{
  "displayName": "abc123",
  "description": "xyz789",
  "draft": true,
  "queries": [DataSetQueryInfo],
  "datasetPath": "abc123",
  "projectId": "4"
}

DataSetQueryConfig

Fields
Input Field Description
id - String
description - String
datasourceId - ID!
catalog - String
schema - String
queryText - String!
dataFilter - SQLDataFilter
Example
{
  "id": "abc123",
  "description": "xyz789",
  "datasourceId": 4,
  "catalog": "abc123",
  "schema": "abc123",
  "queryText": "abc123",
  "dataFilter": SQLDataFilter
}

DataSetQueryInfo

Fields
Field Name Description
id - String!
queryText - String!
datasourceId - String!
description - String
catalog - String
schema - String
dataFilter - SQLDataFilterInfo
Example
{
  "id": "abc123",
  "queryText": "abc123",
  "datasourceId": "xyz789",
  "description": "abc123",
  "catalog": "abc123",
  "schema": "xyz789",
  "dataFilter": SQLDataFilterInfo
}

DataSourceId

Fields
Field Name Description
projectId - ID!
connectionId - ID!
Example
{"projectId": "4", "connectionId": 4}

DataSourceIdInput

Fields
Input Field Description
projectId - ID!
connectionId - ID!
Example
{"projectId": "4", "connectionId": 4}

DataSourceSessionInfo

Fields
Field Name Description
activeQuery - String Active query for the session.
properties - [ObjectPropertyInfo!] Returns list of properties for the session that can be used in the UI.
sessionId - String! Identifier of the database session.
Example
{
  "activeQuery": "abc123",
  "properties": [ObjectPropertyInfo],
  "sessionId": "xyz789"
}

DataTransferDefaultExportSettings

Fields
Field Name Description
outputSettings - DataTransferOutputSettings!
supportedEncodings - [String!]!
Example
{
  "outputSettings": DataTransferOutputSettings,
  "supportedEncodings": ["xyz789"]
}

DataTransferOutputSettings

Fields
Field Name Description
insertBom - Boolean!
encoding - String!
timestampPattern - String!
compress - Boolean!
Example
{
  "insertBom": false,
  "encoding": "xyz789",
  "timestampPattern": "xyz789",
  "compress": true
}

DataTransferOutputSettingsInput

Fields
Input Field Description
insertBom - Boolean
encoding - String
timestampPattern - String
compress - Boolean
fileName - String
Example
{
  "insertBom": false,
  "encoding": "xyz789",
  "timestampPattern": "xyz789",
  "compress": true,
  "fileName": "xyz789"
}

DataTransferParameters

Fields
Input Field Description
processorId - ID! Processor ID
settings - Object

General settings:

  • openNewConnection: opens new database connection for data transfer task
processorProperties - Object! Processor properties. See DataTransferProcessorInfo.properties
outputSettings - DataTransferOutputSettingsInput Consumer properties. See StreamConsumerSettings
filter - SQLDataFilter Data filter settings
Example
{
  "processorId": "4",
  "settings": Object,
  "processorProperties": Object,
  "outputSettings": DataTransferOutputSettingsInput,
  "filter": SQLDataFilter
}

DataTransferProcessorInfo

Fields
Field Name Description
id - ID!
name - String
description - String
fileExtension - String
appFileExtension - String
appName - String
order - Int!
icon - String
properties - [ObjectPropertyInfo]
isBinary - Boolean
isHTML - Boolean
Example
{
  "id": 4,
  "name": "abc123",
  "description": "abc123",
  "fileExtension": "xyz789",
  "appFileExtension": "abc123",
  "appName": "abc123",
  "order": 987,
  "icon": "xyz789",
  "properties": [ObjectPropertyInfo],
  "isBinary": false,
  "isHTML": false
}

DataTypeLogicalOperation

Fields
Field Name Description
id - ID!
expression - String!
argumentCount - Int
Example
{
  "id": "4",
  "expression": "xyz789",
  "argumentCount": 123
}

DatabaseAuthModel

Description

Drivers and connections

Fields
Field Name Description
id - ID! Auth model unique ID
displayName - String! Display name of the auth model
description - String Description of the auth model
icon - String Path to the auth model icon
requiresLocalConfiguration - Boolean Checks if the auth model needs a configuration on a local file system
requiredAuth - String Returns id of the required auth provider if the auth model requires it
properties - [ObjectPropertyInfo!]! List of properties for the auth model that can be displayed in the UI
Example
{
  "id": "4",
  "displayName": "xyz789",
  "description": "abc123",
  "icon": "xyz789",
  "requiresLocalConfiguration": false,
  "requiredAuth": "abc123",
  "properties": [ObjectPropertyInfo]
}

DatabaseCatalog

Fields
Field Name Description
catalog - NavigatorNodeInfo!
schemaList - [NavigatorNodeInfo!]!
Example
{
  "catalog": NavigatorNodeInfo,
  "schemaList": [NavigatorNodeInfo]
}

DatabaseObjectInfo

Fields
Field Name Description
name - String Object name
description - String Description - optional
type - String Object type. Java class name in most cases
properties - [ObjectPropertyInfo] Read object properties. Optional parameter 'ids' filters properties by id. null means all properties. Note: property value reading may take a lot of time so don't read all property values always Examine property meta (features in particular) before reading them
Arguments
ordinalPosition - Int
fullyQualifiedName - String
overloadedName - String
uniqueName - String
state - String
features - [String!] Features: script, scriptExtended, dataContainer, dataManipulator, entity, schema, catalog
editors - [String!] Supported editors: ddl, permissions, sourceDeclaration, sourceDefinition
Example
{
  "name": "abc123",
  "description": "xyz789",
  "type": "abc123",
  "properties": [ObjectPropertyInfo],
  "ordinalPosition": 123,
  "fullyQualifiedName": "xyz789",
  "overloadedName": "abc123",
  "uniqueName": "abc123",
  "state": "xyz789",
  "features": ["abc123"],
  "editors": ["xyz789"]
}

DatabaseStructContainers

Fields
Field Name Description
parentNode - NavigatorNodeInfo
catalogList - [DatabaseCatalog!]!
schemaList - [NavigatorNodeInfo!]!
supportsCatalogChange - Boolean!
supportsSchemaChange - Boolean!
Example
{
  "parentNode": NavigatorNodeInfo,
  "catalogList": [DatabaseCatalog],
  "schemaList": [NavigatorNodeInfo],
  "supportsCatalogChange": false,
  "supportsSchemaChange": false
}

Date

Example
"2007-12-03"

DateTime

Description

Date/Time

Example
"2007-12-03T10:15:30Z"

DeploymentAddressVerificationInfo

Fields
Field Name Description
valid - Boolean! Shows if the deployment address is valid (available at the external network).
message - String Message with additional information about the deployment address verification.
Example
{"valid": true, "message": "abc123"}

DeploymentInfo

Description

Information about the deployment (server instance)

Fields
Field Name Description
id - ID! Unique identifier of the deployment.
ipAddress - String The ip address of the deployment that can be used for generating the certbot certificate.
publicAddress - String The public address of the deployment.
subdomain - String The organization subdomain for the deployment.
dateOfExpire - String Returns the expiration date of the certificate for the deployment if it was generated automatically.
domainRenewalError - DomainRenewalError Returns the error information if the domain certificate renewal failed.
Example
{
  "id": "4",
  "ipAddress": "xyz789",
  "publicAddress": "xyz789",
  "subdomain": "xyz789",
  "dateOfExpire": "xyz789",
  "domainRenewalError": DomainRenewalError
}

DomainCertificateType

Values
Enum Value Description

CUSTOM

Custom certificate is used.

DEFAULT

Certificate was generated using the domain manager server.
Example
"CUSTOM"

DomainManagerAvailability

Fields
Field Name Description
certbot - Boolean! Identifies if the certbot service is available.
server - Boolean! Identifies if the domain manager server is available.
externalStatus - EDMStatus Returns the reason why the domain manager is unavailable, if any.
Example
{
  "certbot": true,
  "server": true,
  "externalStatus": "AWS_MARKETPLACE_AGREEMENT_NOT_FOUND"
}

DomainRenewalError

Description

Information about the domain certificate renewal error.

Fields
Field Name Description
updateTime - String! Time when the error occurred.
errorMessage - String! The error message.
Example
{
  "updateTime": "abc123",
  "errorMessage": "xyz789"
}

DriverConfig

Fields
Input Field Description
id - ID Unique identifier of the driver.
name - String! Driver display name.
providerId - ID! Driver provider ID. Must be one of the available driver providers.
driverClassName - String! Java class name for the driver. Used to load the driver.
description - String Driver description.
sampleURL - String Sample URL for the driver.
defaultPort - String Default port for the driver.
defaultDatabase - String Default database for the driver.
defaultUser - String Default user for the driver.
Example
{
  "id": "4",
  "name": "abc123",
  "providerId": "4",
  "driverClassName": "xyz789",
  "description": "xyz789",
  "sampleURL": "abc123",
  "defaultPort": "xyz789",
  "defaultDatabase": "xyz789",
  "defaultUser": "abc123"
}

DriverConfigurationType

Values
Enum Value Description

MANUAL

Driver uses host, port, database and server name fields

URL

Driver uses URL field
Example
"MANUAL"

DriverFileInfo

Description

Driver file information.

Fields
Field Name Description
id - ID! Driver file unique ID
fileName - String! Driver file name
icon - String Path to the driver file icon
Example
{
  "id": 4,
  "fileName": "xyz789",
  "icon": "xyz789"
}

DriverInfo

Fields
Field Name Description
id - ID! Driver unique full ID. It is providerId + "." + driverId. It is recommended to use providerId and driverId separately.
name - String Name of the driver
description - String Description of the driver
icon - String Path to the driver icon
iconBig - String Path to the driver icon for big size
driverId - ID! Driver ID. It is unique within provider
providerId - ID! Driver provider ID. It is globally unique
driverClassName - String Driver Java class name
defaultHost - String Default host for the driver
defaultPort - String Default port for the driver
defaultDatabase - String Default database name for the driver
defaultServer - String Default server name for the driver
defaultUser - String Default user name for the driver
sampleURL - String Default connection URL for the driver
driverInfoURL - String Returns link to the driver documentation page
driverPropertiesURL - String Returns link to the driver properties page
embedded - Boolean Defines if the database for this driver is embedded
enabled - Boolean! Defines if the driver is enabled
requiresServerName - Boolean Defines if the driver page requires server name field use mainProperties instead
requiresDatabaseName - Boolean Defines if the driver page requires database name field use mainProperties instead
useCustomPage - Boolean! Defines if host, port, database, server name fields are using a custom page
licenseRequired - Boolean Defines if driver license is required
license - String Driver license information
custom - Boolean Defines if the driver is a custom driver
promotedScore - Int Driver score for ordering, biggest first
driverProperties - [ObjectPropertyInfo!]! Driver properties. Note: it is expensive property and it may produce database server roundtrips. Call it only when you really need it. These properties are for advanced users in usually shouldn't be specified for new connections.
driverParameters - Object! Driver parameters (map name->value)
mainProperties - [ObjectPropertyInfo!]! Main driver properties. Contains info about main fields (host, port, database, server name) that are used in main connection page
providerProperties - [ObjectPropertyInfo!]! Additional driver provider properties. These properties can be configured by user on main connection page to provide important connection settings
anonymousAccess - Boolean False for drivers which do not support authentication.
defaultAuthModel - ID! Default auth model that is used for this driver (see authModels)
applicableAuthModels - [ID!]! List of auth models that can be used with this driver (see authModels)
applicableNetworkHandlers - [ID]! List of network handlers that can be used with this driver (SSH/SSL)
configurationTypes - [DriverConfigurationType]! Configuration types are used in UI to determine how to display connection settings (show host/port/database fields or use URL field)
downloadable - Boolean! Defines if the driver can be downloaded remotely
driverInstalled - Boolean! Defines if the driver is installed on the server
driverLibraries - [DriverLibraryInfo!]! List of driver libraries that are used for connecting to the database
safeEmbeddedDriver - Boolean! Defines if embedded driver is safe to use in the server
Example
{
  "id": 4,
  "name": "xyz789",
  "description": "abc123",
  "icon": "abc123",
  "iconBig": "abc123",
  "driverId": 4,
  "providerId": "4",
  "driverClassName": "xyz789",
  "defaultHost": "abc123",
  "defaultPort": "abc123",
  "defaultDatabase": "xyz789",
  "defaultServer": "abc123",
  "defaultUser": "xyz789",
  "sampleURL": "xyz789",
  "driverInfoURL": "abc123",
  "driverPropertiesURL": "abc123",
  "embedded": false,
  "enabled": false,
  "requiresServerName": false,
  "requiresDatabaseName": false,
  "useCustomPage": false,
  "licenseRequired": true,
  "license": "xyz789",
  "custom": false,
  "promotedScore": 987,
  "driverProperties": [ObjectPropertyInfo],
  "driverParameters": Object,
  "mainProperties": [ObjectPropertyInfo],
  "providerProperties": [ObjectPropertyInfo],
  "anonymousAccess": true,
  "defaultAuthModel": "4",
  "applicableAuthModels": ["4"],
  "applicableNetworkHandlers": ["4"],
  "configurationTypes": ["MANUAL"],
  "downloadable": false,
  "driverInstalled": true,
  "driverLibraries": [DriverLibraryInfo],
  "safeEmbeddedDriver": false
}

DriverLibraryInfo

Description

Driver library information. Used to display driver files in UI

Fields
Field Name Description
id - ID! Driver library unique ID
name - String! Driver library name
icon - String Path to the driver library icon
libraryFiles - [DriverFileInfo!] List of files that are used by the driver
Example
{
  "id": 4,
  "name": "abc123",
  "icon": "xyz789",
  "libraryFiles": [DriverFileInfo]
}

DriverProviderInfo

Description

Information about a driver provider.

Fields
Field Name Description
id - ID! Unique identifier of the driver provider.
name - String! Display name of the driver provider.
icon - String Path to the icon of the driver provider.
Example
{
  "id": 4,
  "name": "xyz789",
  "icon": "abc123"
}

DynamicTraceProperty

Fields
Field Name Description
name - String!
value - String
description - String
Example
{
  "name": "abc123",
  "value": "abc123",
  "description": "xyz789"
}

EDMStatus

Values
Enum Value Description

AWS_MARKETPLACE_AGREEMENT_NOT_FOUND

AWS Marketplace agreement ID not found. To use the domain manager, the agreement ID is needed for AWS product.
Example
"AWS_MARKETPLACE_AGREEMENT_NOT_FOUND"

ERDAssociationInfo

Description

Information about an association between entities in the ERD diagram.

Fields
Field Name Description
name - String! Name of the association.
fqn - String Fully qualified name of the association.
type - String! Association type, such as 'fk' (foreign key), 'pk' (primary key) etc.
primaryEntity - Int Returns the index of the primary (source) entity if specified.
foreignEntity - Int Returns the index of the foreign (target) entity if specified.
primaryAttributes - [String!]! List of primary attributes in the association.
foreignAttributes - [String!]! List of foreign attributes in the association.
joinType - VQBJoinType Type of join operation used in the association.
Example
{
  "name": "abc123",
  "fqn": "xyz789",
  "type": "xyz789",
  "primaryEntity": 987,
  "foreignEntity": 987,
  "primaryAttributes": ["xyz789"],
  "foreignAttributes": ["abc123"],
  "joinType": "SIMPLE"
}

ERDDiagramData

Description

ERD queries

Fields
Field Name Description
icons - [String!]! List of icon paths used in the ERD diagram.
Example
{"icons": ["xyz789"]}

ERDDiagramInfo

Description

Information about an ERD diagram, including entities, associations, and diagram data.

Fields
Field Name Description
entities - [ERDEntityInfo!]! Entities in the ERD diagram.
associations - [ERDAssociationInfo!] Associations between entities in the ERD diagram.
data - ERDDiagramData! Diagram data, including icons and other metadata.
where - String
orderBy - [String!]!
selectItems - [String!]!
Example
{
  "entities": [ERDEntityInfo],
  "associations": [ERDAssociationInfo],
  "data": ERDDiagramData,
  "where": "xyz789",
  "orderBy": ["xyz789"],
  "selectItems": ["xyz789"]
}

ERDEntityAttributeInfo

Description

Information about an entity attribute in the ERD diagram (columns from table).

Fields
Field Name Description
name - String! Name of the attribute.
alias - String Alias of the attribute if it has one.
dataKind - String Data type of the attribute.
typeName - String Type name of the attribute.
optional - Boolean Indicates if the attribute is optional.
iconIndex - Int Returns the icon index for the attribute from the ERD diagram data.
fullTypeName - String Fully qualified type name of the attribute.
defaultValue - String Default value of the attribute.
description - String Description of the attribute.
checked - Boolean! Indicates if the attribute is checked.
inPrimaryKey - Boolean Indicates if the attribute is in a primary key.
inForeignKey - Boolean Indicates if the attribute is in a foreign key.
Example
{
  "name": "abc123",
  "alias": "xyz789",
  "dataKind": "xyz789",
  "typeName": "abc123",
  "optional": false,
  "iconIndex": 987,
  "fullTypeName": "abc123",
  "defaultValue": "xyz789",
  "description": "xyz789",
  "checked": true,
  "inPrimaryKey": false,
  "inForeignKey": true
}

ERDEntityInfo

Fields
Field Name Description
id - Int! Unique identifier of the entity.
name - String! Display name of the entity.
alias - String Alias of the entity if it has one.
fqn - String Fully qualified name of the entity, including its namespace.
nodeId - ID ID of the node in the ERD diagram.
nodeUri - ID URI of the node in the ERD diagram.
attributes - [ERDEntityAttributeInfo!]! List of attributes for the entity.
Example
{
  "id": 123,
  "name": "abc123",
  "alias": "abc123",
  "fqn": "xyz789",
  "nodeId": 4,
  "nodeUri": "4",
  "attributes": [ERDEntityAttributeInfo]
}

ExternalParameters

Description

must be not null after refactoring

Fields
Input Field Description
configurationId - String
secretName - String
Example
{
  "configurationId": "xyz789",
  "secretName": "abc123"
}

ExternalUserInfo

Description

Information about a user for provisioning from an external system.

Fields
Field Name Description
userId - String! Unique identifier for the user in the external system.
metaParameters - Object! Meta parameters for the user, such as email, first name, last name, etc.
authRole - String Auth role assigned to the user (see listAuthRoles).
Example
{
  "userId": "abc123",
  "metaParameters": Object,
  "authRole": "xyz789"
}

ExternalUserInput

Description

Input for importing users for provisioning from an external system.

Fields
Input Field Description
userId - String! Unique identifier for the user in the external system.
metaParameters - Object! Meta parameters for the user, such as email, first name, last name, etc.
authRole - String Auth role to be assigned to the user (see listAuthRoles).
Example
{
  "userId": "abc123",
  "metaParameters": Object,
  "authRole": "abc123"
}

ExternalUsersFilter

Description

Pagination filter for external users.

Fields
Input Field Description
offset - Int
limit - Int
Example
{"offset": 987, "limit": 123}

FSFile

Fields
Field Name Description
name - String! Name of the file or folder
length - Int! Length of the file in bytes
folder - Boolean! Flag indicating if the file is a folder
metaData - Object! Metadata of the file or folder
nodePath - String! Navigator tree node path
Example
{
  "name": "abc123",
  "length": 123,
  "folder": true,
  "metaData": Object,
  "nodePath": "xyz789"
}

FSFileSystem

Fields
Field Name Description
id - ID! File system ID
nodePath - String! Navigator tree node path
requiredAuth - String External auth provider ID if file system requires authentication
Example
{
  "id": "4",
  "nodePath": "abc123",
  "requiredAuth": "abc123"
}

FederatedAuthInfo

Fields
Field Name Description
redirectLink - String!
taskInfo - AsyncTaskInfo!
Example
{
  "redirectLink": "abc123",
  "taskInfo": AsyncTaskInfo
}

FederatedAuthResult

Fields
Field Name Description
userTokens - [UserAuthToken!]!
Example
{"userTokens": [UserAuthToken]}

FileBasedConnectionInfo

Description

Information about a connection created from a file-based source

Fields
Field Name Description
connectionInfo - ConnectionInfo! Connection details
nodePathToOpen - String! Path to the node that should be opened after connection creation
Example
{
  "connectionInfo": ConnectionInfo,
  "nodePathToOpen": "xyz789"
}

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example
123.45

GitGlobalSettings

Description

Information about the global git configuration settings.

Fields
Field Name Description
username - String! Username for the git configuration.
email - String Email associated with the git configuration.
password - String! Password for the git configuration.
Example
{
  "username": "abc123",
  "email": "abc123",
  "password": "abc123"
}

GitGlobalSettingsInput

Description

Input for saving global git configuration settings.

Fields
Input Field Description
username - String! Username for the git configuration.
email - String Email associated with the git configuration.
password - String! Password for the git configuration.
Example
{
  "username": "xyz789",
  "email": "abc123",
  "password": "xyz789"
}

GitGlobalSettingsTestInput

Description

Input for testing git global settings.

Fields
Input Field Description
username - String Username for the git configuration.
email - String Email associated with the git configuration.
password - String Password for the git configuration.
Example
{
  "username": "xyz789",
  "email": "abc123",
  "password": "abc123"
}

GitIgnoreRule

Description

Enum representing the different git ignore rules that can be applied to a project.

Values
Enum Value Description

DATASOURCES

DATASOURCE_CREDENTIALS

TASKS

PROJECT_METADATA

PROJECT_SETTINGS

BOOKMARKS

DATASETS

DIAGRAMS

SCRIPTS

Example
"DATASOURCES"

GitProjectSettings

Description

Information about the git configuration settings for a specific project.

Fields
Field Name Description
enabled - Boolean! Indicates if git is enabled for the project.
repositoryUrl - String URL of the git repository for the project.
branch - String Branch of the git repository to use for the project.
gitIgnoreRules - [GitIgnoreRule!]! List of git ignore rules for the project.
Example
{
  "enabled": true,
  "repositoryUrl": "abc123",
  "branch": "xyz789",
  "gitIgnoreRules": ["DATASOURCES"]
}

GitProjectSettingsInput

Description

Input for saving git configuration settings for a specific project.

Fields
Input Field Description
enabled - Boolean! Enables or disables git for the project.
repositoryUrl - String! URL of the git repository for the project.
branch - String Branch of the git repository to use for the project.
gitIgnoreRules - [GitIgnoreRule!] List of git ignore rules for the project.
Example
{
  "enabled": false,
  "repositoryUrl": "xyz789",
  "branch": "abc123",
  "gitIgnoreRules": ["DATASOURCES"]
}

ID

Description

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example
"4"

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example
987

LMLicenseInfo

Description

Represents detailed information about a product license.

Fields
Field Name Description
id - String! Unique identifier of the license.
licenseType - String Type of the license.
ownerCompany - String Name of the owner company.
ownerName - String Name of the license owner.
ownerEmail - String Email of the license owner.
usersNumber - Int Number of users allowed by the license.
yearsNumber - Int Number of years the license is valid for.
subscription - Boolean Indicates if the license is a subscription.
unlimitedServers - Boolean Indicates if unlimited servers are allowed.
multiInstance - Boolean Indicates if multi-instance usage is allowed.
serversNumber - Int Number of servers allowed by the license.
licenseIssueTime - String Time when the license was issued.
licenseStartTime - String Start time of the license validity.
licenseEndTime - String End time of the license validity.
licenseRoles - [LMLicenseRole!] Roles associated with the license.
licenseStatus - LMLicenseStatusDetails! Status details of the license.
Example
{
  "id": "xyz789",
  "licenseType": "xyz789",
  "ownerCompany": "abc123",
  "ownerName": "abc123",
  "ownerEmail": "xyz789",
  "usersNumber": 123,
  "yearsNumber": 987,
  "subscription": false,
  "unlimitedServers": false,
  "multiInstance": false,
  "serversNumber": 987,
  "licenseIssueTime": "abc123",
  "licenseStartTime": "abc123",
  "licenseEndTime": "abc123",
  "licenseRoles": [LMLicenseRole],
  "licenseStatus": LMLicenseStatusDetails
}

LMLicenseRole

Description

Represents a role associated with a license and the number of users assigned to it.

Fields
Field Name Description
role - ID! Unique identifier of the role.
usersNumber - Int! Number of users assigned to this role.
Example
{"role": 4, "usersNumber": 123}

LMLicenseStatus

Description

Represents the possible statuses of a license.

Values
Enum Value Description

VALID

The license is valid.

INVALID

The license is invalid.

EXPIRED

The license has expired.

CANCELED

The license has been canceled.

COMPROMISED

The license has been compromised.

BAD_CODE

The license code is incorrect or corrupted.
Example
"VALID"

LMLicenseStatusDetails

Description

Contains detailed status information for a license.

Fields
Field Name Description
message - String! Human-readable status message.
details - String Additional details about the license status.
valid - Boolean! Indicates if the license is valid.
remoteStatus - LMLicenseStatus Status of the license as reported by a remote source.
Example
{
  "message": "abc123",
  "details": "abc123",
  "valid": true,
  "remoteStatus": "VALID"
}

LogEntry

Fields
Field Name Description
time - DateTime
type - String!
message - String
stackTrace - String
Example
{
  "time": "2007-12-03T10:15:30Z",
  "type": "abc123",
  "message": "abc123",
  "stackTrace": "abc123"
}

LogoutInfo

Fields
Field Name Description
redirectLinks - [String!]!
Example
{"redirectLinks": ["xyz789"]}

MSServiceInfo

Fields
Field Name Description
id - String!
type - MSServiceType!
endpoint - String!
nodes - [MSServiceNode!]!
Example
{
  "id": "abc123",
  "type": "DOMAIN_CONTROLLER",
  "endpoint": "abc123",
  "nodes": [MSServiceNode]
}

MSServiceNode

Fields
Field Name Description
location - String!
status - String!
Example
{
  "location": "abc123",
  "status": "abc123"
}

MSServiceType

Values
Enum Value Description

DOMAIN_CONTROLLER

CLOUDBEAVER

RESOURCE_MANAGER

QUERY_MANAGER

Example
"DOMAIN_CONTROLLER"

NavigatorNodeFilter

Fields
Field Name Description
include - [String!]
exclude - [String!]
Example
{
  "include": ["abc123"],
  "exclude": ["abc123"]
}

NavigatorNodeInfo

Fields
Field Name Description
id - ID! Node ID - generally a full path to the node from root of tree
uri - ID! Node URI - a unique path to a node including all parent nodes
name - String Node human readable name
fullName - String Node full name use name parameter (23.2.0)
plainName - String Node plain name (23.2.0)
icon - String Node icon path
description - String Node description
nodeType - String Node type
hasChildren - Boolean! Can this property have child nodes?
projectId - String Project id of the node
object - DatabaseObjectInfo Associated object. Maybe null for non-database objects
objectId - String Associated object. Return value depends on the node type - connectionId for connection node, resource path for resource node, etc. null - if node currently not support this property
features - [String!] Supported features: item, container, leaf, canDelete, canRename
nodeDetails - [ObjectPropertyInfo!] Object detailed info. If is different than properties. It doesn't perform any expensive operation and doesn't require authentication.
folder - Boolean!
inline - Boolean!
navigable - Boolean!
filtered - Boolean!
filter - NavigatorNodeFilter Reads node filter. Expensive invocation, read only when it is really needed
Example
{
  "id": 4,
  "uri": 4,
  "name": "xyz789",
  "fullName": "xyz789",
  "plainName": "abc123",
  "icon": "xyz789",
  "description": "xyz789",
  "nodeType": "abc123",
  "hasChildren": true,
  "projectId": "abc123",
  "object": DatabaseObjectInfo,
  "objectId": "abc123",
  "features": ["xyz789"],
  "nodeDetails": [ObjectPropertyInfo],
  "folder": false,
  "inline": true,
  "navigable": true,
  "filtered": false,
  "filter": NavigatorNodeFilter
}

NavigatorSettings

Fields
Field Name Description
showSystemObjects - Boolean!
showUtilityObjects - Boolean!
showOnlyEntities - Boolean!
mergeEntities - Boolean!
hideFolders - Boolean!
hideSchemas - Boolean!
hideVirtualModel - Boolean!
Example
{
  "showSystemObjects": false,
  "showUtilityObjects": true,
  "showOnlyEntities": false,
  "mergeEntities": true,
  "hideFolders": true,
  "hideSchemas": false,
  "hideVirtualModel": true
}

NavigatorSettingsInput

Fields
Input Field Description
showSystemObjects - Boolean!
showUtilityObjects - Boolean!
showOnlyEntities - Boolean!
mergeEntities - Boolean!
hideFolders - Boolean!
hideSchemas - Boolean!
hideVirtualModel - Boolean!
Example
{
  "showSystemObjects": false,
  "showUtilityObjects": true,
  "showOnlyEntities": true,
  "mergeEntities": true,
  "hideFolders": true,
  "hideSchemas": true,
  "hideVirtualModel": true
}

NetworkEndpointInfo

Fields
Field Name Description
message - String
clientVersion - String
serverVersion - String
Example
{
  "message": "xyz789",
  "clientVersion": "abc123",
  "serverVersion": "abc123"
}

NetworkHandlerAuthType

Description

SSH network handler authentication type

Values
Enum Value Description

PASSWORD

PUBLIC_KEY

AGENT

Example
"PASSWORD"

NetworkHandlerConfig

Description

SSH/SSL network handler config. Name without prefix only for backward compatibility

Fields
Field Name Description
id - ID!
enabled - Boolean! Defines if the network handler is enabled
authType - NetworkHandlerAuthType! SSH network handler auth type use properties
userName - String SSH network handler user name
password - String SSH network handler user password
key - String SSH network handler private key use secured properties
savePassword - Boolean! A flag that indicates if the password should be saved in the secure storage
properties - Object! Network handler properties (name/value)
secureProperties - Object! Network handler secure properties (name/value). Used for passwords and keys
Example
{
  "id": "4",
  "enabled": false,
  "authType": "PASSWORD",
  "userName": "xyz789",
  "password": "xyz789",
  "key": "xyz789",
  "savePassword": true,
  "properties": Object,
  "secureProperties": Object
}

NetworkHandlerConfigInput

Fields
Input Field Description
id - ID!
enabled - Boolean Defines if the network handler should be enabled
userName - String Sets user name for the network handler (SSH)
password - String Sets user password for the network handler (SSH)
savePassword - Boolean Sets a flag that indicates if the password should be saved in the secure storage
properties - Object Network handler properties (name/value)
secureProperties - Object Network handler secure properties (name/value). Used for passwords and keys
Example
{
  "id": 4,
  "enabled": true,
  "userName": "xyz789",
  "password": "abc123",
  "savePassword": true,
  "properties": Object,
  "secureProperties": Object
}

NetworkHandlerDescriptor

Description

Network handler descriptor. This descriptor is used to describe network handlers (SSH/SSL) that can be used for connections.

Fields
Field Name Description
id - ID!
codeName - String!
label - String!
description - String
secured - Boolean!
type - NetworkHandlerType
properties - [ObjectPropertyInfo!]! Properties that can be displayed in the UI
Example
{
  "id": "4",
  "codeName": "xyz789",
  "label": "xyz789",
  "description": "abc123",
  "secured": true,
  "type": "TUNNEL",
  "properties": [ObjectPropertyInfo]
}

NetworkHandlerType

Values
Enum Value Description

TUNNEL

PROXY

CONFIG

Example
"TUNNEL"

Object

Description

Any object (JSON)

Example
Object

ObjectOrigin

Fields
Field Name Description
type - ID!
subType - ID
displayName - String!
icon - String
configuration - Object
details - [ObjectPropertyInfo!]
Example
{
  "type": "4",
  "subType": "4",
  "displayName": "abc123",
  "icon": "xyz789",
  "configuration": Object,
  "details": [ObjectPropertyInfo]
}

ObjectPropertyFilter

Fields
Input Field Description
ids - [String!]
features - [String!]
categories - [String!]
dataTypes - [String!]
Example
{
  "ids": ["xyz789"],
  "features": ["abc123"],
  "categories": ["abc123"],
  "dataTypes": ["xyz789"]
}

ObjectPropertyInfo

Description

Information about the object property used to generate its UI

Fields
Field Name Description
id - String Unique property identifier
displayName - String Human-readable name
description - String Property description
hint - String Usage hint for the property
category - String Property category (may be used if object has a lot of properties)
dataType - String Property data type (e.g., int, String)
value - Object Property value (can be resource-intensive for some properties, e.g., RowCount for tables)
validValues - [Object] List of allowed values (for enumerable properties)
defaultValue - Object Default property value
length - ObjectPropertyLength! Property value length
features - [String!]! List of supported features (e.g., system, hidden, inherited, foreign, expensive)
order - Int! Order position
supportedConfigurationTypes - [String!] Supported configuration types (for driver properties)
required - Boolean! Is the property required
scopes - [String!] List of preference scopes (e.g., global, user)
conditions - [Condition!] Dynamic conditions for the property (e.g., visibility or read-only)
Example
{
  "id": "xyz789",
  "displayName": "abc123",
  "description": "xyz789",
  "hint": "abc123",
  "category": "abc123",
  "dataType": "xyz789",
  "value": Object,
  "validValues": [Object],
  "defaultValue": Object,
  "length": "TINY",
  "features": ["abc123"],
  "order": 987,
  "supportedConfigurationTypes": ["abc123"],
  "required": false,
  "scopes": ["abc123"],
  "conditions": [Condition]
}

ObjectPropertyLength

Values
Enum Value Description

TINY

1 character

SHORT

20 characters

MEDIUM

<= 64 characters

LONG

Full line length. The default

MULTILINE

Multi-line long text
Example
"TINY"

OrganizationInfo

Description

The organization information for the domain manager.

Fields
Field Name Description
id - ID! Unique identifier of the organization.
baseDomain - String! The base domain of the organization.
subdomain - String The subdomain of the organization.
deployments - [DeploymentInfo!] List of deployments (servers) for the organization.
currentDeployment - DeploymentInfo The current deployment information.
Example
{
  "id": "4",
  "baseDomain": "abc123",
  "subdomain": "abc123",
  "deployments": [DeploymentInfo],
  "currentDeployment": DeploymentInfo
}

PageInput

Fields
Input Field Description
limit - Int
offset - Int
Example
{"limit": 123, "offset": 987}

ProductInfo

Description

Product information

Fields
Field Name Description
id - ID! ID of the product
version - String! The product version
name - String! The product name
description - String The product description
buildTime - String! The build timestamp of the product
releaseTime - String! The release timestamp of the product
licenseInfo - String Information about the product license
latestVersionInfo - String Information about the latest available version
productPurchaseURL - String URL for purchasing the product
Example
{
  "id": 4,
  "version": "abc123",
  "name": "xyz789",
  "description": "xyz789",
  "buildTime": "abc123",
  "releaseTime": "xyz789",
  "licenseInfo": "abc123",
  "latestVersionInfo": "abc123",
  "productPurchaseURL": "xyz789"
}

ProductSettings

Fields
Field Name Description
groups - [ProductSettingsGroup!]!
settings - [ObjectPropertyInfo!]! each property is associated with a group by category
Example
{
  "groups": [ProductSettingsGroup],
  "settings": [ObjectPropertyInfo]
}

ProductSettingsGroup

Fields
Field Name Description
id - ID!
displayName - String!
Example
{"id": 4, "displayName": "xyz789"}

ProjectInfo

Fields
Field Name Description
id - String!
global - Boolean!
shared - Boolean!
name - String!
description - String
canEditDataSources - Boolean!
canViewDataSources - Boolean!
canEditResources - Boolean!
canViewResources - Boolean!
resourceTypes - [RMResourceType!]!
Example
{
  "id": "xyz789",
  "global": false,
  "shared": true,
  "name": "abc123",
  "description": "abc123",
  "canEditDataSources": false,
  "canViewDataSources": false,
  "canEditResources": true,
  "canViewResources": false,
  "resourceTypes": [RMResourceType]
}

QMAdminSearchFilter

Fields
Input Field Description
searchString - String
page - Int!
pageSize - Int!
users - [String!]
projectIds - [String!]
catalogs - [String!]
schemas - [String!]
objectTypes - [QMObjectType!]
queryTypes - [QMQueryType!]
driverIds - [String!]
eventStatuses - [QMEventStatus!]
lastEventId - ID
startDateRange - QMDateRange
sort - QMSort
Example
{
  "searchString": "xyz789",
  "page": 987,
  "pageSize": 123,
  "users": ["xyz789"],
  "projectIds": ["xyz789"],
  "catalogs": ["abc123"],
  "schemas": ["xyz789"],
  "objectTypes": ["session"],
  "queryTypes": ["USER"],
  "driverIds": ["xyz789"],
  "eventStatuses": ["FAILED"],
  "lastEventId": "4",
  "startDateRange": QMDateRange,
  "sort": QMSort
}

QMDateRange

Fields
Input Field Description
from - String
to - String
Example
{
  "from": "abc123",
  "to": "abc123"
}

QMEventStatus

Description

Enum representing the status of a QM event.

Values
Enum Value Description

FAILED

SUCCESS

Example
"FAILED"

QMMFilterResponse

Fields
Field Name Description
hasMore - Boolean! Indicates if there are more objects available in the filter response.
objects - [QMMObject!]! Returns the list of QM objects in the filter response.
Example
{"hasMore": false, "objects": [QMMObject]}

QMMObject

Description

Information about a QM meta object, such as a session, transaction, or query.

Fields
Field Name Description
eventId - ID! Unique identifier of the QM object.
queryText - String! Text of the query executed in the QM object.
startTime - Float! Start time of the QM object in milliseconds since epoch.
objectType - String! Object type of the QM object (query).
queryType - String Query type of the QM object, such as USER, USER_FILTERED, USER_SCRIPT, UTIL, META, or META_DDL.
duration - Float Duration of the QM object in milliseconds.
rows - Float Number of rows returned by the QM object.
errorMessage - String The error message if the QM object failed.
projectName - String! Name of the project associated with the QM object.
dataSource - String! ID of the connection associated with the QM object.
connection - String! Name of the context associated with the QM object.
driverId - String! ID of the driver used for the QM object.
userIp - String User IP address that executed the QM object.
schemaName - String The schema name associated with the QM object.
catalog - String The catalog name associated with the QM object.
user - QMUser The user who executed the QM object.
Example
{
  "eventId": "4",
  "queryText": "xyz789",
  "startTime": 987.65,
  "objectType": "abc123",
  "queryType": "xyz789",
  "duration": 123.45,
  "rows": 123.45,
  "errorMessage": "xyz789",
  "projectName": "xyz789",
  "dataSource": "xyz789",
  "connection": "abc123",
  "driverId": "xyz789",
  "userIp": "xyz789",
  "schemaName": "xyz789",
  "catalog": "abc123",
  "user": QMUser
}

QMObjectType

Description

Enum representing the different types of QM objects.

Values
Enum Value Description

session

txn

query

Example
"session"

QMQueryType

Values
Enum Value Description

USER

USER_FILTERED

USER_SCRIPT

UTIL

META

META_DDL

Example
"USER"

QMSearchFilter

Description

Input for filtering QM queries.

Fields
Input Field Description
searchString - String Search string to filter QM queries.
page - Int! Pagination parameters for the search results.
pageSize - Int! Number of items per page for the search results.
projectIds - [String!] IDs of projects.
catalogs - [String!] Catalogs names.
schemas - [String!] Schemas names.
objectTypes - [QMObjectType!] Object types.
queryTypes - [QMQueryType!] Query types.
driverIds - [String!] IDs of drivers.
eventStatuses - [QMEventStatus!] Statuses of events.
lastEventId - ID ID of the last event to filter by.
startDateRange - QMDateRange Start date range for filtering QM queries.
sort - QMSort Sorting parameters for the search results.
Example
{
  "searchString": "abc123",
  "page": 987,
  "pageSize": 987,
  "projectIds": ["xyz789"],
  "catalogs": ["abc123"],
  "schemas": ["xyz789"],
  "objectTypes": ["session"],
  "queryTypes": ["USER"],
  "driverIds": ["abc123"],
  "eventStatuses": ["FAILED"],
  "lastEventId": 4,
  "startDateRange": QMDateRange,
  "sort": QMSort
}

QMSort

Description

Input for sorting QM objects.

Fields
Input Field Description
desc - Boolean! Sorting descending or ascending.
sortBy - QMSortField! Parameter by which to sort the QM objects.
Example
{"desc": false, "sortBy": "DATE"}

QMSortField

Description

Enum representing the different fields by which QM objects can be sorted.

Values
Enum Value Description

DATE

The start time of the QM object.

USER

The user who executed the QM object.

DRIVER

The driver used for the QM object.

QUERY_TEXT

The query text of the QM object.
Example
"DATE"

QMSupervisorSearchFilter

Fields
Input Field Description
searchString - String
page - Int!
pageSize - Int!
users - [String!]
teams - [String!]
projectIds - [String!]
catalogs - [String!]
schemas - [String!]
objectTypes - [QMObjectType!]
queryTypes - [QMQueryType!]
driverIds - [String!]
eventStatuses - [QMEventStatus!]
lastEventId - ID
startDateRange - QMDateRange
sort - QMSort
Example
{
  "searchString": "abc123",
  "page": 123,
  "pageSize": 987,
  "users": ["xyz789"],
  "teams": ["xyz789"],
  "projectIds": ["abc123"],
  "catalogs": ["xyz789"],
  "schemas": ["abc123"],
  "objectTypes": ["session"],
  "queryTypes": ["USER"],
  "driverIds": ["abc123"],
  "eventStatuses": ["FAILED"],
  "lastEventId": "4",
  "startDateRange": QMDateRange,
  "sort": QMSort
}

QMUser

Fields
Field Name Description
userId - String!
userDomain - String!
Example
{
  "userId": "abc123",
  "userDomain": "xyz789"
}

RMProject

Fields
Field Name Description
id - ID!
name - String!
description - String
shared - Boolean!
global - Boolean!
createTime - DateTime!
creator - String!
projectPermissions - [String!]!
resourceTypes - [RMResourceType!]!
Example
{
  "id": 4,
  "name": "abc123",
  "description": "xyz789",
  "shared": false,
  "global": false,
  "createTime": "2007-12-03T10:15:30Z",
  "creator": "abc123",
  "projectPermissions": ["abc123"],
  "resourceTypes": [RMResourceType]
}

RMProjectPermissions

Fields
Input Field Description
projectId - String!
permissions - [String!]!
Example
{
  "projectId": "xyz789",
  "permissions": ["xyz789"]
}

RMResource

Fields
Field Name Description
name - String!
folder - Boolean!
length - Int!
properties - Object Properties map
Example
{
  "name": "xyz789",
  "folder": true,
  "length": 123,
  "properties": Object
}

RMResourceType

Fields
Field Name Description
id - String!
displayName - String!
icon - String
fileExtensions - [String!]!
rootFolder - String
Example
{
  "id": "xyz789",
  "displayName": "xyz789",
  "icon": "xyz789",
  "fileExtensions": ["abc123"],
  "rootFolder": "abc123"
}

RMSubjectProjectPermissions

Fields
Input Field Description
subjectId - String!
permissions - [String!]!
Example
{
  "subjectId": "xyz789",
  "permissions": ["abc123"]
}

ResultDataFormat

Values
Enum Value Description

resultset

document

graph

timeseries

Example
"resultset"

SQLCompletionProposal

Fields
Field Name Description
displayString - String!
type - String!
score - Int
replacementString - String!
replacementOffset - Int!
replacementLength - Int!
cursorPosition - Int
icon - String
nodePath - String
Example
{
  "displayString": "xyz789",
  "type": "xyz789",
  "score": 123,
  "replacementString": "abc123",
  "replacementOffset": 123,
  "replacementLength": 987,
  "cursorPosition": 987,
  "icon": "abc123",
  "nodePath": "abc123"
}

SQLContextInfo

Description

SQL context must be created for each SQL editor

Fields
Field Name Description
id - ID!
projectId - ID!
connectionId - ID!
autoCommit - Boolean
defaultCatalog - String
defaultSchema - String
Example
{
  "id": "4",
  "projectId": 4,
  "connectionId": 4,
  "autoCommit": true,
  "defaultCatalog": "xyz789",
  "defaultSchema": "xyz789"
}

SQLDataFilter

Fields
Input Field Description
offset - Float Row offset. We use Float because offset may be bigger than 32 bit.
limit - Int
constraints - [SQLDataFilterConstraint]
where - String
orderBy - String
Example
{
  "offset": 123.45,
  "limit": 123,
  "constraints": [SQLDataFilterConstraint],
  "where": "abc123",
  "orderBy": "abc123"
}

SQLDataFilterConstraint

Fields
Input Field Description
attributePosition - Int!
orderPosition - Int
orderAsc - Boolean
criteria - String
operator - String
value - Object
Example
{
  "attributePosition": 123,
  "orderPosition": 987,
  "orderAsc": true,
  "criteria": "xyz789",
  "operator": "abc123",
  "value": Object
}

SQLDataFilterConstraintInfo

Fields
Field Name Description
orderPosition - Int
orderAsc - Boolean
criteria - String
operator - String
value - Object
Example
{
  "orderPosition": 987,
  "orderAsc": false,
  "criteria": "abc123",
  "operator": "abc123",
  "value": Object
}

SQLDataFilterInfo

Fields
Field Name Description
where - String
constraints - [SQLDataFilterConstraintInfo!]!
Example
{
  "where": "xyz789",
  "constraints": [SQLDataFilterConstraintInfo]
}

SQLDialectInfo

Fields
Field Name Description
name - String!
dataTypes - [String]!
functions - [String]!
reservedWords - [String]!
quoteStrings - [String]!
singleLineComments - [String]!
multiLineComments - [String]!
catalogSeparator - String
structSeparator - String
scriptDelimiter - String
supportsExplainExecutionPlan - Boolean!
Example
{
  "name": "xyz789",
  "dataTypes": ["abc123"],
  "functions": ["abc123"],
  "reservedWords": ["xyz789"],
  "quoteStrings": ["abc123"],
  "singleLineComments": ["xyz789"],
  "multiLineComments": ["abc123"],
  "catalogSeparator": "abc123",
  "structSeparator": "xyz789",
  "scriptDelimiter": "abc123",
  "supportsExplainExecutionPlan": true
}

SQLExecuteInfo

Fields
Field Name Description
statusMessage - String Status message
duration - Int! Execute time (ms)
filterText - String Actual conditions applied to query
fullQuery - String

original sql query without SQLDataFilter

Full query that was executed, contains all used filters

results - [SQLQueryResults!]!
Example
{
  "statusMessage": "xyz789",
  "duration": 987,
  "filterText": "abc123",
  "fullQuery": "xyz789",
  "results": [SQLQueryResults]
}

SQLExecutionPlan

Fields
Field Name Description
query - String!
nodes - [SQLExecutionPlanNode!]!
Example
{
  "query": "abc123",
  "nodes": [SQLExecutionPlanNode]
}

SQLExecutionPlanNode

Fields
Field Name Description
id - ID!
parentId - ID
kind - String!
name - String
type - String!
condition - String
description - String
properties - [ObjectPropertyInfo!]!
Example
{
  "id": 4,
  "parentId": 4,
  "kind": "xyz789",
  "name": "xyz789",
  "type": "xyz789",
  "condition": "abc123",
  "description": "xyz789",
  "properties": [ObjectPropertyInfo]
}

SQLQueryGenerator

Fields
Field Name Description
id - String!
label - String!
description - String
order - Int!
multiObject - Boolean!
Example
{
  "id": "abc123",
  "label": "xyz789",
  "description": "xyz789",
  "order": 987,
  "multiObject": false
}

SQLQueryResults

Fields
Field Name Description
title - String
updateRowCount - Float
sourceQuery - String
dataFormat - ResultDataFormat Actual data format of this result
resultSet - SQLResultSet
Example
{
  "title": "xyz789",
  "updateRowCount": 987.65,
  "sourceQuery": "xyz789",
  "dataFormat": "resultset",
  "resultSet": SQLResultSet
}

SQLResultColumn

Fields
Field Name Description
position - Int!
name - String
label - String
icon - String
entityName - String
dataKind - String
typeName - String
fullTypeName - String
maxLength - Float Column value max length. We use Float because it may be bigger than 32 bit
scale - Int
precision - Int
required - Boolean!
autoGenerated - Boolean!
readOnly - Boolean!
readOnlyStatus - String
supportedOperations - [DataTypeLogicalOperation!]! Operations supported for this attribute
Example
{
  "position": 123,
  "name": "abc123",
  "label": "xyz789",
  "icon": "abc123",
  "entityName": "abc123",
  "dataKind": "xyz789",
  "typeName": "xyz789",
  "fullTypeName": "xyz789",
  "maxLength": 123.45,
  "scale": 123,
  "precision": 987,
  "required": false,
  "autoGenerated": false,
  "readOnly": false,
  "readOnlyStatus": "abc123",
  "supportedOperations": [DataTypeLogicalOperation]
}

SQLResultRow

Fields
Input Field Description
data - [Object]!
updateValues - Object
metaData - Object
Example
{
  "data": [Object],
  "updateValues": Object,
  "metaData": Object
}

SQLResultRowMetaData

Fields
Field Name Description
data - [Object]!
metaData - Object
Example
{
  "data": [Object],
  "metaData": Object
}

SQLResultRowMetaDataInput

Fields
Input Field Description
data - [Object]
metaData - Object!
Example
{
  "data": [Object],
  "metaData": Object
}

SQLResultSet

Fields
Field Name Description
id - ID! Result set ID
columns - [SQLResultColumn] Returns list of columns in the result set
rows - [Object] Returns list of rows in the result set. Each row is an array of column values use rowsWithMetaData (23.3.5)
rowsWithMetaData - [SQLResultRowMetaData] Returns list of rows in the result set. Each row contains data and metadata
singleEntity - Boolean! True means that resultset was generated by single entity query New rows can be added, old rows can be deleted
hasMoreData - Boolean! server always returns hasMoreData = false
hasRowIdentifier - Boolean! Identifies if result set has row identifier. If true then it is possible update data or load LOB files
hasChildrenCollection - Boolean! Identifies if result has children collections. If true then children collections can be read from the result set
hasDynamicTrace - Boolean! Identifies if result set supports dynamic trace. If true then dynamic trace can be read from the result set
isSupportsDataFilter - Boolean! Identifies if result set supports data filter. If true then data filter can be applied to the result set
readOnly - Boolean! Identifies if result set is read-only. If true then no updates are allowed
readOnlyStatus - String Status of read-only result set. If readOnly is true then this field contains reason why result set is read-only
Example
{
  "id": 4,
  "columns": [SQLResultColumn],
  "rows": [Object],
  "rowsWithMetaData": [SQLResultRowMetaData],
  "singleEntity": true,
  "hasMoreData": false,
  "hasRowIdentifier": false,
  "hasChildrenCollection": false,
  "hasDynamicTrace": true,
  "isSupportsDataFilter": true,
  "readOnly": false,
  "readOnlyStatus": "abc123"
}

SQLScriptInfo

Fields
Field Name Description
queries - [SQLScriptQuery!]!
Example
{"queries": [SQLScriptQuery]}

SQLScriptQuery

Fields
Field Name Description
start - Int!
end - Int!
Example
{"start": 987, "end": 987}

SecretConfiguration

Fields
Field Name Description
configurationId - String!
configurationName - String!
providerId - String!
description - String
parameters - [ObjectPropertyInfo!]!
Example
{
  "configurationId": "abc123",
  "configurationName": "abc123",
  "providerId": "xyz789",
  "description": "abc123",
  "parameters": [ObjectPropertyInfo]
}

SecretConfigurationInput

Fields
Input Field Description
configurationId - String!
configurationName - String!
providerId - String!
description - String
parameters - Object!
Example
{
  "configurationId": "abc123",
  "configurationName": "xyz789",
  "providerId": "xyz789",
  "description": "abc123",
  "parameters": Object
}

SecretInfo

Fields
Field Name Description
displayName - String!
secretId - String!
Example
{
  "displayName": "xyz789",
  "secretId": "xyz789"
}

SecretManagementInfo

Fields
Field Name Description
id - String!
label - String!
description - String!
configurationId - String
configurationName - String
Example
{
  "id": "xyz789",
  "label": "xyz789",
  "description": "abc123",
  "configurationId": "xyz789",
  "configurationName": "abc123"
}

ServerConfig

Description

Server configuration

Fields
Field Name Description
name - String! Server name
version - String! Version of the server
workspaceId - ID! ID of the server workspace
anonymousAccessEnabled - Boolean! Defines if the anonymous access is enabled
supportsCustomConnections - Boolean! Defines if non-admin users can create connections
resourceManagerEnabled - Boolean! Defines if resource manager is enabled
secretManagerEnabled - Boolean! Defines if secret manager is enabled
publicCredentialsSaveEnabled - Boolean! Defines is it is possible to save user database credentials
adminCredentialsSaveEnabled - Boolean! Defines is it is possible to save global database credentials
licenseRequired - Boolean! Defines if the server requires a license
licenseValid - Boolean! Defines if the server license is valid
licenseStatus - String Returns information about the server license status
configurationMode - Boolean! Defines if the server is in configuration mode
developmentMode - Boolean! Defines if the server is in development mode
distributed - Boolean! Defines if the server is distributed
enabledFeatures - [ID!]! List of enabled features
disabledBetaFeatures - [ID!] List of disabled beta features
serverFeatures - [ID!] List of server features
supportedLanguages - [ServerLanguage!]! List of supported languages
productConfiguration - Object! Product configuration
productInfo - ProductInfo! Product information
defaultNavigatorSettings - NavigatorSettings! Navigator settings for the server
disabledDrivers - [ID!]! List of disabled drivers (IDs of DriverInfo)
resourceQuotas - Object! Resource quotas (e.g., max amount of running SQL queries)
Example
{
  "name": "xyz789",
  "version": "xyz789",
  "workspaceId": 4,
  "anonymousAccessEnabled": true,
  "supportsCustomConnections": true,
  "resourceManagerEnabled": true,
  "secretManagerEnabled": true,
  "publicCredentialsSaveEnabled": false,
  "adminCredentialsSaveEnabled": false,
  "licenseRequired": true,
  "licenseValid": true,
  "licenseStatus": "abc123",
  "configurationMode": true,
  "developmentMode": true,
  "distributed": false,
  "enabledFeatures": [4],
  "disabledBetaFeatures": ["4"],
  "serverFeatures": ["4"],
  "supportedLanguages": [ServerLanguage],
  "productConfiguration": Object,
  "productInfo": ProductInfo,
  "defaultNavigatorSettings": NavigatorSettings,
  "disabledDrivers": ["4"],
  "resourceQuotas": Object
}

ServerConfigInput

Fields
Input Field Description
serverName - String
serverURL - String
adminName - String
adminPassword - String
anonymousAccessEnabled - Boolean
authenticationEnabled - Boolean
customConnectionsEnabled - Boolean
publicCredentialsSaveEnabled - Boolean
adminCredentialsSaveEnabled - Boolean
resourceManagerEnabled - Boolean
secretManagerEnabled - Boolean
enabledFeatures - [ID!]
enabledAuthProviders - [ID!]
disabledDrivers - [ID!]
sessionExpireTime - Int
Example
{
  "serverName": "abc123",
  "serverURL": "xyz789",
  "adminName": "xyz789",
  "adminPassword": "abc123",
  "anonymousAccessEnabled": false,
  "authenticationEnabled": false,
  "customConnectionsEnabled": false,
  "publicCredentialsSaveEnabled": false,
  "adminCredentialsSaveEnabled": true,
  "resourceManagerEnabled": false,
  "secretManagerEnabled": true,
  "enabledFeatures": [4],
  "enabledAuthProviders": [4],
  "disabledDrivers": [4],
  "sessionExpireTime": 123
}

ServerError

Description

Various server errors descriptor

Fields
Field Name Description
message - String Error message text
errorCode - String Retrieves the vendor-specific error code
errorType - String Type/category of the error
stackTrace - String Stack trace for debugging
causedBy - ServerError Nested error that caused this error (recursive)
Example
{
  "message": "abc123",
  "errorCode": "xyz789",
  "errorType": "xyz789",
  "stackTrace": "xyz789",
  "causedBy": ServerError
}

ServerLanguage

Description

Languages supported by server

Fields
Field Name Description
isoCode - String! ISO 639-1 or similar language code (e.g., "en", "ru")
displayName - String Display name of the language in the current locale (e.g., "English")
nativeName - String Native name of the language (e.g., "English", "Русский")
Example
{
  "isoCode": "abc123",
  "displayName": "abc123",
  "nativeName": "xyz789"
}

SessionInfo

Fields
Field Name Description
createTime - String! The time when the session was created
lastAccessTime - String! The last time the session was accessed
locale - String! The current locale of the session
cacheExpired - Boolean! Indicates whether the session cache has expired
connections - [ConnectionInfo!]! List of active connections in the session
actionParameters - Object Action parameters for the session (e.g., opening a connection)
valid - Boolean! Indicates if the session is valid
remainingTime - Int! Remaining time before the session expires (in seconds)
Example
{
  "createTime": "abc123",
  "lastAccessTime": "abc123",
  "locale": "abc123",
  "cacheExpired": true,
  "connections": [ConnectionInfo],
  "actionParameters": Object,
  "valid": false,
  "remainingTime": 987
}

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example
"xyz789"

SubCollectionInfo

Fields
Field Name Description
icon - String! The icon path for the subcollection
name - String! The name of the subcollection
path - String! The path to the subcollection
Example
{
  "icon": "abc123",
  "name": "xyz789",
  "path": "abc123"
}

TeamInfo

Description

Team information for managing secrets.

Fields
Field Name Description
teamId - String! ID of the team.
teamName - String! Name of the team.
Example
{
  "teamId": "abc123",
  "teamName": "xyz789"
}

TransactionLogInfoItem

Fields
Field Name Description
id - Int!
time - DateTime!
type - String!
queryString - String!
durationMs - Int!
rows - Int!
result - String!
Example
{
  "id": 123,
  "time": "2007-12-03T10:15:30Z",
  "type": "abc123",
  "queryString": "abc123",
  "durationMs": 123,
  "rows": 987,
  "result": "xyz789"
}

TransactionLogInfos

Fields
Field Name Description
count - Int!
transactionLogInfos - [TransactionLogInfoItem!]!
Example
{
  "count": 987,
  "transactionLogInfos": [TransactionLogInfoItem]
}

UserAuthToken

Fields
Field Name Description
authProvider - ID! Auth provider used for authorization
authConfiguration - ID Auth provider configuration ID
loginTime - DateTime! Authorization time
userId - String! User identity (aka user name) specific to auth provider
displayName - String! User display name specific to auth provider
message - String Optional login message
origin - ObjectOrigin! Auth origin
Example
{
  "authProvider": "4",
  "authConfiguration": 4,
  "loginTime": "2007-12-03T10:15:30Z",
  "userId": "abc123",
  "displayName": "abc123",
  "message": "xyz789",
  "origin": ObjectOrigin
}

UserImportList

Description

Input for importing users for provisioning.

Fields
Input Field Description
users - [ExternalUserInput!]! List of users to be imported for provisioning.
authRole - String Auth role to be assigned to the users (see listAuthRoles).
Example
{
  "users": [ExternalUserInput],
  "authRole": "abc123"
}

UserInfo

Fields
Field Name Description
userId - ID! User unique identifier
displayName - String Human readable display name. It is taken from the first auth provider which was used for user login.
authRole - ID User auth role ID. Optional.
authTokens - [UserAuthToken!]! All authentication tokens used during current session
linkedAuthProviders - [String!]!
metaParameters - Object! User profile properties map
configurationParameters - Object! User configuration parameters
teams - [UserTeamInfo!]! User teams
isAnonymous - Boolean! Indicates whether the user is anonymous (not authenticated).
Example
{
  "userId": 4,
  "displayName": "xyz789",
  "authRole": 4,
  "authTokens": [UserAuthToken],
  "linkedAuthProviders": ["xyz789"],
  "metaParameters": Object,
  "configurationParameters": Object,
  "teams": [UserTeamInfo],
  "isAnonymous": false
}

UserTeamInfo

Fields
Field Name Description
teamId - String!
teamName - String!
teamRole - String
Example
{
  "teamId": "xyz789",
  "teamName": "abc123",
  "teamRole": "xyz789"
}

VQBAssociationInput

Fields
Input Field Description
source - VQBEntityAttributeReferenceInput
target - VQBEntityAttributeReferenceInput
type - VQBAssociationType
Example
{
  "source": VQBEntityAttributeReferenceInput,
  "target": VQBEntityAttributeReferenceInput,
  "type": "WHERE"
}

VQBAssociationType

Description

Enum representing the type of association.

Values
Enum Value Description

WHERE

JOIN

Example
"WHERE"

VQBDataInput

Fields
Input Field Description
entities - [VQBEntityInput!]!
associations - [VQBAssociationInput!]
whereString - String
Example
{
  "entities": [VQBEntityInput],
  "associations": [VQBAssociationInput],
  "whereString": "abc123"
}

VQBEntityAttributeInput

Fields
Input Field Description
name - String!
alias - String
expression - String
checked - Boolean
order - VQBEntityAttributeOrderType
orderIndex - Int
Example
{
  "name": "xyz789",
  "alias": "xyz789",
  "expression": "xyz789",
  "checked": true,
  "order": "ASC",
  "orderIndex": 987
}

VQBEntityAttributeOrderType

Description

Enum representing the order type for attributes.

Values
Enum Value Description

ASC

DESC

Example
"ASC"

VQBEntityAttributeReferenceInput

Fields
Input Field Description
entityId - Int!
attribute - String
Example
{"entityId": 987, "attribute": "xyz789"}

VQBEntityInput

Fields
Input Field Description
id - Int!
name - String!
alias - String
fqn - String
nodeId - ID
attributes - [VQBEntityAttributeInput!]
operator - VQBLogicalOperator
joinType - VQBJoinType
Example
{
  "id": 123,
  "name": "xyz789",
  "alias": "xyz789",
  "fqn": "xyz789",
  "nodeId": "4",
  "attributes": [VQBEntityAttributeInput],
  "operator": "ALL",
  "joinType": "SIMPLE"
}

VQBJoinType

Description

Enum representing the type of join operation.

Values
Enum Value Description

SIMPLE

CROSS

INNER

LEFT

LEFT_OUTER

RIGHT

RIGHT_OUTER

FULL

FULL_OUTER

Example
"SIMPLE"

VQBLogicalOperator

Description

Enum representing the logical operators used in VQB queries.

Values
Enum Value Description

ALL

AND

ANY

BETWEEN

EXISTS

IN

LIKE

NOT

OR

SOME

Example
"ALL"

VQBQueryConfigInput

Fields
Input Field Description
data - VQBDataInput
Example
{"data": VQBDataInput}

WebFeatureSet

Fields
Field Name Description
id - String!
label - String!
description - String
icon - String
enabled - Boolean!
Example
{
  "id": "abc123",
  "label": "xyz789",
  "description": "xyz789",
  "icon": "abc123",
  "enabled": true
}