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/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`

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": "xyz789",
      "ownerCompany": "xyz789",
      "ownerName": "abc123",
      "ownerEmail": "xyz789",
      "usersNumber": 987,
      "yearsNumber": 123,
      "subscription": true,
      "unlimitedServers": false,
      "multiInstance": true,
      "serversNumber": 123,
      "licenseIssueTime": "abc123",
      "licenseStartTime": "abc123",
      "licenseEndTime": "xyz789",
      "licenseRoles": [LMLicenseRole],
      "licenseStatus": LMLicenseStatusDetails
    }
  }
}

Queries

`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": true
    }
  }
}

Queries

`addConnectionsAccess`

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": false}}

Queries

`adminUserInfo`

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": ["abc123"],
      "enabled": true,
      "authRole": "xyz789",
      "disableDate": "2007-12-03T10:15:30Z",
      "disabledBy": "abc123",
      "disableReason": "abc123"
    }
  }
}

Queries

`aiListEngineProperties`

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": "abc123",
        "displayName": "xyz789",
        "description": "abc123",
        "hint": "xyz789",
        "category": "abc123",
        "dataType": "xyz789",
        "value": Object,
        "validValues": [Object],
        "defaultValue": Object,
        "length": "TINY",
        "features": ["abc123"],
        "order": 987,
        "supportedConfigurationTypes": [
          "xyz789"
        ],
        "required": true,
        "scopes": ["xyz789"],
        "conditions": [Condition]
      }
    ]
  }
}

Queries

`aiListEngines`

Response

Returns [AIEngineInfo!]

Example

Query

query aiListEngines {
  aiListEngines {
    id
    name
  }
}

Response

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

Queries

`aiSettings`

Response

Returns an AISettingsInfo!

Example

Query

query aiSettings {
  aiSettings {
    activeEngine
  }
}

Response

{
  "data": {
    "aiSettings": {"activeEngine": "4"}
  }
}

Queries

`allProductLicenses`

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": "abc123",
        "licenseType": "abc123",
        "ownerCompany": "abc123",
        "ownerName": "xyz789",
        "ownerEmail": "abc123",
        "usersNumber": 123,
        "yearsNumber": 123,
        "subscription": false,
        "unlimitedServers": false,
        "multiInstance": false,
        "serversNumber": 987,
        "licenseIssueTime": "abc123",
        "licenseStartTime": "xyz789",
        "licenseEndTime": "xyz789",
        "licenseRoles": [LMLicenseRole],
        "licenseStatus": LMLicenseStatusDetails
      }
    ]
  }
}

Queries

`asyncDbSmSessions`

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
    }
    result {
      ...SQLExecuteInfoFragment
    }
    taskResult
  }
}

Variables

{
  "projectId": 4,
  "connectionId": "4",
  "limit": 987
}

Response

{
  "data": {
    "asyncDbSmSessions": {
      "id": "xyz789",
      "name": "xyz789",
      "running": true,
      "status": "xyz789",
      "error": ServerError,
      "result": SQLExecuteInfo,
      "taskResult": Object
    }
  }
}

Queries

`asyncDbSmSessionsResult`

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"
      }
    ]
  }
}

Queries

`authChangeLocalPassword`

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": "abc123",
  "newPassword": "xyz789"
}

Response

{"data": {"authChangeLocalPassword": false}}

Queries

`authLogin`

Description

Authorize user using specified auth provider. If linkUser=true then associates new If forceSessionsLogout=true then kill another sessions

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": true,
  "forceSessionsLogout": true
}

Response

{
  "data": {
    "authLogin": {
      "redirectLink": "xyz789",
      "authId": "abc123",
      "authStatus": "SUCCESS",
      "userTokens": [UserAuthToken]
    }
  }
}

Queries

`authLogout`

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": true}}

Queries

`authLogoutExtended`

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"]
    }
  }
}

Queries

`authModels`

Response

Returns [DatabaseAuthModel!]!

Example

Query

query authModels {
  authModels {
    id
    displayName
    description
    icon
    requiresLocalConfiguration
    requiredAuth
    properties {
      ...ObjectPropertyInfoFragment
    }
  }
}

Response

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

Queries

`authProviders`

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": "xyz789",
        "icon": "4",
        "description": "abc123",
        "defaultProvider": true,
        "trusted": true,
        "private": true,
        "authHidden": false,
        "supportProvisioning": true,
        "configurable": true,
        "federated": false,
        "configurations": [AuthProviderConfiguration],
        "templateConfiguration": AuthProviderConfiguration,
        "credentialProfiles": [
          AuthProviderCredentialsProfile
        ],
        "requiredFeatures": ["abc123"],
        "required": false
      }
    ]
  }
}

Queries

`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": false}

Response

{
  "data": {
    "authUpdateStatus": {
      "redirectLink": "abc123",
      "authId": "xyz789",
      "authStatus": "SUCCESS",
      "userTokens": [UserAuthToken]
    }
  }
}

Queries

`awsAdminX`

Response

Returns a Boolean

Example

Query

query awsAdminX {
  awsAdminX
}

Response

{"data": {"awsAdminX": true}}

Queries

`awsAvailableRegions`

Description

List of available regions

Response

Returns [AWSRegion!]!

Example

Query

query awsAvailableRegions {
  awsAvailableRegions {
    id
    displayName
    superRegion
    global
    partition
    domain
  }
}

Response

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

Queries

`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": "abc123",
      "allowedAccounts": ["abc123"],
      "regions": ["xyz789"],
      "federatedAccessEnabled": true,
      "govRegionsEnabled": true,
      "proxyUser": AWSUserInfo,
      "useDefaultCredentials": true,
      "assumeRoleName": "abc123"
    }
  }
}

Queries

`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": ["abc123"],
      "amiId": "abc123",
      "agreementId": "xyz789",
      "defaultRegion": "abc123",
      "accountRegions": ["xyz789"]
    }
  }
}

Queries

`awsPartitions`

Description

List of available partitions

Response

Returns [AWSPartition!]!

Example

Query

query awsPartitions {
  awsPartitions {
    id
    name
  }
}

Response

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

Queries

`awsSetSessionRegions`

Response

Returns a Boolean

Arguments

Name	Description
`regions` - `[String!]!`

Example

Query

query awsSetSessionRegions($regions: [String!]!) {
  awsSetSessionRegions(regions: $regions)
}

Variables

{"regions": ["xyz789"]}

Response

{"data": {"awsSetSessionRegions": true}}

Queries

`awsUserInfo`

24.3.1, use awsSetRegions

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": "abc123",
      "userPath": "abc123",
      "userArn": "xyz789",
      "accountId": "abc123",
      "organizationName": "abc123",
      "createDate": "2007-12-03T10:15:30Z",
      "tags": [AWSTag]
    }
  }
}

Queries

`configureServer`

Response

Returns a Boolean!

Arguments

Name	Description
`configuration` - `ServerConfigInput!`

Example

Query

query configureServer($configuration: ServerConfigInput!) {
  configureServer(configuration: $configuration)
}

Variables

{"configuration": ServerConfigInput}

Response

{"data": {"configureServer": false}}

Queries

`connectionFolders`

Description

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": "abc123"
      }
    ]
  }
}

Queries

`connectionInfo`

Description

Return 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": "xyz789",
      "description": "xyz789",
      "host": "xyz789",
      "port": "xyz789",
      "serverName": "xyz789",
      "databaseName": "xyz789",
      "url": "abc123",
      "mainPropertyValues": Object,
      "keepAliveInterval": 987,
      "autocommit": true,
      "properties": Object,
      "connected": true,
      "provided": false,
      "readOnly": false,
      "useUrl": true,
      "saveCredentials": true,
      "sharedCredentials": false,
      "sharedSecrets": [SecretInfo],
      "credentialsSaved": false,
      "authNeeded": true,
      "folder": 4,
      "nodePath": "abc123",
      "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": true,
      "canDelete": true,
      "projectId": 4,
      "requiredAuth": "xyz789",
      "defaultCatalogName": "abc123",
      "defaultSchemaName": "abc123",
      "tools": ["abc123"]
    }
  }
}

Queries

`createTeam`

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": "abc123",
  "description": "xyz789"
}

Response

{
  "data": {
    "createTeam": {
      "teamId": 4,
      "teamName": "xyz789",
      "description": "xyz789",
      "metaParameters": Object,
      "grantedUsers": [4],
      "grantedUsersInfo": [AdminUserTeamGrantInfo],
      "grantedConnections": [AdminConnectionGrantInfo],
      "teamPermissions": [4]
    }
  }
}

Queries

`createUser`

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": ["abc123"],
      "enabled": true,
      "authRole": "xyz789",
      "disableDate": "2007-12-03T10:15:30Z",
      "disabledBy": "abc123",
      "disableReason": "abc123"
    }
  }
}

Queries

`dataTransferAvailableImportStreamProcessors`

Description

Available transfer processors for import file

Response

Returns [DataTransferProcessorInfo!]!

Example

Query

query dataTransferAvailableImportStreamProcessors {
  dataTransferAvailableImportStreamProcessors {
    id
    name
    description
    fileExtension
    appFileExtension
    appName
    order
    icon
    properties {
      ...ObjectPropertyInfoFragment
    }
    isBinary
    isHTML
  }
}

Response

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

Queries

`dataTransferAvailableStreamProcessors`

Description

Available transfer processors

Response

Returns [DataTransferProcessorInfo!]!

Example

Query

query dataTransferAvailableStreamProcessors {
  dataTransferAvailableStreamProcessors {
    id
    name
    description
    fileExtension
    appFileExtension
    appName
    order
    icon
    properties {
      ...ObjectPropertyInfoFragment
    }
    isBinary
    isHTML
  }
}

Response

{
  "data": {
    "dataTransferAvailableStreamProcessors": [
      {
        "id": "4",
        "name": "abc123",
        "description": "abc123",
        "fileExtension": "abc123",
        "appFileExtension": "abc123",
        "appName": "xyz789",
        "order": 987,
        "icon": "xyz789",
        "properties": [ObjectPropertyInfo],
        "isBinary": true,
        "isHTML": false
      }
    ]
  }
}

Queries

`dataTransferDefaultExportSettings`

Response

Returns a DataTransferDefaultExportSettings!

Example

Query

query dataTransferDefaultExportSettings {
  dataTransferDefaultExportSettings {
    outputSettings {
      ...DataTransferOutputSettingsFragment
    }
    supportedEncodings
  }
}

Response

{
  "data": {
    "dataTransferDefaultExportSettings": {
      "outputSettings": DataTransferOutputSettings,
      "supportedEncodings": ["abc123"]
    }
  }
}

Queries

`dataTransferExportDataFromContainer`

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
    }
    result {
      ...SQLExecuteInfoFragment
    }
    taskResult
  }
}

Variables

{
  "projectId": 4,
  "connectionId": 4,
  "containerNodePath": "4",
  "parameters": DataTransferParameters
}

Response

{
  "data": {
    "dataTransferExportDataFromContainer": {
      "id": "xyz789",
      "name": "abc123",
      "running": true,
      "status": "xyz789",
      "error": ServerError,
      "result": SQLExecuteInfo,
      "taskResult": Object
    }
  }
}

Queries

`dataTransferExportDataFromResults`

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
    }
    result {
      ...SQLExecuteInfoFragment
    }
    taskResult
  }
}

Variables

{
  "projectId": "4",
  "connectionId": 4,
  "contextId": "4",
  "resultsId": 4,
  "parameters": DataTransferParameters
}

Response

{
  "data": {
    "dataTransferExportDataFromResults": {
      "id": "xyz789",
      "name": "xyz789",
      "running": false,
      "status": "xyz789",
      "error": ServerError,
      "result": SQLExecuteInfo,
      "taskResult": Object
    }
  }
}

Queries

`dataTransferRemoveDataFile`

25.0.1

Response

Returns a Boolean

Arguments

Name	Description
`dataFileId` - `String!`

Example

Query

query dataTransferRemoveDataFile($dataFileId: String!) {
  dataTransferRemoveDataFile(dataFileId: $dataFileId)
}

Variables

{"dataFileId": "xyz789"}

Response

{"data": {"dataTransferRemoveDataFile": false}}

Queries

`dbSmTerminate`

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": ["xyz789"]
}

Response

{"data": {"dbSmTerminate": true}}

Queries

`deleteAuthProviderConfiguration`

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}}

Queries

`deleteConnectionsAccess`

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}}

Queries

`deleteSecretConfiguration`

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}}

Queries

`deleteTeam`

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": true}

Response

{"data": {"deleteTeam": false}}

Queries

`deleteUser`

Response

Returns a Boolean

Arguments

Name	Description
`userId` - `ID!`

Example

Query

query deleteUser($userId: ID!) {
  deleteUser(userId: $userId)
}

Variables

{"userId": "4"}

Response

{"data": {"deleteUser": true}}

Queries

`deleteUserCredentials`

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}}

Queries

`deleteUserMetaParameter`

Response

Returns a Boolean!

Arguments

Name	Description
`id` - `ID!`

Example

Query

query deleteUserMetaParameter($id: ID!) {
  deleteUserMetaParameter(id: $id)
}

Variables

{"id": "4"}

Response

{"data": {"deleteUserMetaParameter": false}}

Queries

`dmCertificateType`

Response

Returns a DomainCertificateType

Example

Query

query dmCertificateType {
  dmCertificateType
}

Response

{"data": {"dmCertificateType": "CUSTOM"}}

Queries

`dmOrganization`

Response

Returns an OrganizationInfo

Example

Query

query dmOrganization {
  dmOrganization {
    id
    baseDomain
    subdomain
    deployments {
      ...DeploymentInfoFragment
    }
    currentDeployment {
      ...DeploymentInfoFragment
    }
  }
}

Response

{
  "data": {
    "dmOrganization": {
      "id": 4,
      "baseDomain": "abc123",
      "subdomain": "xyz789",
      "deployments": [DeploymentInfo],
      "currentDeployment": DeploymentInfo
    }
  }
}

Queries

`dmStatusInfo`

Response

Returns a DomainManagerAvailability!

Example

Query

query dmStatusInfo {
  dmStatusInfo {
    certbot
    server
    externalStatus
  }
}

Response

{
  "data": {
    "dmStatusInfo": {
      "certbot": false,
      "server": false,
      "externalStatus": "AWS_MARKETPLACE_AGREEMENT_NOT_FOUND"
    }
  }
}

Queries

`dmVerifyDeploymentAddress`

Response

Returns a DeploymentAddressVerificationInfo!

Arguments

Name	Description
`address` - `String!`

Example

Query

query dmVerifyDeploymentAddress($address: String!) {
  dmVerifyDeploymentAddress(address: $address) {
    valid
    message
  }
}

Variables

{"address": "xyz789"}

Response

{
  "data": {
    "dmVerifyDeploymentAddress": {
      "valid": true,
      "message": "xyz789"
    }
  }
}

Queries

`driverList`

Description

Get driver info

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": "xyz789",
        "icon": "xyz789",
        "iconBig": "xyz789",
        "driverId": "4",
        "providerId": "4",
        "driverClassName": "abc123",
        "defaultHost": "abc123",
        "defaultPort": "abc123",
        "defaultDatabase": "xyz789",
        "defaultServer": "xyz789",
        "defaultUser": "abc123",
        "sampleURL": "abc123",
        "driverInfoURL": "abc123",
        "driverPropertiesURL": "abc123",
        "embedded": true,
        "enabled": true,
        "requiresServerName": false,
        "requiresDatabaseName": false,
        "useCustomPage": false,
        "licenseRequired": false,
        "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": false,
        "driverLibraries": [DriverLibraryInfo],
        "safeEmbeddedDriver": false
      }
    ]
  }
}

Queries

`driverProviderList`

Response

Returns [DriverProviderInfo!]!

Example

Query

query driverProviderList {
  driverProviderList {
    id
    name
    icon
  }
}

Response

{
  "data": {
    "driverProviderList": [
      {
        "id": 4,
        "name": "xyz789",
        "icon": "xyz789"
      }
    ]
  }
}

Queries

`emptyEvent`

Response

Returns a Boolean

Example

Query

query emptyEvent {
  emptyEvent
}

Response

{"data": {"emptyEvent": true}}

Queries

`enableUser`

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": true}

Response

{"data": {"enableUser": false}}

Queries

`federatedAuthTaskResult`

No longer supported

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]
    }
  }
}

Queries

`fsFile`

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": 123,
      "folder": false,
      "metaData": Object,
      "nodePath": "xyz789"
    }
  }
}

Queries

`fsFileSystem`

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"
    }
  }
}

Queries

`fsListFileSystems`

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"
      }
    ]
  }
}

Queries

`fsListFiles`

Response

Returns [FSFile!]!

Arguments

Name	Description
`folderPath` - `String!`

Example

Query

query fsListFiles($folderPath: String!) {
  fsListFiles(folderPath: $folderPath) {
    name
    length
    folder
    metaData
    nodePath
  }
}

Variables

{"folderPath": "xyz789"}

Response

{
  "data": {
    "fsListFiles": [
      {
        "name": "xyz789",
        "length": 987,
        "folder": true,
        "metaData": Object,
        "nodePath": "abc123"
      }
    ]
  }
}

Queries

`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": "xyz789"}

Response

{
  "data": {
    "fsReadFileContentAsString": "abc123"
  }
}

Queries

`generateEntityDiagram`

No longer supported

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}}

Queries

`generateEntityDiagramExtended`

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": "abc123",
      "orderBy": ["xyz789"],
      "selectItems": ["xyz789"]
    }
  }
}

Queries

`getConnectionSubjectAccess`

23.2.2

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"
      }
    ]
  }
}

Queries

`getSecretManagerConfigurationParameters`

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": "xyz789",
        "description": "abc123",
        "hint": "xyz789",
        "category": "abc123",
        "dataType": "xyz789",
        "value": Object,
        "validValues": [Object],
        "defaultValue": Object,
        "length": "TINY",
        "features": ["abc123"],
        "order": 123,
        "supportedConfigurationTypes": [
          "xyz789"
        ],
        "required": true,
        "scopes": ["abc123"],
        "conditions": [Condition]
      }
    ]
  }
}

Queries

`getSubjectConnectionAccess`

23.2.2

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"
      }
    ]
  }
}

Queries

`gitGetGlobalSettings`

Description

null if git wasn't configured

Response

Returns a GitGlobalSettings

Example

Query

query gitGetGlobalSettings {
  gitGetGlobalSettings {
    username
    email
    password
  }
}

Response

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

Queries

`gitGetProjectSettings`

Description

null if git wasn't configured for 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": false,
      "repositoryUrl": "abc123",
      "branch": "xyz789",
      "gitIgnoreRules": ["DATASOURCES"]
    }
  }
}

Queries

`grantUserTeam`

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}}

Queries

`listAuthProviderConfigurationParameters`

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": "xyz789",
        "displayName": "abc123",
        "description": "abc123",
        "hint": "abc123",
        "category": "xyz789",
        "dataType": "xyz789",
        "value": Object,
        "validValues": [Object],
        "defaultValue": Object,
        "length": "TINY",
        "features": ["abc123"],
        "order": 987,
        "supportedConfigurationTypes": [
          "xyz789"
        ],
        "required": true,
        "scopes": ["xyz789"],
        "conditions": [Condition]
      }
    ]
  }
}

Queries

`listAuthProviderConfigurations`

Response

Returns [AdminAuthProviderConfiguration!]!

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": false,
        "iconURL": "xyz789",
        "description": "xyz789",
        "parameters": Object,
        "signInLink": "xyz789",
        "signOutLink": "xyz789",
        "redirectLink": "abc123",
        "metadataLink": "xyz789",
        "acsLink": "xyz789",
        "entityIdLink": "xyz789"
      }
    ]
  }
}

Queries

`listAuthRoles`

Response

Returns [String!]!

Example

Query

query listAuthRoles {
  listAuthRoles
}

Response

{"data": {"listAuthRoles": ["xyz789"]}}

Queries

`listClouds`

Response

Returns [CBCloud!]

Example

Query

query listClouds {
  listClouds {
    id
    name
    authProvider
  }
}

Response

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

Queries

`listFeatureSets`

Response

Returns [WebFeatureSet!]!

Example

Query

query listFeatureSets {
  listFeatureSets {
    id
    label
    description
    icon
    enabled
  }
}

Response

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

Queries

`listPermissions`

Response

Returns [AdminPermissionInfo!]!

Example

Query

query listPermissions {
  listPermissions {
    id
    label
    description
    provider
    category
  }
}

Response

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

Queries

`listProjects`

Description

Return 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": false,
        "name": "xyz789",
        "description": "abc123",
        "canEditDataSources": true,
        "canViewDataSources": false,
        "canEditResources": true,
        "canViewResources": false,
        "resourceTypes": [RMResourceType]
      }
    ]
  }
}

Queries

`listTeamMetaParameters`

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": "abc123",
        "description": "xyz789",
        "hint": "abc123",
        "category": "xyz789",
        "dataType": "abc123",
        "value": Object,
        "validValues": [Object],
        "defaultValue": Object,
        "length": "TINY",
        "features": ["xyz789"],
        "order": 987,
        "supportedConfigurationTypes": [
          "xyz789"
        ],
        "required": true,
        "scopes": ["xyz789"],
        "conditions": [Condition]
      }
    ]
  }
}

Queries

`listTeamRoles`

Response

Returns [String!]!

Example

Query

query listTeamRoles {
  listTeamRoles
}

Response

{"data": {"listTeamRoles": ["xyz789"]}}

Queries

`listTeams`

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": "abc123",
        "description": "abc123",
        "metaParameters": Object,
        "grantedUsers": [4],
        "grantedUsersInfo": [AdminUserTeamGrantInfo],
        "grantedConnections": [AdminConnectionGrantInfo],
        "teamPermissions": [4]
      }
    ]
  }
}

Queries

`listUserProfileProperties`

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": "xyz789",
        "category": "xyz789",
        "dataType": "abc123",
        "value": Object,
        "validValues": [Object],
        "defaultValue": Object,
        "length": "TINY",
        "features": ["xyz789"],
        "order": 987,
        "supportedConfigurationTypes": [
          "abc123"
        ],
        "required": false,
        "scopes": ["abc123"],
        "conditions": [Condition]
      }
    ]
  }
}

Queries

`listUsers`

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": ["abc123"],
        "enabled": false,
        "authRole": "xyz789",
        "disableDate": "2007-12-03T10:15:30Z",
        "disabledBy": "xyz789",
        "disableReason": "abc123"
      }
    ]
  }
}

Queries

`metadataGetNodeDDL`

Description

Get child nodes

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": "abc123"}}

Queries

`metadataGetNodeExtendedDDL`

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"
  }
}

Queries

`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": "xyz789"
  }
}

Queries

`msListServices`

Response

Returns an MSServiceInfo

Example

Query

query msListServices {
  msListServices {
    id
    type
    endpoint
    nodes {
      ...MSServiceNodeFragment
    }
  }
}

Response

{
  "data": {
    "msListServices": {
      "id": "abc123",
      "type": "DOMAIN_CONTROLLER",
      "endpoint": "xyz789",
      "nodes": [MSServiceNode]
    }
  }
}

Queries

`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": true,
      "supportsSchemaChange": false
    }
  }
}

Queries

`navNodeChildren`

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": 123,
  "limit": 987,
  "onlyFolders": false
}

Response

{
  "data": {
    "navNodeChildren": [
      {
        "id": "4",
        "uri": "4",
        "name": "abc123",
        "fullName": "abc123",
        "plainName": "abc123",
        "icon": "xyz789",
        "description": "xyz789",
        "nodeType": "xyz789",
        "hasChildren": true,
        "projectId": "abc123",
        "object": DatabaseObjectInfo,
        "objectId": "abc123",
        "features": ["xyz789"],
        "nodeDetails": [ObjectPropertyInfo],
        "folder": true,
        "inline": false,
        "navigable": false,
        "filtered": false,
        "filter": NavigatorNodeFilter
      }
    ]
  }
}

Queries

`navNodeInfo`

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": "abc123",
      "fullName": "abc123",
      "plainName": "xyz789",
      "icon": "abc123",
      "description": "abc123",
      "nodeType": "xyz789",
      "hasChildren": false,
      "projectId": "abc123",
      "object": DatabaseObjectInfo,
      "objectId": "abc123",
      "features": ["xyz789"],
      "nodeDetails": [ObjectPropertyInfo],
      "folder": false,
      "inline": true,
      "navigable": false,
      "filtered": true,
      "filter": NavigatorNodeFilter
    }
  }
}

Queries

`navNodeParents`

Description

Get node's parents

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": ["xyz789"],
        "nodeDetails": [ObjectPropertyInfo],
        "folder": false,
        "inline": true,
        "navigable": true,
        "filtered": true,
        "filter": NavigatorNodeFilter
      }
    ]
  }
}

Queries

`navRefreshNode`

No longer supported

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}}

Queries

`networkHandlers`

Response

Returns [NetworkHandlerDescriptor!]!

Example

Query

query networkHandlers {
  networkHandlers {
    id
    codeName
    label
    description
    secured
    type
    properties {
      ...ObjectPropertyInfoFragment
    }
  }
}

Response

{
  "data": {
    "networkHandlers": [
      {
        "id": 4,
        "codeName": "abc123",
        "label": "xyz789",
        "description": "xyz789",
        "secured": false,
        "type": "TUNNEL",
        "properties": [ObjectPropertyInfo]
      }
    ]
  }
}

Queries

`productSettings`

Description

Return product settings

Response

Returns a ProductSettings!

Example

Query

query productSettings {
  productSettings {
    groups {
      ...ProductSettingsGroupFragment
    }
    settings {
      ...ObjectPropertyInfoFragment
    }
  }
}

Response

{
  "data": {
    "productSettings": {
      "groups": [ProductSettingsGroup],
      "settings": [ObjectPropertyInfo]
    }
  }
}

Queries

`provisioningListUsers`

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": "abc123",
        "metaParameters": Object,
        "authRole": "abc123"
      }
    ]
  }
}

Queries

`qmAccessibleUsers`

Response

Returns [String!]!

Example

Query

query qmAccessibleUsers {
  qmAccessibleUsers
}

Response

{"data": {"qmAccessibleUsers": ["abc123"]}}

Queries

`qmQueriesSearchAdmin`

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]
    }
  }
}

Queries

`qmQueriesSearchSupervisor`

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": true,
      "objects": [QMMObject]
    }
  }
}

Queries

`qmQueriesSearchUser`

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]
    }
  }
}

Queries

`readSessionLog`

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": "xyz789",
        "message": "xyz789",
        "stackTrace": "abc123"
      }
    ]
  }
}

Queries

`revokeUserTeam`

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}}

Queries

`rmGetDataSet`

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": "xyz789",
      "description": "xyz789",
      "draft": true,
      "queries": [DataSetQueryInfo],
      "datasetPath": "abc123",
      "projectId": 4
    }
  }
}

Queries

`rmListProjectGrantedPermissions`

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
      }
    ]
  }
}

Queries

`rmListProjectPermissions`

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"
      }
    ]
  }
}

Queries

`rmListProjects`

Description

List accessible projects

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": "abc123",
        "shared": false,
        "global": false,
        "createTime": "2007-12-03T10:15:30Z",
        "creator": "abc123",
        "projectPermissions": ["xyz789"],
        "resourceTypes": [RMResourceType]
      }
    ]
  }
}

Queries

`rmListResources`

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": "xyz789",
  "nameMask": "xyz789",
  "readProperties": true,
  "readHistory": true
}

Response

{
  "data": {
    "rmListResources": [
      {
        "name": "xyz789",
        "folder": false,
        "length": 987,
        "properties": Object
      }
    ]
  }
}

Queries

`rmListSharedProjects`

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": false,
        "createTime": "2007-12-03T10:15:30Z",
        "creator": "xyz789",
        "projectPermissions": ["xyz789"],
        "resourceTypes": [RMResourceType]
      }
    ]
  }
}

Queries

`rmListSubjectProjectsPermissionGrants`

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
      }
    ]
  }
}

Queries

`rmProject`

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": "xyz789"}

Response

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

Queries

`rmReadResourceAsString`

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": "abc123",
  "resourcePath": "xyz789"
}

Response

{
  "data": {
    "rmReadResourceAsString": "xyz789"
  }
}

Queries

`saveAuthProviderConfiguration`

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": "abc123",
  "disabled": true,
  "iconURL": "xyz789",
  "description": "abc123",
  "parameters": Object
}

Response

{
  "data": {
    "saveAuthProviderConfiguration": {
      "providerId": 4,
      "id": "4",
      "displayName": "xyz789",
      "disabled": false,
      "iconURL": "xyz789",
      "description": "abc123",
      "parameters": Object,
      "signInLink": "xyz789",
      "signOutLink": "abc123",
      "redirectLink": "xyz789",
      "metadataLink": "xyz789",
      "acsLink": "abc123",
      "entityIdLink": "abc123"
    }
  }
}

Queries

`saveSecretConfiguration`

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": "abc123",
      "configurationName": "xyz789",
      "providerId": "xyz789",
      "description": "xyz789",
      "parameters": [ObjectPropertyInfo]
    }
  }
}

Queries

`saveUserMetaParameter`

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": "abc123",
  "description": "abc123",
  "required": false
}

Response

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

Queries

`searchConnections`

Description

All connection configurations

Response

Returns [AdminConnectionSearchInfo!]!

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": 987,
        "possibleDrivers": [4],
        "defaultDriver": 4
      }
    ]
  }
}

Queries

`secretGetManageableTeams`

Response

Returns [TeamInfo!]!

Example

Query

query secretGetManageableTeams {
  secretGetManageableTeams {
    teamId
    teamName
  }
}

Response

{
  "data": {
    "secretGetManageableTeams": [
      {
        "teamId": "abc123",
        "teamName": "xyz789"
      }
    ]
  }
}

Queries

`secretListDataSourceSecrets`

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]
      }
    ]
  }
}

Queries

`secretManagementList`

Response

Returns [SecretManagementInfo!]!

Example

Query

query secretManagementList {
  secretManagementList {
    id
    label
    description
    configurationId
    configurationName
  }
}

Response

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

Queries

`secretProviderConfiguration`

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": "abc123",
        "providerId": "xyz789",
        "description": "xyz789",
        "parameters": [ObjectPropertyInfo]
      }
    ]
  }
}

Queries

`serverConfig`

Description

Return 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
    }
    services {
      ...WebServiceConfigFragment
    }
    productConfiguration
    productInfo {
      ...ProductInfoFragment
    }
    defaultNavigatorSettings {
      ...NavigatorSettingsFragment
    }
    disabledDrivers
    resourceQuotas
  }
}

Response

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

Queries

`sessionPermissions`

Description

Return session permissions

Response

Returns [ID]!

Example

Query

query sessionPermissions {
  sessionPermissions
}

Response

{"data": {"sessionPermissions": ["4"]}}

Queries

`sessionState`

Description

Return session state ( initialize if not )

Response

Returns a SessionInfo!

Example

Query

query sessionState {
  sessionState {
    createTime
    lastAccessTime
    locale
    cacheExpired
    serverMessages {
      ...ServerMessageFragment
    }
    connections {
      ...ConnectionInfoFragment
    }
    actionParameters
    valid
    remainingTime
  }
}

Response

{
  "data": {
    "sessionState": {
      "createTime": "abc123",
      "lastAccessTime": "xyz789",
      "locale": "abc123",
      "cacheExpired": true,
      "serverMessages": [ServerMessage],
      "connections": [ConnectionInfo],
      "actionParameters": Object,
      "valid": false,
      "remainingTime": 987
    }
  }
}

Queries

`setConnectionSubjectAccess`

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}}

Queries

`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}}

Queries

`setSubjectConnectionAccess`

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": false}}

Queries

`setSubjectPermissions`

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": "xyz789",
        "category": "abc123"
      }
    ]
  }
}

Queries

`setTeamMetaParameterValues`

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}}

Queries

`setUserAuthRole`

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": true}}

Queries

`setUserCredentials`

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}}

Queries

`setUserMetaParameterValues`

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": true}}

Queries

`setUserTeamRole`

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}}

Queries

`sqlCompletionProposals`

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": "xyz789",
  "position": 987,
  "maxResults": 123,
  "simpleMode": false
}

Response

{
  "data": {
    "sqlCompletionProposals": [
      {
        "displayString": "xyz789",
        "type": "xyz789",
        "score": 123,
        "replacementString": "xyz789",
        "replacementOffset": 987,
        "replacementLength": 987,
        "cursorPosition": 987,
        "icon": "xyz789",
        "nodePath": "abc123"
      }
    ]
  }
}

Queries

`sqlDialectInfo`

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": ["xyz789"],
      "quoteStrings": ["xyz789"],
      "singleLineComments": ["xyz789"],
      "multiLineComments": ["abc123"],
      "catalogSeparator": "abc123",
      "structSeparator": "abc123",
      "scriptDelimiter": "abc123",
      "supportsExplainExecutionPlan": true
    }
  }
}

Queries

`sqlEntityQueryGenerators`

Description

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": ["abc123"]}

Response

{
  "data": {
    "sqlEntityQueryGenerators": [
      {
        "id": "xyz789",
        "label": "xyz789",
        "description": "xyz789",
        "order": 987,
        "multiObject": true
      }
    ]
  }
}

Queries

`sqlFormatQuery`

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"}}

Queries

`sqlGenerateEntityQuery`

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"
  }
}

Queries

`sqlGenerateGroupingQuery`

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": ["xyz789"],
  "showDuplicatesOnly": true
}

Response

{
  "data": {
    "sqlGenerateGroupingQuery": "abc123"
  }
}

Queries

`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"
      }
    ]
  }
}

Queries

`sqlParseQuery`

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": 123
}

Response

{"data": {"sqlParseQuery": {"start": 987, "end": 987}}}

Queries

`sqlParseScript`

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": "abc123"
}

Response

{
  "data": {
    "sqlParseScript": {"queries": [SQLScriptQuery]}
  }
}

Queries

`sqlSupportedOperations`

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
      }
    ]
  }
}

Queries

`systemInfo`

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": "xyz789",
        "hint": "abc123",
        "category": "xyz789",
        "dataType": "abc123",
        "value": Object,
        "validValues": [Object],
        "defaultValue": Object,
        "length": "TINY",
        "features": ["xyz789"],
        "order": 987,
        "supportedConfigurationTypes": [
          "abc123"
        ],
        "required": false,
        "scopes": ["xyz789"],
        "conditions": [Condition]
      }
    ]
  }
}

Queries

`tokenApiList`

Description

returns list of user API tokens

Response

Returns [APITokenInfo!]!

Example

Query

query tokenApiList {
  tokenApiList {
    tokenName
    createTime
    expireTime
  }
}

Response

{
  "data": {
    "tokenApiList": [
      {
        "tokenName": "abc123",
        "createTime": "2007-12-03",
        "expireTime": "2007-12-03"
      }
    ]
  }
}

Queries

`updateTeam`

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": "xyz789",
  "description": "xyz789"
}

Response

{
  "data": {
    "updateTeam": {
      "teamId": 4,
      "teamName": "abc123",
      "description": "abc123",
      "metaParameters": Object,
      "grantedUsers": [4],
      "grantedUsersInfo": [AdminUserTeamGrantInfo],
      "grantedConnections": [AdminConnectionGrantInfo],
      "teamPermissions": ["4"]
    }
  }
}

Queries

`userConnections`

Description

Return 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": "xyz789",
        "port": "xyz789",
        "serverName": "abc123",
        "databaseName": "abc123",
        "url": "abc123",
        "mainPropertyValues": Object,
        "keepAliveInterval": 987,
        "autocommit": false,
        "properties": Object,
        "connected": false,
        "provided": true,
        "readOnly": true,
        "useUrl": false,
        "saveCredentials": false,
        "sharedCredentials": true,
        "sharedSecrets": [SecretInfo],
        "credentialsSaved": true,
        "authNeeded": true,
        "folder": "4",
        "nodePath": "abc123",
        "connectTime": "abc123",
        "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": true,
        "projectId": 4,
        "requiredAuth": "abc123",
        "defaultCatalogName": "abc123",
        "defaultSchemaName": "abc123",
        "tools": ["abc123"]
      }
    ]
  }
}

Queries

`vqbGenerateQuery`

No longer supported

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": "abc123"}}

Queries

`vqbParseQuery`

No longer supported

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": "abc123"
}

Response

{"data": {"vqbParseQuery": Object}}

Queries

`vqbParseQueryExtended`

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": "xyz789"
}

Response

{
  "data": {
    "vqbParseQueryExtended": {
      "entities": [ERDEntityInfo],
      "associations": [ERDAssociationInfo],
      "data": ERDDiagramData,
      "where": "xyz789",
      "orderBy": ["xyz789"],
      "selectItems": ["xyz789"]
    }
  }
}

Queries

`vqbReadEntityData`

No longer supported

Description

Reads information about database entities objectNodeIds contains node paths of entities returns data in ERD format (see ERD module API)

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}}

Queries

`vqbReadEntityDataExtended`

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": ["xyz789"],
      "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}}

Mutations

`aiSaveEngineConfiguration`

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": true}}

Mutations

`aiSaveSettings`

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}}}

Mutations

`asyncAiPerformQueryCompletion`

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
    }
    result {
      ...SQLExecuteInfoFragment
    }
    taskResult
  }
}

Variables

{
  "projectId": "4",
  "connectionId": "4",
  "contextId": 4,
  "request": "abc123"
}

Response

{
  "data": {
    "asyncAiPerformQueryCompletion": {
      "id": "xyz789",
      "name": "xyz789",
      "running": false,
      "status": "abc123",
      "error": ServerError,
      "result": SQLExecuteInfo,
      "taskResult": Object
    }
  }
}

Mutations

`asyncAiPerformQueryCompletionResult`

Response

Returns a String

Arguments

Name	Description
`taskId` - `ID!`

Example

Query

mutation asyncAiPerformQueryCompletionResult($taskId: ID!) {
  asyncAiPerformQueryCompletionResult(taskId: $taskId)
}

Variables

{"taskId": 4}

Response

{
  "data": {
    "asyncAiPerformQueryCompletionResult": "xyz789"
  }
}

Mutations

`asyncDmRegisterDeploymentDomain`

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
    }
    result {
      ...SQLExecuteInfoFragment
    }
    taskResult
  }
}

Variables

{
  "organizationSubdomain": "abc123",
  "deploymentSubdomain": "abc123",
  "ipAddress": "abc123"
}

Response

{
  "data": {
    "asyncDmRegisterDeploymentDomain": {
      "id": "xyz789",
      "name": "xyz789",
      "running": true,
      "status": "xyz789",
      "error": ServerError,
      "result": SQLExecuteInfo,
      "taskResult": Object
    }
  }
}

Mutations

`asyncDownloadDriverLibraries`

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
    }
    result {
      ...SQLExecuteInfoFragment
    }
    taskResult
  }
}

Variables

{"providerId": 4, "driverId": "4"}

Response

{
  "data": {
    "asyncDownloadDriverLibraries": {
      "id": "abc123",
      "name": "abc123",
      "running": true,
      "status": "xyz789",
      "error": ServerError,
      "result": SQLExecuteInfo,
      "taskResult": Object
    }
  }
}

Mutations

`asyncReadDataFromChildEntity`

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
    }
    result {
      ...SQLExecuteInfoFragment
    }
    taskResult
  }
}

Variables

{
  "projectId": "4",
  "connectionId": "4",
  "contextId": "4",
  "path": 4,
  "resultId": 4,
  "filter": SQLDataFilter,
  "dataFormat": "resultset"
}

Response

{
  "data": {
    "asyncReadDataFromChildEntity": {
      "id": "abc123",
      "name": "xyz789",
      "running": true,
      "status": "xyz789",
      "error": ServerError,
      "result": SQLExecuteInfo,
      "taskResult": Object
    }
  }
}

Mutations

`asyncReadDataFromContainer`

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
    }
    result {
      ...SQLExecuteInfoFragment
    }
    taskResult
  }
}

Variables

{
  "projectId": "4",
  "connectionId": 4,
  "contextId": "4",
  "containerNodePath": "4",
  "resultId": 4,
  "filter": SQLDataFilter,
  "dataFormat": "resultset"
}

Response

{
  "data": {
    "asyncReadDataFromContainer": {
      "id": "xyz789",
      "name": "abc123",
      "running": false,
      "status": "abc123",
      "error": ServerError,
      "result": SQLExecuteInfo,
      "taskResult": Object
    }
  }
}

Mutations

`asyncSqlCommitTransaction`

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
    }
    result {
      ...SQLExecuteInfoFragment
    }
    taskResult
  }
}

Variables

{"projectId": 4, "connectionId": 4, "contextId": 4}

Response

{
  "data": {
    "asyncSqlCommitTransaction": {
      "id": "abc123",
      "name": "xyz789",
      "running": true,
      "status": "abc123",
      "error": ServerError,
      "result": SQLExecuteInfo,
      "taskResult": Object
    }
  }
}

Mutations

`asyncSqlExecuteQuery`

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
    }
    result {
      ...SQLExecuteInfoFragment
    }
    taskResult
  }
}

Variables

{
  "projectId": 4,
  "connectionId": "4",
  "contextId": "4",
  "sql": "xyz789",
  "resultId": "4",
  "filter": SQLDataFilter,
  "dataFormat": "resultset",
  "readLogs": true
}

Response

{
  "data": {
    "asyncSqlExecuteQuery": {
      "id": "abc123",
      "name": "abc123",
      "running": true,
      "status": "xyz789",
      "error": ServerError,
      "result": SQLExecuteInfo,
      "taskResult": Object
    }
  }
}

Mutations

`asyncSqlExecuteResults`

Description

Returns SQLExecuteInfo

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": "xyz789",
      "duration": 123,
      "filterText": "xyz789",
      "fullQuery": "abc123",
      "results": [SQLQueryResults]
    }
  }
}

Mutations

`asyncSqlExplainExecutionPlan`

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
    }
    result {
      ...SQLExecuteInfoFragment
    }
    taskResult
  }
}

Variables

{
  "projectId": "4",
  "connectionId": "4",
  "contextId": 4,
  "query": "abc123",
  "configuration": Object
}

Response

{
  "data": {
    "asyncSqlExplainExecutionPlan": {
      "id": "xyz789",
      "name": "xyz789",
      "running": false,
      "status": "xyz789",
      "error": ServerError,
      "result": SQLExecuteInfo,
      "taskResult": Object
    }
  }
}

Mutations

`asyncSqlExplainExecutionPlanResult`

Description

Returns SQLExecutionPlan

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]
    }
  }
}

Mutations

`asyncSqlRollbackTransaction`

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
    }
    result {
      ...SQLExecuteInfoFragment
    }
    taskResult
  }
}

Variables

{
  "projectId": "4",
  "connectionId": "4",
  "contextId": 4
}

Response

{
  "data": {
    "asyncSqlRollbackTransaction": {
      "id": "abc123",
      "name": "abc123",
      "running": false,
      "status": "abc123",
      "error": ServerError,
      "result": SQLExecuteInfo,
      "taskResult": Object
    }
  }
}

Mutations

`asyncSqlRowDataCount`

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
    }
    result {
      ...SQLExecuteInfoFragment
    }
    taskResult
  }
}

Variables

{
  "projectId": "4",
  "connectionId": "4",
  "contextId": "4",
  "resultsId": "4"
}

Response

{
  "data": {
    "asyncSqlRowDataCount": {
      "id": "xyz789",
      "name": "abc123",
      "running": true,
      "status": "abc123",
      "error": ServerError,
      "result": SQLExecuteInfo,
      "taskResult": Object
    }
  }
}

Mutations

`asyncSqlRowDataCountResult`

Response

Returns an Int!

Arguments

Name	Description
`taskId` - `ID!`

Example

Query

mutation asyncSqlRowDataCountResult($taskId: ID!) {
  asyncSqlRowDataCountResult(taskId: $taskId)
}

Variables

{"taskId": 4}

Response

{"data": {"asyncSqlRowDataCountResult": 987}}

Mutations

`asyncSqlSetAutoCommit`

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
    }
    result {
      ...SQLExecuteInfoFragment
    }
    taskResult
  }
}

Variables

{
  "projectId": 4,
  "connectionId": "4",
  "contextId": "4",
  "autoCommit": false
}

Response

{
  "data": {
    "asyncSqlSetAutoCommit": {
      "id": "abc123",
      "name": "abc123",
      "running": true,
      "status": "abc123",
      "error": ServerError,
      "result": SQLExecuteInfo,
      "taskResult": Object
    }
  }
}

Mutations

`asyncTaskCancel`

Response

Returns a Boolean

Arguments

Name	Description
`id` - `String!`

Example

Query

mutation asyncTaskCancel($id: String!) {
  asyncTaskCancel(id: $id)
}

Variables

{"id": "abc123"}

Response

{"data": {"asyncTaskCancel": true}}

Mutations

`asyncTaskInfo`

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
    }
    result {
      ...SQLExecuteInfoFragment
    }
    taskResult
  }
}

Variables

{"id": "abc123", "removeOnFinish": false}

Response

{
  "data": {
    "asyncTaskInfo": {
      "id": "xyz789",
      "name": "xyz789",
      "running": false,
      "status": "abc123",
      "error": ServerError,
      "result": SQLExecuteInfo,
      "taskResult": Object
    }
  }
}

Mutations

`asyncUpdateResultsDataBatch`

25.0.0

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
    }
    result {
      ...SQLExecuteInfoFragment
    }
    taskResult
  }
}

Variables

{
  "projectId": "4",
  "connectionId": 4,
  "contextId": "4",
  "resultsId": "4",
  "updatedRows": [SQLResultRow],
  "deletedRows": [SQLResultRow],
  "addedRows": [SQLResultRow]
}

Response

{
  "data": {
    "asyncUpdateResultsDataBatch": {
      "id": "xyz789",
      "name": "xyz789",
      "running": true,
      "status": "xyz789",
      "error": ServerError,
      "result": SQLExecuteInfo,
      "taskResult": Object
    }
  }
}

Mutations

`awsEnableFederatedAccess`

No longer supported

Response

Returns a Boolean

Arguments

Name	Description
`enable` - `Boolean`

Example

Query

mutation awsEnableFederatedAccess($enable: Boolean) {
  awsEnableFederatedAccess(enable: $enable)
}

Variables

{"enable": false}

Response

{"data": {"awsEnableFederatedAccess": false}}

Mutations

`awsEnableGovRegions`

No longer supported

Response

Returns a Boolean!

Arguments

Name	Description
`enable` - `Boolean!`

Example

Query

mutation awsEnableGovRegions($enable: Boolean!) {
  awsEnableGovRegions(enable: $enable)
}

Variables

{"enable": true}

Response

{"data": {"awsEnableGovRegions": false}}

Mutations

`awsSetAssumeRoleName`

No longer supported

Response

Returns a Boolean!

Arguments

Name	Description
`roleName` - `String`

Example

Query

mutation awsSetAssumeRoleName($roleName: String) {
  awsSetAssumeRoleName(roleName: $roleName)
}

Variables

{"roleName": "abc123"}

Response

{"data": {"awsSetAssumeRoleName": false}}

Mutations

`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": false,
  "accessKey": "xyz789",
  "secretKey": "xyz789"
}

Response

{"data": {"awsSetProxyUser": false}}

Mutations

`awsSetRegions`

No longer supported

Response

Returns a Boolean!

Arguments

Name	Description
`regions` - `[String!]!`

Example

Query

mutation awsSetRegions($regions: [String!]!) {
  awsSetRegions(regions: $regions)
}

Variables

{"regions": ["abc123"]}

Response

{"data": {"awsSetRegions": true}}

Mutations

`awsUpdateCloudConfiguration`

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": "abc123",
      "allowedAccounts": ["abc123"],
      "regions": ["abc123"],
      "federatedAccessEnabled": true,
      "govRegionsEnabled": true,
      "proxyUser": AWSUserInfo,
      "useDefaultCredentials": true,
      "assumeRoleName": "abc123"
    }
  }
}

Mutations

`awsUpdateInstallConfiguration`

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": "abc123",
      "instanceType": "abc123",
      "instanceRole": "xyz789",
      "accountId": "xyz789",
      "version": "xyz789",
      "marketplaceProductCodes": ["xyz789"],
      "amiId": "xyz789",
      "agreementId": "xyz789",
      "defaultRegion": "xyz789",
      "accountRegions": ["xyz789"]
    }
  }
}

Mutations

`awsUseDefaultCredentials`

No longer supported

Response

Returns a Boolean!

Arguments

Name	Description
`enable` - `Boolean!`

Example

Query

mutation awsUseDefaultCredentials($enable: Boolean!) {
  awsUseDefaultCredentials(enable: $enable)
}

Variables

{"enable": false}

Response

{"data": {"awsUseDefaultCredentials": false}}

Mutations

`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": true}}

Mutations

`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": "abc123",
      "port": "xyz789",
      "serverName": "xyz789",
      "databaseName": "abc123",
      "url": "abc123",
      "mainPropertyValues": Object,
      "keepAliveInterval": 123,
      "autocommit": false,
      "properties": Object,
      "connected": true,
      "provided": false,
      "readOnly": true,
      "useUrl": true,
      "saveCredentials": false,
      "sharedCredentials": true,
      "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": ["xyz789"],
      "navigatorSettings": NavigatorSettings,
      "supportedDataFormats": ["resultset"],
      "configurationType": "MANUAL",
      "canViewSettings": false,
      "canEdit": true,
      "canDelete": true,
      "projectId": "4",
      "requiredAuth": "abc123",
      "defaultCatalogName": "xyz789",
      "defaultSchemaName": "xyz789",
      "tools": ["xyz789"]
    }
  }
}

Mutations

`closeSession`

Description

Destroy session

Response

Returns a Boolean

Example

Query

mutation closeSession {
  closeSession
}

Response

{"data": {"closeSession": false}}

Mutations

`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": "xyz789",
  "config": ConnectionConfig,
  "projectId": "4"
}

Response

{
  "data": {
    "copyConnectionFromNode": {
      "id": 4,
      "driverId": 4,
      "name": "abc123",
      "description": "xyz789",
      "host": "abc123",
      "port": "xyz789",
      "serverName": "abc123",
      "databaseName": "xyz789",
      "url": "xyz789",
      "mainPropertyValues": Object,
      "keepAliveInterval": 987,
      "autocommit": true,
      "properties": Object,
      "connected": true,
      "provided": true,
      "readOnly": true,
      "useUrl": true,
      "saveCredentials": false,
      "sharedCredentials": true,
      "sharedSecrets": [SecretInfo],
      "credentialsSaved": true,
      "authNeeded": false,
      "folder": 4,
      "nodePath": "abc123",
      "connectTime": "xyz789",
      "connectionError": ServerError,
      "serverVersion": "xyz789",
      "clientVersion": "xyz789",
      "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": "abc123",
      "defaultSchemaName": "xyz789",
      "tools": ["abc123"]
    }
  }
}

Mutations

`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": "xyz789",
      "port": "xyz789",
      "serverName": "abc123",
      "databaseName": "xyz789",
      "url": "abc123",
      "mainPropertyValues": Object,
      "keepAliveInterval": 987,
      "autocommit": true,
      "properties": Object,
      "connected": false,
      "provided": false,
      "readOnly": true,
      "useUrl": false,
      "saveCredentials": true,
      "sharedCredentials": true,
      "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": true,
      "canDelete": true,
      "projectId": 4,
      "requiredAuth": "xyz789",
      "defaultCatalogName": "abc123",
      "defaultSchemaName": "xyz789",
      "tools": ["xyz789"]
    }
  }
}

Mutations

`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": "abc123",
  "projectId": 4
}

Response

{
  "data": {
    "createConnectionFolder": {
      "id": "4",
      "projectId": "4",
      "description": "xyz789"
    }
  }
}

Mutations

`createConnectionFromCloudStorageFile`

Description

Create new custom connection from 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"
    }
  }
}

Mutations

`createDriver`

Description

Create new custom driver

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": "xyz789",
      "icon": "abc123",
      "iconBig": "abc123",
      "driverId": 4,
      "providerId": "4",
      "driverClassName": "xyz789",
      "defaultHost": "abc123",
      "defaultPort": "xyz789",
      "defaultDatabase": "abc123",
      "defaultServer": "xyz789",
      "defaultUser": "xyz789",
      "sampleURL": "xyz789",
      "driverInfoURL": "xyz789",
      "driverPropertiesURL": "xyz789",
      "embedded": false,
      "enabled": false,
      "requiresServerName": true,
      "requiresDatabaseName": false,
      "useCustomPage": false,
      "licenseRequired": false,
      "license": "abc123",
      "custom": true,
      "promotedScore": 123,
      "driverProperties": [ObjectPropertyInfo],
      "driverParameters": Object,
      "mainProperties": [ObjectPropertyInfo],
      "providerProperties": [ObjectPropertyInfo],
      "anonymousAccess": true,
      "defaultAuthModel": 4,
      "applicableAuthModels": ["4"],
      "applicableNetworkHandlers": [4],
      "configurationTypes": ["MANUAL"],
      "downloadable": false,
      "driverInstalled": false,
      "driverLibraries": [DriverLibraryInfo],
      "safeEmbeddedDriver": true
    }
  }
}

Mutations

`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": true}}

Mutations

`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}}

Mutations

`deleteDriver`

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}}

Mutations

`deleteDriverLibraries`

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": true}}

Mutations

`dmAddCustomCertificate`

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}}

Mutations

`dmDeleteCustomCertificate`

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}}

Mutations

`dmDeleteDeployment`

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
    }
  }
}

Mutations

`dmDeleteDeploymentDomain`

Response

Returns a DeploymentInfo

Example

Query

mutation dmDeleteDeploymentDomain {
  dmDeleteDeploymentDomain {
    id
    ipAddress
    publicAddress
    subdomain
    dateOfExpire
    domainRenewalError {
      ...DomainRenewalErrorFragment
    }
  }
}

Response

{
  "data": {
    "dmDeleteDeploymentDomain": {
      "id": 4,
      "ipAddress": "abc123",
      "publicAddress": "xyz789",
      "subdomain": "xyz789",
      "dateOfExpire": "xyz789",
      "domainRenewalError": DomainRenewalError
    }
  }
}

Mutations

`emptyEventMutation`

Response

Returns a Boolean

Example

Query

mutation emptyEventMutation {
  emptyEventMutation
}

Response

{"data": {"emptyEventMutation": false}}

Mutations

`fakeFunction`

Response

Returns an Object

Example

Query

mutation fakeFunction {
  fakeFunction
}

Response

{"data": {"fakeFunction": Object}}

Mutations

`fakeFunctionAWS`

Response

Returns an Object

Example

Query

mutation fakeFunctionAWS {
  fakeFunctionAWS
}

Response

{"data": {"fakeFunctionAWS": Object}}

Mutations

`fakeFunctionQM`

Response

Returns an Object

Example

Query

mutation fakeFunctionQM {
  fakeFunctionQM
}

Response

{"data": {"fakeFunctionQM": Object}}

Mutations

`federatedLogin`

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": false,
  "forceSessionsLogout": false
}

Response

{
  "data": {
    "federatedLogin": {
      "redirectLink": "abc123",
      "taskInfo": AsyncTaskInfo
    }
  }
}

Mutations

`fsCopy`

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": "xyz789",
  "toParentNodePath": "abc123"
}

Response

{
  "data": {
    "fsCopy": {
      "name": "xyz789",
      "length": 987,
      "folder": false,
      "metaData": Object,
      "nodePath": "xyz789"
    }
  }
}

Mutations

`fsCreateFile`

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": "xyz789",
  "fileName": "abc123"
}

Response

{
  "data": {
    "fsCreateFile": {
      "name": "xyz789",
      "length": 987,
      "folder": false,
      "metaData": Object,
      "nodePath": "abc123"
    }
  }
}

Mutations

`fsCreateFolder`

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": "abc123",
      "length": 123,
      "folder": true,
      "metaData": Object,
      "nodePath": "abc123"
    }
  }
}

Mutations

`fsDelete`

Response

Returns a Boolean!

Arguments

Name	Description
`nodePath` - `String!`

Example

Query

mutation fsDelete($nodePath: String!) {
  fsDelete(nodePath: $nodePath)
}

Variables

{"nodePath": "abc123"}

Response

{"data": {"fsDelete": true}}

Mutations

`fsMove`

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": "xyz789",
  "toParentNodePath": "xyz789"
}

Response

{
  "data": {
    "fsMove": {
      "name": "abc123",
      "length": 123,
      "folder": true,
      "metaData": Object,
      "nodePath": "xyz789"
    }
  }
}

Mutations

`fsRename`

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": false,
      "metaData": Object,
      "nodePath": "xyz789"
    }
  }
}

Mutations

`fsWriteFileStringContent`

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": "xyz789",
  "data": "abc123",
  "forceOverwrite": true
}

Response

{
  "data": {
    "fsWriteFileStringContent": {
      "name": "xyz789",
      "length": 123,
      "folder": false,
      "metaData": Object,
      "nodePath": "abc123"
    }
  }
}

Mutations

`getChildrenCollections`

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": "xyz789",
        "path": "xyz789"
      }
    ]
  }
}

Mutations

`getTransactionLogInfo`

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]
    }
  }
}

Mutations

`gitSaveGlobalSettings`

Description

set up global git configuration

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": "abc123",
      "password": "abc123"
    }
  }
}

Mutations

`gitSaveProjectSettings`

Description

set up project git configuration

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": false,
      "repositoryUrl": "xyz789",
      "branch": "abc123",
      "gitIgnoreRules": ["DATASOURCES"]
    }
  }
}

Mutations

`gitTestRemoteRepositoryAccess`

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": false}}

Mutations

`importProductLicense`

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": "abc123"}

Response

{
  "data": {
    "importProductLicense": {
      "id": "abc123",
      "licenseType": "abc123",
      "ownerCompany": "abc123",
      "ownerName": "abc123",
      "ownerEmail": "abc123",
      "usersNumber": 123,
      "yearsNumber": 987,
      "subscription": true,
      "unlimitedServers": false,
      "multiInstance": false,
      "serversNumber": 987,
      "licenseIssueTime": "abc123",
      "licenseStartTime": "abc123",
      "licenseEndTime": "abc123",
      "licenseRoles": [LMLicenseRole],
      "licenseStatus": LMLicenseStatusDetails
    }
  }
}

Mutations

`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": "abc123"
}

Response

{
  "data": {
    "initConnection": {
      "id": "4",
      "driverId": 4,
      "name": "abc123",
      "description": "xyz789",
      "host": "xyz789",
      "port": "abc123",
      "serverName": "xyz789",
      "databaseName": "abc123",
      "url": "xyz789",
      "mainPropertyValues": Object,
      "keepAliveInterval": 987,
      "autocommit": false,
      "properties": Object,
      "connected": true,
      "provided": true,
      "readOnly": false,
      "useUrl": false,
      "saveCredentials": true,
      "sharedCredentials": true,
      "sharedSecrets": [SecretInfo],
      "credentialsSaved": true,
      "authNeeded": false,
      "folder": "4",
      "nodePath": "abc123",
      "connectTime": "abc123",
      "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": false,
      "canEdit": false,
      "canDelete": true,
      "projectId": 4,
      "requiredAuth": "xyz789",
      "defaultCatalogName": "xyz789",
      "defaultSchemaName": "abc123",
      "tools": ["abc123"]
    }
  }
}

Mutations

`lmDeleteProductLicense`

Response

Returns a Boolean!

Arguments

Name	Description
`id` - `ID!`

Example

Query

mutation lmDeleteProductLicense($id: ID!) {
  lmDeleteProductLicense(id: $id)
}

Variables

{"id": "4"}

Response

{"data": {"lmDeleteProductLicense": true}}

Mutations

`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": "abc123"
}

Response

{
  "data": {
    "msSetServiceConfiguration": "xyz789"
  }
}

Mutations

`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": 987}}

Mutations

`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}}

Mutations

`navReloadNode`

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": "xyz789",
      "fullName": "abc123",
      "plainName": "abc123",
      "icon": "xyz789",
      "description": "abc123",
      "nodeType": "xyz789",
      "hasChildren": false,
      "projectId": "abc123",
      "object": DatabaseObjectInfo,
      "objectId": "abc123",
      "features": ["abc123"],
      "nodeDetails": [ObjectPropertyInfo],
      "folder": false,
      "inline": false,
      "navigable": true,
      "filtered": false,
      "filter": NavigatorNodeFilter
    }
  }
}

Mutations

`navRenameNode`

Description

Rename 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": "xyz789"
}

Response

{"data": {"navRenameNode": "xyz789"}}

Mutations

`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": ["xyz789"]
}

Response

{"data": {"navSetFolderFilter": true}}

Mutations

`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
    serverMessages {
      ...ServerMessageFragment
    }
    connections {
      ...ConnectionInfoFragment
    }
    actionParameters
    valid
    remainingTime
  }
}

Variables

{"defaultLocale": "xyz789"}

Response

{
  "data": {
    "openSession": {
      "createTime": "abc123",
      "lastAccessTime": "abc123",
      "locale": "xyz789",
      "cacheExpired": false,
      "serverMessages": [ServerMessage],
      "connections": [ConnectionInfo],
      "actionParameters": Object,
      "valid": false,
      "remainingTime": 123
    }
  }
}

Mutations

`provisioningImportUsers`

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}}

Mutations

`readLobValue`

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": 123,
  "row": [SQLResultRow]
}

Response

{"data": {"readLobValue": "xyz789"}}

Mutations

`refreshSessionConnections`

Description

Refresh session connection list

Response

Returns a Boolean

Example

Query

mutation refreshSessionConnections {
  refreshSessionConnections
}

Response

{"data": {"refreshSessionConnections": true}}

Mutations

`resetDriver`

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": "abc123",
      "description": "xyz789",
      "icon": "xyz789",
      "iconBig": "xyz789",
      "driverId": 4,
      "providerId": "4",
      "driverClassName": "abc123",
      "defaultHost": "abc123",
      "defaultPort": "xyz789",
      "defaultDatabase": "abc123",
      "defaultServer": "xyz789",
      "defaultUser": "abc123",
      "sampleURL": "xyz789",
      "driverInfoURL": "abc123",
      "driverPropertiesURL": "xyz789",
      "embedded": false,
      "enabled": false,
      "requiresServerName": true,
      "requiresDatabaseName": true,
      "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": true,
      "driverInstalled": false,
      "driverLibraries": [DriverLibraryInfo],
      "safeEmbeddedDriver": false
    }
  }
}

Mutations

`rmAddProjectsPermissions`

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": ["abc123"]
}

Response

{"data": {"rmAddProjectsPermissions": false}}

Mutations

`rmCreateDataSet`

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": "abc123",
  "datasetConfig": DataSetConfig,
  "forceOverwrite": true
}

Response

{
  "data": {
    "rmCreateDataSet": {
      "displayName": "abc123",
      "description": "abc123",
      "draft": true,
      "queries": [DataSetQueryInfo],
      "datasetPath": "abc123",
      "projectId": 4
    }
  }
}

Mutations

`rmCreateProject`

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": "abc123",
  "description": "abc123"
}

Response

{
  "data": {
    "rmCreateProject": {
      "id": 4,
      "name": "abc123",
      "description": "xyz789",
      "shared": false,
      "global": false,
      "createTime": "2007-12-03T10:15:30Z",
      "creator": "xyz789",
      "projectPermissions": ["xyz789"],
      "resourceTypes": [RMResourceType]
    }
  }
}

Mutations

`rmCreateResource`

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"}}

Mutations

`rmDeleteProject`

No longer supported

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}}

Mutations

`rmDeleteProjectsPermissions`

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": ["xyz789"]
}

Response

{"data": {"rmDeleteProjectsPermissions": false}}

Mutations

`rmDeleteResource`

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": "abc123",
  "resourcePath": "abc123",
  "recursive": true
}

Response

{"data": {"rmDeleteResource": false}}

Mutations

`rmMoveResource`

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": "xyz789",
  "oldResourcePath": "xyz789",
  "newResourcePath": "xyz789"
}

Response

{"data": {"rmMoveResource": "abc123"}}

Mutations

`rmSetProjectPermissions`

No longer supported

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": "abc123",
  "permissions": [RMSubjectProjectPermissions]
}

Response

{"data": {"rmSetProjectPermissions": false}}

Mutations

`rmSetResourceProperty`

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": "abc123",
  "name": "4",
  "value": "xyz789"
}

Response

{"data": {"rmSetResourceProperty": true}}

Mutations

`rmSetSubjectProjectPermissions`

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": false}}

Mutations

`rmWriteResourceStringContent`

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": "xyz789",
  "data": "abc123",
  "forceOverwrite": false
}

Response

{
  "data": {
    "rmWriteResourceStringContent": "abc123"
  }
}

Mutations

`secretDeleteFromTeam`

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}}

Mutations

`secretSetToTeam`

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]
    }
  }
}

Mutations

`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": "xyz789",
      "host": "abc123",
      "port": "xyz789",
      "serverName": "abc123",
      "databaseName": "abc123",
      "url": "xyz789",
      "mainPropertyValues": Object,
      "keepAliveInterval": 123,
      "autocommit": false,
      "properties": Object,
      "connected": true,
      "provided": true,
      "readOnly": false,
      "useUrl": true,
      "saveCredentials": false,
      "sharedCredentials": false,
      "sharedSecrets": [SecretInfo],
      "credentialsSaved": false,
      "authNeeded": true,
      "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": true,
      "canEdit": false,
      "canDelete": false,
      "projectId": "4",
      "requiredAuth": "abc123",
      "defaultCatalogName": "abc123",
      "defaultSchemaName": "xyz789",
      "tools": ["abc123"]
    }
  }
}

Mutations

`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": "abc123",
  "value": Object
}

Response

{"data": {"setUserConfigurationParameter": true}}

Mutations

`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": "abc123",
      "authRole": "4",
      "authTokens": [UserAuthToken],
      "linkedAuthProviders": ["abc123"],
      "metaParameters": Object,
      "configurationParameters": Object,
      "teams": [UserTeamInfo],
      "isAnonymous": true
    }
  }
}

Mutations

`sqlContextCreate`

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": false,
      "defaultCatalog": "abc123",
      "defaultSchema": "xyz789"
    }
  }
}

Mutations

`sqlContextDestroy`

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": false}}

Mutations

`sqlContextSetDefaults`

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": true}}

Mutations

`sqlGetDynamicTrace`

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": "abc123",
        "description": "xyz789"
      }
    ]
  }
}

Mutations

`sqlReadLobValue`

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": "xyz789"}}

Mutations

`sqlReadStringValue`

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"}}

Mutations

`sqlResultClose`

Description

Close 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}}

Mutations

`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": "abc123",
      "host": "xyz789",
      "port": "xyz789",
      "serverName": "xyz789",
      "databaseName": "xyz789",
      "url": "xyz789",
      "mainPropertyValues": Object,
      "keepAliveInterval": 987,
      "autocommit": false,
      "properties": Object,
      "connected": true,
      "provided": true,
      "readOnly": true,
      "useUrl": false,
      "saveCredentials": false,
      "sharedCredentials": true,
      "sharedSecrets": [SecretInfo],
      "credentialsSaved": true,
      "authNeeded": true,
      "folder": "4",
      "nodePath": "xyz789",
      "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": false,
      "canEdit": false,
      "canDelete": true,
      "projectId": 4,
      "requiredAuth": "xyz789",
      "defaultCatalogName": "xyz789",
      "defaultSchemaName": "xyz789",
      "tools": ["abc123"]
    }
  }
}

Mutations

`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": "abc123",
      "serverVersion": "xyz789"
    }
  }
}

Mutations

`tokenApiCreate`

Description

creates API token for user

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": 987}

Response

{
  "data": {
    "tokenApiCreate": {
      "tokenName": "xyz789",
      "token": "abc123",
      "createTime": "2007-12-03",
      "expireTime": "2007-12-03"
    }
  }
}

Mutations

`tokenApiDelete`

Description

deletes API token from user

Response

Returns a Boolean!

Arguments

Name	Description
`tokenName` - `String!`

Example

Query

mutation tokenApiDelete($tokenName: String!) {
  tokenApiDelete(tokenName: $tokenName)
}

Variables

{"tokenName": "xyz789"}

Response

{"data": {"tokenApiDelete": true}}

Mutations

`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}}

Mutations

`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": "abc123",
      "description": "xyz789",
      "host": "abc123",
      "port": "abc123",
      "serverName": "abc123",
      "databaseName": "abc123",
      "url": "xyz789",
      "mainPropertyValues": Object,
      "keepAliveInterval": 987,
      "autocommit": false,
      "properties": Object,
      "connected": true,
      "provided": true,
      "readOnly": true,
      "useUrl": true,
      "saveCredentials": false,
      "sharedCredentials": false,
      "sharedSecrets": [SecretInfo],
      "credentialsSaved": true,
      "authNeeded": false,
      "folder": "4",
      "nodePath": "xyz789",
      "connectTime": "abc123",
      "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": false,
      "projectId": "4",
      "requiredAuth": "abc123",
      "defaultCatalogName": "xyz789",
      "defaultSchemaName": "xyz789",
      "tools": ["xyz789"]
    }
  }
}

Mutations

`updateDriver`

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": "abc123",
      "description": "abc123",
      "icon": "xyz789",
      "iconBig": "xyz789",
      "driverId": "4",
      "providerId": 4,
      "driverClassName": "xyz789",
      "defaultHost": "abc123",
      "defaultPort": "abc123",
      "defaultDatabase": "xyz789",
      "defaultServer": "xyz789",
      "defaultUser": "xyz789",
      "sampleURL": "xyz789",
      "driverInfoURL": "xyz789",
      "driverPropertiesURL": "xyz789",
      "embedded": false,
      "enabled": false,
      "requiresServerName": true,
      "requiresDatabaseName": true,
      "useCustomPage": true,
      "licenseRequired": true,
      "license": "abc123",
      "custom": true,
      "promotedScore": 987,
      "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
    }
  }
}

Mutations

`updateResultsDataBatch`

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": 987,
      "filterText": "xyz789",
      "fullQuery": "xyz789",
      "results": [SQLQueryResults]
    }
  }
}

Mutations

`updateResultsDataBatchScript`

23.3.3

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": "abc123"
  }
}

Mutations

`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
    serverMessages {
      ...ServerMessageFragment
    }
    connections {
      ...ConnectionInfoFragment
    }
    actionParameters
    valid
    remainingTime
  }
}

Response

{
  "data": {
    "updateSession": {
      "createTime": "abc123",
      "lastAccessTime": "xyz789",
      "locale": "abc123",
      "cacheExpired": true,
      "serverMessages": [ServerMessage],
      "connections": [ConnectionInfo],
      "actionParameters": Object,
      "valid": true,
      "remainingTime": 987
    }
  }
}

Mutations

`vqbFakeFunction`

Response

Returns an Object

Example

Query

mutation vqbFakeFunction {
  vqbFakeFunction
}

Response

{"data": {"vqbFakeFunction": Object}}

Types

AIEngineConfig

Fields

Input Field	Description
`properties` - `Object`

Example

{"properties": Object}

Types

AIEngineInfo

Fields

Field Name	Description
`id` - `ID!`
`name` - `String!`

Example

{"id": 4, "name": "xyz789"}

Types

AISettingsConfig

Fields

Input Field	Description
`activeEngine` - `ID!`

Example

{"activeEngine": "4"}

Types

AISettingsInfo

Fields

Field Name	Description
`activeEngine` - `ID!`

Example

{"activeEngine": "4"}

Types

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"
}

Types

APITokenInfo

Fields

Field Name	Description
`tokenName` - `String!`
`createTime` - `Date!`
`expireTime` - `Date`

Example

{
  "tokenName": "abc123",
  "createTime": "2007-12-03",
  "expireTime": "2007-12-03"
}

Types

AWSConfiguration

Fields

Field Name	Description
`cloudId` - `String!`
`cloudName` - `String!`
`allowedAccounts` - `[String!]!`
`regions` - `[String!]`
`federatedAccessEnabled` - `Boolean!`
`govRegionsEnabled` - `Boolean!`
`proxyUser` - `AWSUserInfo`
`useDefaultCredentials` - `Boolean!`
`assumeRoleName` - `String`

Example

{
  "cloudId": "xyz789",
  "cloudName": "xyz789",
  "allowedAccounts": ["abc123"],
  "regions": ["abc123"],
  "federatedAccessEnabled": false,
  "govRegionsEnabled": false,
  "proxyUser": AWSUserInfo,
  "useDefaultCredentials": true,
  "assumeRoleName": "abc123"
}

Types

AWSConfigurationInput

Fields

Input Field	Description
`regions` - `[String!]`
`credentials` - `AWSCredentialsConfigurationInput`

Example

{
  "regions": ["xyz789"],
  "credentials": AWSCredentialsConfigurationInput
}

Types

AWSCredentialsConfigurationInput

Fields

Input Field	Description
`useDefaultCredentials` - `Boolean`
`assumeRoleName` - `String`

Example

{
  "useDefaultCredentials": false,
  "assumeRoleName": "xyz789"
}

Types

AWSInstallConfigurationInput

Fields

Input Field	Description
`agreementId` - `ID`

Example

{"agreementId": "4"}

Types

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!]`	24.3.1, use regions from AWSConfiguration

Example

{
  "instanceId": "abc123",
  "instanceType": "abc123",
  "instanceRole": "xyz789",
  "accountId": "abc123",
  "version": "abc123",
  "marketplaceProductCodes": ["abc123"],
  "amiId": "abc123",
  "agreementId": "abc123",
  "defaultRegion": "xyz789",
  "accountRegions": ["abc123"]
}

Types

AWSPartition

Fields

Field Name	Description
`id` - `ID!`
`name` - `String!`

Example

{"id": 4, "name": "abc123"}

Types

AWSRegion

Fields

Field Name	Description
`id` - `String!`
`displayName` - `String`
`superRegion` - `String`
`global` - `Boolean!`
`partition` - `String!`
`domain` - `String`

Example

{
  "id": "abc123",
  "displayName": "abc123",
  "superRegion": "abc123",
  "global": false,
  "partition": "abc123",
  "domain": "xyz789"
}

Types

AWSTag

Fields

Field Name	Description
`name` - `String!`
`value` - `String`

Example

{
  "name": "xyz789",
  "value": "abc123"
}

Types

AWSUserInfo

Fields

Field Name	Description
`userId` - `String`
`userName` - `String`
`userPath` - `String`
`userArn` - `String`
`accountId` - `String`
`organizationName` - `String`
`createDate` - `DateTime`
`tags` - `[AWSTag!]`

Example

{
  "userId": "abc123",
  "userName": "abc123",
  "userPath": "xyz789",
  "userArn": "abc123",
  "accountId": "abc123",
  "organizationName": "xyz789",
  "createDate": "2007-12-03T10:15:30Z",
  "tags": [AWSTag]
}

Types

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": "xyz789",
  "signOutLink": "xyz789",
  "redirectLink": "xyz789",
  "metadataLink": "xyz789",
  "acsLink": "xyz789",
  "entityIdLink": "xyz789"
}

Types

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"
}

Types

AdminConnectionSearchInfo

Fields

Field Name	Description
`displayName` - `String!`
`host` - `String!`
`port` - `Int!`
`possibleDrivers` - `[ID!]!`
`defaultDriver` - `ID!`

Example

{
  "displayName": "abc123",
  "host": "abc123",
  "port": 987,
  "possibleDrivers": ["4"],
  "defaultDriver": "4"
}

Types

AdminObjectGrantInfo

Fields

Field Name	Description
`subjectId` - `ID!`
`subjectType` - `AdminSubjectType!`
`objectPermissions` - `AdminObjectPermissions!`

Example

{
  "subjectId": "4",
  "subjectType": "user",
  "objectPermissions": AdminObjectPermissions
}

Types

AdminObjectPermissions

Fields

Field Name	Description
`objectId` - `ID!`
`permissions` - `[String!]!`

Example

{"objectId": 4, "permissions": ["xyz789"]}

Types

AdminPermissionInfo

Fields

Field Name	Description
`id` - `ID!`
`label` - `String`
`description` - `String`
`provider` - `String!`
`category` - `String`

Example

{
  "id": "4",
  "label": "abc123",
  "description": "abc123",
  "provider": "abc123",
  "category": "abc123"
}

Types

AdminSecretInfo

Fields

Field Name	Description
`subjectId` - `ID!`
`authProperties` - `[ObjectPropertyInfo!]!`

Example

{
  "subjectId": "4",
  "authProperties": [ObjectPropertyInfo]
}

Types

AdminSubjectType

Values

Enum Value	Description
`user`
`team`

Example

"user"

Types

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": "abc123",
  "metaParameters": Object,
  "grantedUsers": [4],
  "grantedUsersInfo": [AdminUserTeamGrantInfo],
  "grantedConnections": [AdminConnectionGrantInfo],
  "teamPermissions": [4]
}

Types

AdminUserFilterInput

Fields

Input Field	Description
`userIdMask` - `String`
`enabledState` - `Boolean`

Example

{
  "userIdMask": "abc123",
  "enabledState": true
}

Types

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": ["xyz789"],
  "enabled": true,
  "authRole": "abc123",
  "disableDate": "2007-12-03T10:15:30Z",
  "disabledBy": "abc123",
  "disableReason": "xyz789"
}

Types

AdminUserTeamGrantInfo

Fields

Field Name	Description
`userId` - `ID!`
`teamRole` - `String`

Example

{
  "userId": "4",
  "teamRole": "abc123"
}

Types

AsyncTaskInfo

Fields

Field Name	Description
`id` - `String!`
`name` - `String`
`running` - `Boolean!`
`status` - `String`
`error` - `ServerError`
`result` - `SQLExecuteInfo`	No longer supported
`taskResult` - `Object`	Task result. Can be some kind of identifier to obtain real result using another API function

Example

{
  "id": "xyz789",
  "name": "xyz789",
  "running": true,
  "status": "xyz789",
  "error": ServerError,
  "result": SQLExecuteInfo,
  "taskResult": Object
}

Types

AuthCredentialEncryption

Values

Enum Value	Description
`none`
`plain`
`hash`

Example

"none"

Types

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": "abc123",
  "description": "abc123",
  "admin": true,
  "user": true,
  "identifying": true,
  "possibleValues": ["xyz789"],
  "encryption": "none"
}

Types

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": "abc123",
  "authStatus": "SUCCESS",
  "userTokens": [UserAuthToken]
}

Types

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 auhentication provider (SSO). Otherwise authLogin function must be called.
`signOutLink` - `String`
`redirectLink` - `String`
`metadataLink` - `String`
`acsLink` - `String`
`entityIdLink` - `String`

Example

{
  "id": 4,
  "displayName": "abc123",
  "disabled": true,
  "authRoleProvided": false,
  "iconURL": "xyz789",
  "description": "xyz789",
  "signInLink": "abc123",
  "signOutLink": "xyz789",
  "redirectLink": "abc123",
  "metadataLink": "abc123",
  "acsLink": "abc123",
  "entityIdLink": "abc123"
}

Types

AuthProviderCredentialsProfile

Fields

Field Name	Description
`id` - `String`
`label` - `String`
`description` - `String`
`credentialParameters` - `[AuthCredentialInfo!]!`

Example

{
  "id": "abc123",
  "label": "xyz789",
  "description": "abc123",
  "credentialParameters": [AuthCredentialInfo]
}

Types

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": "xyz789",
  "icon": 4,
  "description": "abc123",
  "defaultProvider": true,
  "trusted": true,
  "private": false,
  "authHidden": false,
  "supportProvisioning": false,
  "configurable": false,
  "federated": true,
  "configurations": [AuthProviderConfiguration],
  "templateConfiguration": AuthProviderConfiguration,
  "credentialProfiles": [AuthProviderCredentialsProfile],
  "requiredFeatures": ["abc123"],
  "required": false
}

Types

AuthStatus

Values

Enum Value	Description
`SUCCESS`
`IN_PROGRESS`
`ERROR`

Example

"SUCCESS"

Types

Boolean

Description

The Boolean scalar type represents true or false.

Types

CBCloud

Fields

Field Name	Description
`id` - `String!`
`name` - `String!`
`authProvider` - `String!`

Example

{
  "id": "xyz789",
  "name": "abc123",
  "authProvider": "xyz789"
}

Types

Condition

Fields

Field Name	Description
`expression` - `String!`
`conditionType` - `ConditionType!`

Example

{
  "expression": "abc123",
  "conditionType": "HIDE"
}

Types

ConditionType

Values

Enum Value	Description
`HIDE`
`READ_ONLY`

Example

"HIDE"

Types

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`
`port` - `String`
`serverName` - `String`
`databaseName` - `String`
`mainPropertyValues` - `Object`	Host, port, serverName, databaseName are also stored in mainPropertyValues for custom pages
`url` - `String`
`properties` - `Object`	Return properties list
`keepAliveInterval` - `Int`	Return keep-alive interval
`autocommit` - `Boolean`	Return auto-commit connection state
`readOnly` - `Boolean`	Return read-only connection state
`saveCredentials` - `Boolean`
`sharedCredentials` - `Boolean`
`authModelId` - `ID`
`selectedSecretId` - `ID`
`credentials` - `Object`
`providerProperties` - `Object`	Return map of provider properties (name/value)
`networkHandlersConfig` - `[NetworkHandlerConfigInput!]`	Return network handlers configuration. Map of id->property map (name/value).
`dataSourceId` - `ID`	ID of predefined datasource
`userName` - `String`	Direct user credentials
`userPassword` - `String`
`folder` - `ID`
`configurationType` - `DriverConfigurationType`	Configuration type
`defaultCatalogName` - `String`
`defaultSchemaName` - `String`

Example

{
  "externalParameters": ExternalParameters,
  "connectionId": "abc123",
  "name": "xyz789",
  "description": "abc123",
  "driverId": "4",
  "host": "xyz789",
  "port": "abc123",
  "serverName": "abc123",
  "databaseName": "abc123",
  "mainPropertyValues": Object,
  "url": "abc123",
  "properties": Object,
  "keepAliveInterval": 987,
  "autocommit": true,
  "readOnly": true,
  "saveCredentials": true,
  "sharedCredentials": true,
  "authModelId": 4,
  "selectedSecretId": 4,
  "credentials": Object,
  "providerProperties": Object,
  "networkHandlersConfig": [NetworkHandlerConfigInput],
  "dataSourceId": "4",
  "userName": "xyz789",
  "userPassword": "xyz789",
  "folder": "4",
  "configurationType": "MANUAL",
  "defaultCatalogName": "xyz789",
  "defaultSchemaName": "xyz789"
}

Types

ConnectionFolderInfo

Fields

Field Name	Description
`id` - `ID!`
`projectId` - `ID!`
`description` - `String`

Example

{
  "id": 4,
  "projectId": 4,
  "description": "abc123"
}

Types

ConnectionInfo

Description

Connection instance

Fields

Field Name	Description
`id` - `ID!`
`driverId` - `ID!`
`name` - `String!`
`description` - `String`
`host` - `String`
`port` - `String`
`serverName` - `String`
`databaseName` - `String`
`url` - `String`
`mainPropertyValues` - `Object`
`keepAliveInterval` - `Int!`
`autocommit` - `Boolean`
`properties` - `Object`
`connected` - `Boolean!`
`provided` - `Boolean!`
`readOnly` - `Boolean!`
`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`
`nodePath` - `String`
`connectTime` - `String`
`connectionError` - `ServerError`
`serverVersion` - `String`
`clientVersion` - `String`
`origin` - `ObjectOrigin!`
`authModel` - `ID`
`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!]!`

Example

{
  "id": "4",
  "driverId": 4,
  "name": "abc123",
  "description": "xyz789",
  "host": "abc123",
  "port": "xyz789",
  "serverName": "xyz789",
  "databaseName": "abc123",
  "url": "xyz789",
  "mainPropertyValues": Object,
  "keepAliveInterval": 987,
  "autocommit": true,
  "properties": Object,
  "connected": false,
  "provided": true,
  "readOnly": false,
  "useUrl": true,
  "saveCredentials": true,
  "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": true,
  "projectId": 4,
  "requiredAuth": "abc123",
  "defaultCatalogName": "abc123",
  "defaultSchemaName": "xyz789",
  "tools": ["xyz789"]
}

Types

CustomCertificateConfig

Fields

Input Field	Description
`domainName` - `String!`
`certificate` - `String!`
`privateKey` - `String!`
`certificateChain` - `String`

Example

{
  "domainName": "xyz789",
  "certificate": "abc123",
  "privateKey": "xyz789",
  "certificateChain": "abc123"
}

Types

DataSetConfig

Fields

Input Field	Description
`displayName` - `String!`
`description` - `String`
`draft` - `Boolean`
`queries` - `[DataSetQueryConfig!]!`

Example

{
  "displayName": "abc123",
  "description": "abc123",
  "draft": false,
  "queries": [DataSetQueryConfig]
}

Types

DataSetInfo

Fields

Field Name	Description
`displayName` - `String!`
`description` - `String`
`draft` - `Boolean!`
`queries` - `[DataSetQueryInfo!]!`
`datasetPath` - `String!`
`projectId` - `ID!`

Example

{
  "displayName": "abc123",
  "description": "abc123",
  "draft": true,
  "queries": [DataSetQueryInfo],
  "datasetPath": "xyz789",
  "projectId": "4"
}

Types

DataSetQueryConfig

Fields

Input Field	Description
`id` - `String`
`description` - `String`
`datasourceId` - `ID!`
`catalog` - `String`
`schema` - `String`
`queryText` - `String!`
`dataFilter` - `SQLDataFilter`

Example

{
  "id": "abc123",
  "description": "abc123",
  "datasourceId": 4,
  "catalog": "xyz789",
  "schema": "abc123",
  "queryText": "abc123",
  "dataFilter": SQLDataFilter
}

Types

DataSetQueryInfo

Fields

Field Name	Description
`id` - `String!`
`queryText` - `String!`
`datasourceId` - `String!`
`description` - `String`
`catalog` - `String`
`schema` - `String`
`dataFilter` - `SQLDataFilterInfo`

Example

{
  "id": "xyz789",
  "queryText": "xyz789",
  "datasourceId": "abc123",
  "description": "abc123",
  "catalog": "abc123",
  "schema": "xyz789",
  "dataFilter": SQLDataFilterInfo
}

Types

DataSourceSessionInfo

Fields

Field Name	Description
`activeQuery` - `String`
`properties` - `[ObjectPropertyInfo!]`
`sessionId` - `String!`

Example

{
  "activeQuery": "abc123",
  "properties": [ObjectPropertyInfo],
  "sessionId": "abc123"
}

Types

DataTransferDefaultExportSettings

Fields

Field Name	Description
`outputSettings` - `DataTransferOutputSettings!`
`supportedEncodings` - `[String!]!`

Example

{
  "outputSettings": DataTransferOutputSettings,
  "supportedEncodings": ["abc123"]
}

Types

DataTransferOutputSettings

Fields

Field Name	Description
`insertBom` - `Boolean!`
`encoding` - `String!`
`timestampPattern` - `String!`
`compress` - `Boolean!`

Example

{
  "insertBom": false,
  "encoding": "xyz789",
  "timestampPattern": "xyz789",
  "compress": false
}

Types

DataTransferOutputSettingsInput

Fields

Input Field	Description
`insertBom` - `Boolean`
`encoding` - `String`
`timestampPattern` - `String`
`compress` - `Boolean`
`fileName` - `String`

Example

{
  "insertBom": true,
  "encoding": "xyz789",
  "timestampPattern": "abc123",
  "compress": true,
  "fileName": "xyz789"
}

Types

DataTransferParameters

Fields

Input Field	Description
`processorId` - `ID!`	Processor ID
`settings` - `Object`	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
}

Types

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": "xyz789",
  "order": 987,
  "icon": "abc123",
  "properties": [ObjectPropertyInfo],
  "isBinary": false,
  "isHTML": false
}

Types

DataTypeLogicalOperation

Fields

Field Name	Description
`id` - `ID!`
`expression` - `String!`
`argumentCount` - `Int`

Example

{
  "id": "4",
  "expression": "abc123",
  "argumentCount": 123
}

Types

DatabaseAuthModel

Fields

Field Name	Description
`id` - `ID!`
`displayName` - `String!`
`description` - `String`
`icon` - `String`
`requiresLocalConfiguration` - `Boolean`	checks if the auth model needs a configuration on a local file system
`requiredAuth` - `String`
`properties` - `[ObjectPropertyInfo!]!`

Example

{
  "id": 4,
  "displayName": "abc123",
  "description": "xyz789",
  "icon": "xyz789",
  "requiresLocalConfiguration": false,
  "requiredAuth": "abc123",
  "properties": [ObjectPropertyInfo]
}

Types

DatabaseCatalog

Fields

Field Name	Description
`catalog` - `NavigatorNodeInfo!`
`schemaList` - `[NavigatorNodeInfo!]!`

Example

{
  "catalog": NavigatorNodeInfo,
  "schemaList": [NavigatorNodeInfo]
}

Types

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. Examine property meta (features in particular) before reading them
Arguments `filter` - `ObjectPropertyFilter`
`ordinalPosition` - `Int`
`fullyQualifiedName` - `String`
`overloadedName` - `String`
`uniqueName` - `String`
`state` - `String`
`features` - `[String!]`	entity, schema, catalog
`editors` - `[String!]`

Example

{
  "name": "xyz789",
  "description": "abc123",
  "type": "abc123",
  "properties": [ObjectPropertyInfo],
  "ordinalPosition": 987,
  "fullyQualifiedName": "abc123",
  "overloadedName": "xyz789",
  "uniqueName": "abc123",
  "state": "abc123",
  "features": ["xyz789"],
  "editors": ["xyz789"]
}

Types

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": true
}

Types

Date

Example

"2007-12-03"

Types

DateTime

Description

Date/Time

Example

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

Types

DeploymentAddressVerificationInfo

Fields

Field Name	Description
`valid` - `Boolean!`
`message` - `String`

Example

{"valid": false, "message": "xyz789"}

Types

DeploymentInfo

Fields

Field Name	Description
`id` - `ID!`
`ipAddress` - `String`
`publicAddress` - `String`
`subdomain` - `String`
`dateOfExpire` - `String`
`domainRenewalError` - `DomainRenewalError`

Example

{
  "id": "4",
  "ipAddress": "abc123",
  "publicAddress": "xyz789",
  "subdomain": "abc123",
  "dateOfExpire": "xyz789",
  "domainRenewalError": DomainRenewalError
}

Types

DomainCertificateType

Values

Enum Value	Description
`CUSTOM`
`DEFAULT`

Example

"CUSTOM"

Types

DomainManagerAvailability

Fields

Field Name	Description
`certbot` - `Boolean!`
`server` - `Boolean!`
`externalStatus` - `EDMStatus`

Example

{
  "certbot": false,
  "server": true,
  "externalStatus": "AWS_MARKETPLACE_AGREEMENT_NOT_FOUND"
}

Types

DomainRenewalError

Fields

Field Name	Description
`updateTime` - `String!`
`errorMessage` - `String!`

Example

{
  "updateTime": "abc123",
  "errorMessage": "abc123"
}

Types

DriverConfig

Fields

Input Field	Description
`id` - `ID`
`name` - `String!`
`providerId` - `ID!`
`driverClassName` - `String!`
`description` - `String`
`sampleURL` - `String`
`defaultPort` - `String`
`defaultDatabase` - `String`
`defaultUser` - `String`

Example

{
  "id": "4",
  "name": "xyz789",
  "providerId": "4",
  "driverClassName": "abc123",
  "description": "abc123",
  "sampleURL": "xyz789",
  "defaultPort": "xyz789",
  "defaultDatabase": "xyz789",
  "defaultUser": "xyz789"
}

Types

DriverConfigurationType

Values

Enum Value	Description
`MANUAL`
`URL`

Example

"MANUAL"

Types

DriverFileInfo

Fields

Field Name	Description
`id` - `ID!`
`fileName` - `String!`
`icon` - `String`

Example

{
  "id": 4,
  "fileName": "xyz789",
  "icon": "abc123"
}

Types

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`
`description` - `String`
`icon` - `String`
`iconBig` - `String`
`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`
`defaultPort` - `String`
`defaultDatabase` - `String`
`defaultServer` - `String`
`defaultUser` - `String`
`sampleURL` - `String`
`driverInfoURL` - `String`
`driverPropertiesURL` - `String`
`embedded` - `Boolean`
`enabled` - `Boolean!`
`requiresServerName` - `Boolean`
`requiresDatabaseName` - `Boolean`
`useCustomPage` - `Boolean!`
`licenseRequired` - `Boolean`
`license` - `String`
`custom` - `Boolean`
`promotedScore` - `Int`	Driver score for ordering, biggest first
`driverProperties` - `[ObjectPropertyInfo!]!`	Driver properties. 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)
`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!`
`applicableAuthModels` - `[ID!]!`
`applicableNetworkHandlers` - `[ID]!`
`configurationTypes` - `[DriverConfigurationType]!`
`downloadable` - `Boolean!`
`driverInstalled` - `Boolean!`
`driverLibraries` - `[DriverLibraryInfo!]!`
`safeEmbeddedDriver` - `Boolean!`

Example

{
  "id": "4",
  "name": "xyz789",
  "description": "xyz789",
  "icon": "abc123",
  "iconBig": "abc123",
  "driverId": "4",
  "providerId": 4,
  "driverClassName": "xyz789",
  "defaultHost": "xyz789",
  "defaultPort": "xyz789",
  "defaultDatabase": "xyz789",
  "defaultServer": "abc123",
  "defaultUser": "abc123",
  "sampleURL": "xyz789",
  "driverInfoURL": "abc123",
  "driverPropertiesURL": "xyz789",
  "embedded": true,
  "enabled": true,
  "requiresServerName": true,
  "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": true,
  "driverInstalled": false,
  "driverLibraries": [DriverLibraryInfo],
  "safeEmbeddedDriver": true
}

Types

DriverLibraryInfo

Fields

Field Name	Description
`id` - `ID!`
`name` - `String!`
`icon` - `String`
`libraryFiles` - `[DriverFileInfo!]`

Example

{
  "id": 4,
  "name": "xyz789",
  "icon": "xyz789",
  "libraryFiles": [DriverFileInfo]
}

Types

DriverProviderInfo

Fields

Field Name	Description
`id` - `ID!`
`name` - `String!`
`icon` - `String`

Example

{
  "id": 4,
  "name": "xyz789",
  "icon": "abc123"
}

Types

DynamicTraceProperty

Fields

Field Name	Description
`name` - `String!`
`value` - `String`
`description` - `String`

Example

{
  "name": "abc123",
  "value": "abc123",
  "description": "xyz789"
}

Types

EDMStatus

Values

Enum Value	Description
`AWS_MARKETPLACE_AGREEMENT_NOT_FOUND`

Example

"AWS_MARKETPLACE_AGREEMENT_NOT_FOUND"

Types

ERDAssociationInfo

Fields

Field Name	Description
`name` - `String!`
`fqn` - `String`
`type` - `String!`
`primaryEntity` - `Int`
`foreignEntity` - `Int`
`primaryAttributes` - `[String!]!`
`foreignAttributes` - `[String!]!`
`joinType` - `VQBJoinType`

Example

{
  "name": "abc123",
  "fqn": "abc123",
  "type": "abc123",
  "primaryEntity": 123,
  "foreignEntity": 123,
  "primaryAttributes": ["xyz789"],
  "foreignAttributes": ["xyz789"],
  "joinType": "SIMPLE"
}

Types

ERDDiagramData

Description

ERD queries

Fields

Field Name	Description
`icons` - `[String!]!`

Example

{"icons": ["xyz789"]}

Types

ERDDiagramInfo

Fields

Field Name	Description
`entities` - `[ERDEntityInfo!]!`
`associations` - `[ERDAssociationInfo!]`
`data` - `ERDDiagramData!`
`where` - `String`
`orderBy` - `[String!]!`
`selectItems` - `[String!]!`

Example

{
  "entities": [ERDEntityInfo],
  "associations": [ERDAssociationInfo],
  "data": ERDDiagramData,
  "where": "abc123",
  "orderBy": ["xyz789"],
  "selectItems": ["xyz789"]
}

Types

ERDEntityAttributeInfo

Fields

Field Name	Description
`name` - `String!`
`alias` - `String`
`dataKind` - `String`
`typeName` - `String`
`optional` - `Boolean`
`iconIndex` - `Int`
`fullTypeName` - `String`
`defaultValue` - `String`
`description` - `String`
`checked` - `Boolean!`
`expression` - `String`
`inPrimaryKey` - `Boolean`
`inForeignKey` - `Boolean`

Example

{
  "name": "xyz789",
  "alias": "abc123",
  "dataKind": "xyz789",
  "typeName": "xyz789",
  "optional": false,
  "iconIndex": 123,
  "fullTypeName": "xyz789",
  "defaultValue": "xyz789",
  "description": "xyz789",
  "checked": false,
  "expression": "xyz789",
  "inPrimaryKey": true,
  "inForeignKey": true
}

Types

ERDEntityInfo

Fields

Field Name	Description
`id` - `Int!`
`name` - `String!`
`alias` - `String`
`fqn` - `String`
`nodeId` - `ID`
`nodeUri` - `ID`
`attributes` - `[ERDEntityAttributeInfo!]!`

Example

{
  "id": 123,
  "name": "xyz789",
  "alias": "abc123",
  "fqn": "abc123",
  "nodeId": "4",
  "nodeUri": "4",
  "attributes": [ERDEntityAttributeInfo]
}

Types

ExternalParameters

Description

must be not null after refactoring

Fields

Input Field	Description
`configurationId` - `String`
`secretName` - `String`

Example

{
  "configurationId": "xyz789",
  "secretName": "xyz789"
}

Types

ExternalUserInfo

Fields

Field Name	Description
`userId` - `String!`
`metaParameters` - `Object!`
`authRole` - `String`

Example

{
  "userId": "abc123",
  "metaParameters": Object,
  "authRole": "xyz789"
}

Types

ExternalUserInput

Fields

Input Field	Description
`userId` - `String!`
`metaParameters` - `Object!`
`authRole` - `String`

Example

{
  "userId": "xyz789",
  "metaParameters": Object,
  "authRole": "abc123"
}

Types

ExternalUsersFilter

Fields

Input Field	Description
`offset` - `Int`
`limit` - `Int`

Example

{"offset": 987, "limit": 123}

Types

FSFile

Fields

Field Name	Description
`name` - `String!`
`length` - `Int!`
`folder` - `Boolean!`
`metaData` - `Object!`
`nodePath` - `String!`

Example

{
  "name": "abc123",
  "length": 987,
  "folder": true,
  "metaData": Object,
  "nodePath": "xyz789"
}

Types

FSFileSystem

Fields

Field Name	Description
`id` - `ID!`
`nodePath` - `String!`
`requiredAuth` - `String`

Example

{
  "id": "4",
  "nodePath": "xyz789",
  "requiredAuth": "abc123"
}

Types

FederatedAuthInfo

Fields

Field Name	Description
`redirectLink` - `String!`
`taskInfo` - `AsyncTaskInfo!`

Example

{
  "redirectLink": "abc123",
  "taskInfo": AsyncTaskInfo
}

Types

FederatedAuthResult

Fields

Field Name	Description
`userTokens` - `[UserAuthToken!]!`

Example

{"userTokens": [UserAuthToken]}

Types

FileBasedConnectionInfo

Fields

Field Name	Description
`connectionInfo` - `ConnectionInfo!`
`nodePathToOpen` - `String!`

Example

{
  "connectionInfo": ConnectionInfo,
  "nodePathToOpen": "xyz789"
}

Types

Float

Description

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

Example

123.45

Types

GitGlobalSettings

Fields

Field Name	Description
`username` - `String!`
`email` - `String`
`password` - `String!`

Example

{
  "username": "abc123",
  "email": "xyz789",
  "password": "abc123"
}

Types

GitGlobalSettingsInput

Fields

Input Field	Description
`username` - `String!`
`email` - `String`
`password` - `String!`

Example

{
  "username": "xyz789",
  "email": "abc123",
  "password": "xyz789"
}

Types

GitGlobalSettingsTestInput

Fields

Input Field	Description
`username` - `String`
`email` - `String`
`password` - `String`

Example

{
  "username": "xyz789",
  "email": "xyz789",
  "password": "abc123"
}

Types

GitIgnoreRule

Values

Enum Value	Description
`DATASOURCES`
`DATASOURCE_CREDENTIALS`
`TASKS`
`PROJECT_METADATA`
`PROJECT_SETTINGS`
`BOOKMARKS`
`DATASETS`
`DIAGRAMS`
`SCRIPTS`

Example

"DATASOURCES"

Types

GitProjectSettings

Fields

Field Name	Description
`enabled` - `Boolean!`
`repositoryUrl` - `String`
`branch` - `String`
`gitIgnoreRules` - `[GitIgnoreRule!]!`

Example

{
  "enabled": true,
  "repositoryUrl": "xyz789",
  "branch": "xyz789",
  "gitIgnoreRules": ["DATASOURCES"]
}

Types

GitProjectSettingsInput

Fields

Input Field	Description
`enabled` - `Boolean!`
`repositoryUrl` - `String!`
`branch` - `String`
`gitIgnoreRules` - `[GitIgnoreRule!]`

Example

{
  "enabled": true,
  "repositoryUrl": "xyz789",
  "branch": "xyz789",
  "gitIgnoreRules": ["DATASOURCES"]
}

Types

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

Types

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

Types

LMLicenseInfo

Fields

Field Name	Description
`id` - `String!`
`licenseType` - `String`
`ownerCompany` - `String`
`ownerName` - `String`
`ownerEmail` - `String`
`usersNumber` - `Int`
`yearsNumber` - `Int`
`subscription` - `Boolean`
`unlimitedServers` - `Boolean`
`multiInstance` - `Boolean`
`serversNumber` - `Int`
`licenseIssueTime` - `String`
`licenseStartTime` - `String`
`licenseEndTime` - `String`
`licenseRoles` - `[LMLicenseRole!]`
`licenseStatus` - `LMLicenseStatusDetails!`

Example

{
  "id": "xyz789",
  "licenseType": "xyz789",
  "ownerCompany": "abc123",
  "ownerName": "abc123",
  "ownerEmail": "abc123",
  "usersNumber": 987,
  "yearsNumber": 123,
  "subscription": false,
  "unlimitedServers": false,
  "multiInstance": false,
  "serversNumber": 123,
  "licenseIssueTime": "abc123",
  "licenseStartTime": "xyz789",
  "licenseEndTime": "xyz789",
  "licenseRoles": [LMLicenseRole],
  "licenseStatus": LMLicenseStatusDetails
}

Types

LMLicenseRole

Fields

Field Name	Description
`role` - `ID!`
`usersNumber` - `Int!`

Example

{"role": "4", "usersNumber": 987}

Types

LMLicenseStatus

Values

Enum Value	Description
`VALID`
`INVALID`
`EXPIRED`
`CANCELED`
`COMPROMISED`
`BAD_CODE`

Example

"VALID"

Types

LMLicenseStatusDetails

Fields

Field Name	Description
`message` - `String!`
`details` - `String`
`valid` - `Boolean!`
`remoteStatus` - `LMLicenseStatus`

Example

{
  "message": "abc123",
  "details": "xyz789",
  "valid": false,
  "remoteStatus": "VALID"
}

Types

LogEntry

Fields

Field Name	Description
`time` - `DateTime`
`type` - `String!`
`message` - `String`
`stackTrace` - `String`

Example

{
  "time": "2007-12-03T10:15:30Z",
  "type": "xyz789",
  "message": "xyz789",
  "stackTrace": "xyz789"
}

Types

LogoutInfo

Fields

Field Name	Description
`redirectLinks` - `[String!]!`

Example

{"redirectLinks": ["xyz789"]}

Types

MSServiceInfo

Fields

Field Name	Description
`id` - `String!`
`type` - `MSServiceType!`
`endpoint` - `String!`
`nodes` - `[MSServiceNode!]!`

Example

{
  "id": "abc123",
  "type": "DOMAIN_CONTROLLER",
  "endpoint": "abc123",
  "nodes": [MSServiceNode]
}

Types

MSServiceNode

Fields

Field Name	Description
`location` - `String!`
`status` - `String!`

Example

{
  "location": "abc123",
  "status": "abc123"
}

Types

MSServiceType

Values

Enum Value	Description
`DOMAIN_CONTROLLER`
`CLOUDBEAVER`
`RESOURCE_MANAGER`
`QUERY_MANAGER`

Example

"DOMAIN_CONTROLLER"

Types

NavigatorNodeFilter

Fields

Field Name	Description
`include` - `[String!]`
`exclude` - `[String!]`

Example

{
  "include": ["abc123"],
  "exclude": ["abc123"]
}

Types

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 No longer supported
`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!]`	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": "abc123",
  "fullName": "xyz789",
  "plainName": "xyz789",
  "icon": "xyz789",
  "description": "abc123",
  "nodeType": "abc123",
  "hasChildren": true,
  "projectId": "abc123",
  "object": DatabaseObjectInfo,
  "objectId": "xyz789",
  "features": ["abc123"],
  "nodeDetails": [ObjectPropertyInfo],
  "folder": true,
  "inline": false,
  "navigable": false,
  "filtered": false,
  "filter": NavigatorNodeFilter
}

Types

NavigatorSettings

Fields

Field Name	Description
`showSystemObjects` - `Boolean!`
`showUtilityObjects` - `Boolean!`
`showOnlyEntities` - `Boolean!`
`mergeEntities` - `Boolean!`
`hideFolders` - `Boolean!`
`hideSchemas` - `Boolean!`
`hideVirtualModel` - `Boolean!`

Example

{
  "showSystemObjects": true,
  "showUtilityObjects": true,
  "showOnlyEntities": true,
  "mergeEntities": true,
  "hideFolders": true,
  "hideSchemas": false,
  "hideVirtualModel": false
}

Types

NavigatorSettingsInput

Fields

Input Field	Description
`showSystemObjects` - `Boolean!`
`showUtilityObjects` - `Boolean!`
`showOnlyEntities` - `Boolean!`
`mergeEntities` - `Boolean!`
`hideFolders` - `Boolean!`
`hideSchemas` - `Boolean!`
`hideVirtualModel` - `Boolean!`

Example

{
  "showSystemObjects": true,
  "showUtilityObjects": false,
  "showOnlyEntities": false,
  "mergeEntities": false,
  "hideFolders": false,
  "hideSchemas": false,
  "hideVirtualModel": true
}

Types

NetworkEndpointInfo

Fields

Field Name	Description
`message` - `String`
`clientVersion` - `String`
`serverVersion` - `String`

Example

{
  "message": "xyz789",
  "clientVersion": "abc123",
  "serverVersion": "xyz789"
}

Types

NetworkHandlerAuthType

Values

Enum Value	Description
`PASSWORD`
`PUBLIC_KEY`
`AGENT`

Example

"PASSWORD"

Types

NetworkHandlerConfig

Description

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

Fields

Field Name	Description
`id` - `ID!`
`enabled` - `Boolean!`
`authType` - `NetworkHandlerAuthType!`	No longer supported
`userName` - `String`
`password` - `String`
`key` - `String`	No longer supported
`savePassword` - `Boolean!`
`properties` - `Object!`
`secureProperties` - `Object!`

Example

{
  "id": 4,
  "enabled": false,
  "authType": "PASSWORD",
  "userName": "abc123",
  "password": "xyz789",
  "key": "abc123",
  "savePassword": true,
  "properties": Object,
  "secureProperties": Object
}

Types

NetworkHandlerConfigInput

Fields

Input Field	Description
`id` - `ID!`
`enabled` - `Boolean`
`userName` - `String`
`password` - `String`
`savePassword` - `Boolean`
`properties` - `Object`
`secureProperties` - `Object`

Example

{
  "id": "4",
  "enabled": true,
  "userName": "xyz789",
  "password": "abc123",
  "savePassword": true,
  "properties": Object,
  "secureProperties": Object
}

Types

NetworkHandlerDescriptor

Fields

Field Name	Description
`id` - `ID!`
`codeName` - `String!`
`label` - `String!`
`description` - `String`
`secured` - `Boolean!`
`type` - `NetworkHandlerType`
`properties` - `[ObjectPropertyInfo!]!`

Example

{
  "id": 4,
  "codeName": "abc123",
  "label": "abc123",
  "description": "xyz789",
  "secured": true,
  "type": "TUNNEL",
  "properties": [ObjectPropertyInfo]
}

Types

NetworkHandlerType

Values

Enum Value	Description
`TUNNEL`
`PROXY`
`CONFIG`

Example

"TUNNEL"

Types

Object

Description

Any object (JSON)

Example

Object

Types

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]
}

Types

ObjectPropertyFilter

Fields

Input Field	Description
`ids` - `[String!]`
`features` - `[String!]`
`categories` - `[String!]`
`dataTypes` - `[String!]`

Example

{
  "ids": ["xyz789"],
  "features": ["xyz789"],
  "categories": ["xyz789"],
  "dataTypes": ["xyz789"]
}

Types

ObjectPropertyInfo

Fields

Field Name	Description
`id` - `String`
`displayName` - `String`	Human readable name
`description` - `String`	Property description
`hint` - `String`	Property hint
`category` - `String`	Property category (may be used if object has a lot of properties)
`dataType` - `String`	Property data type (int, String, etc)
`value` - `Object`
`validValues` - `[Object]`	List of values this property can take. Makes sense only for enumerable properties
`defaultValue` - `Object`	Default property value
`length` - `ObjectPropertyLength!`	Property value length
`features` - `[String!]!`	Supported features (system, hidden, inherited, foreign, expensive, etc)
`order` - `Int!`	Order position
`supportedConfigurationTypes` - `[String!]`	Supported configuration types (for driver properties)
`required` - `Boolean!`	Required parameters
`scopes` - `[String!]`	Parameter scopes
`conditions` - `[Condition!]`	Dynamic conditions for a property (f.e. visibility or read-only expressions)

Example

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

Types

ObjectPropertyLength

Values

Enum Value	Description
`TINY`
`SHORT`
`MEDIUM`
`LONG`
`MULTILINE`	Multi-line long text

Example

"TINY"

Types

OrganizationInfo

Description

DM queries

Fields

Field Name	Description
`id` - `ID!`
`baseDomain` - `String!`
`subdomain` - `String`
`deployments` - `[DeploymentInfo!]`
`currentDeployment` - `DeploymentInfo`

Example

{
  "id": "4",
  "baseDomain": "abc123",
  "subdomain": "xyz789",
  "deployments": [DeploymentInfo],
  "currentDeployment": DeploymentInfo
}

Types

PageInput

Fields

Input Field	Description
`limit` - `Int`
`offset` - `Int`

Example

{"limit": 987, "offset": 987}

Types

ProductInfo

Fields

Field Name	Description
`id` - `ID!`
`version` - `String!`
`name` - `String!`
`description` - `String`
`buildTime` - `String!`
`releaseTime` - `String!`
`licenseInfo` - `String`
`latestVersionInfo` - `String`
`productPurchaseURL` - `String`

Example

{
  "id": "4",
  "version": "xyz789",
  "name": "xyz789",
  "description": "abc123",
  "buildTime": "abc123",
  "releaseTime": "xyz789",
  "licenseInfo": "xyz789",
  "latestVersionInfo": "abc123",
  "productPurchaseURL": "xyz789"
}

Types

ProductSettings

Fields

Field Name	Description
`groups` - `[ProductSettingsGroup!]!`
`settings` - `[ObjectPropertyInfo!]!`

Example

{
  "groups": [ProductSettingsGroup],
  "settings": [ObjectPropertyInfo]
}

Types

ProductSettingsGroup

Fields

Field Name	Description
`id` - `ID!`
`displayName` - `String!`

Example

{
  "id": "4",
  "displayName": "abc123"
}

Types

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": true,
  "shared": true,
  "name": "abc123",
  "description": "abc123",
  "canEditDataSources": true,
  "canViewDataSources": false,
  "canEditResources": true,
  "canViewResources": true,
  "resourceTypes": [RMResourceType]
}

Types

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": "abc123",
  "page": 987,
  "pageSize": 987,
  "users": ["xyz789"],
  "projectIds": ["xyz789"],
  "catalogs": ["xyz789"],
  "schemas": ["abc123"],
  "objectTypes": ["session"],
  "queryTypes": ["USER"],
  "driverIds": ["xyz789"],
  "eventStatuses": ["FAILED"],
  "lastEventId": "4",
  "startDateRange": QMDateRange,
  "sort": QMSort
}

Types

QMDateRange

Fields

Input Field	Description
`from` - `String`
`to` - `String`

Example

{
  "from": "abc123",
  "to": "abc123"
}

Types

QMEventStatus

Values

Enum Value	Description
`FAILED`
`SUCCESS`

Example

"FAILED"

Types

QMMFilterResponse

Fields

Field Name	Description
`hasMore` - `Boolean!`
`objects` - `[QMMObject!]!`

Example

{"hasMore": true, "objects": [QMMObject]}

Types

QMMObject

Fields

Field Name	Description
`eventId` - `ID!`
`queryText` - `String!`
`startTime` - `Float!`
`objectType` - `String!`
`queryType` - `String`
`duration` - `Float`
`rows` - `Float`
`errorMessage` - `String`
`projectName` - `String!`
`dataSource` - `String!`
`connection` - `String!`
`driverId` - `String!`
`userIp` - `String`
`schemaName` - `String`
`catalog` - `String`
`user` - `QMUser`

Example

{
  "eventId": "4",
  "queryText": "xyz789",
  "startTime": 987.65,
  "objectType": "xyz789",
  "queryType": "xyz789",
  "duration": 123.45,
  "rows": 123.45,
  "errorMessage": "abc123",
  "projectName": "abc123",
  "dataSource": "abc123",
  "connection": "xyz789",
  "driverId": "abc123",
  "userIp": "abc123",
  "schemaName": "abc123",
  "catalog": "abc123",
  "user": QMUser
}

Types

QMObjectType

Values

Enum Value	Description
`session`
`txn`
`query`

Example

"session"

Types

QMQueryType

Values

Enum Value	Description
`USER`
`USER_FILTERED`
`USER_SCRIPT`
`UTIL`
`META`
`META_DDL`

Example

"USER"

Types

QMSearchFilter

Fields

Input Field	Description
`searchString` - `String`
`page` - `Int!`
`pageSize` - `Int!`
`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": 123,
  "projectIds": ["abc123"],
  "catalogs": ["xyz789"],
  "schemas": ["abc123"],
  "objectTypes": ["session"],
  "queryTypes": ["USER"],
  "driverIds": ["abc123"],
  "eventStatuses": ["FAILED"],
  "lastEventId": 4,
  "startDateRange": QMDateRange,
  "sort": QMSort
}

Types

QMSort

Fields

Input Field	Description
`desc` - `Boolean!`
`sortBy` - `QMSortField!`

Example

{"desc": false, "sortBy": "DATE"}

Types

QMSortField

Values

Enum Value	Description
`DATE`
`USER`
`DRIVER`
`QUERY_TEXT`

Example

"DATE"

Types

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": "xyz789",
  "page": 987,
  "pageSize": 987,
  "users": ["xyz789"],
  "teams": ["abc123"],
  "projectIds": ["xyz789"],
  "catalogs": ["abc123"],
  "schemas": ["xyz789"],
  "objectTypes": ["session"],
  "queryTypes": ["USER"],
  "driverIds": ["xyz789"],
  "eventStatuses": ["FAILED"],
  "lastEventId": 4,
  "startDateRange": QMDateRange,
  "sort": QMSort
}

Types

QMUser

Fields

Field Name	Description
`userId` - `String!`
`userDomain` - `String!`

Example

{
  "userId": "xyz789",
  "userDomain": "abc123"
}

Types

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": "xyz789",
  "description": "abc123",
  "shared": true,
  "global": false,
  "createTime": "2007-12-03T10:15:30Z",
  "creator": "xyz789",
  "projectPermissions": ["xyz789"],
  "resourceTypes": [RMResourceType]
}

Types

RMProjectPermissions

Fields

Input Field	Description
`projectId` - `String!`
`permissions` - `[String!]!`

Example

{
  "projectId": "xyz789",
  "permissions": ["abc123"]
}

Types

RMResource

Fields

Field Name	Description
`name` - `String!`
`folder` - `Boolean!`
`length` - `Int!`
`properties` - `Object`	Properties map

Example

{
  "name": "xyz789",
  "folder": false,
  "length": 123,
  "properties": Object
}

Types

RMResourceType

Fields

Field Name	Description
`id` - `String!`
`displayName` - `String!`
`icon` - `String`
`fileExtensions` - `[String!]!`
`rootFolder` - `String`

Example

{
  "id": "abc123",
  "displayName": "xyz789",
  "icon": "abc123",
  "fileExtensions": ["xyz789"],
  "rootFolder": "abc123"
}

Types

RMSubjectProjectPermissions

Fields

Input Field	Description
`subjectId` - `String!`
`permissions` - `[String!]!`

Example

{
  "subjectId": "xyz789",
  "permissions": ["xyz789"]
}

Types

ResultDataFormat

Values

Enum Value	Description
`resultset`
`document`
`graph`
`timeseries`

Example

"resultset"

Types

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": "abc123",
  "type": "abc123",
  "score": 123,
  "replacementString": "abc123",
  "replacementOffset": 123,
  "replacementLength": 987,
  "cursorPosition": 987,
  "icon": "abc123",
  "nodePath": "abc123"
}

Types

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": false,
  "defaultCatalog": "xyz789",
  "defaultSchema": "abc123"
}

Types

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": 987.65,
  "limit": 123,
  "constraints": [SQLDataFilterConstraint],
  "where": "abc123",
  "orderBy": "xyz789"
}

Types

SQLDataFilterConstraint

Fields

Input Field	Description
`attributePosition` - `Int!`
`orderPosition` - `Int`
`orderAsc` - `Boolean`
`criteria` - `String`
`operator` - `String`
`value` - `Object`

Example

{
  "attributePosition": 987,
  "orderPosition": 987,
  "orderAsc": true,
  "criteria": "xyz789",
  "operator": "abc123",
  "value": Object
}

Types

SQLDataFilterConstraintInfo

Fields

Field Name	Description
`orderPosition` - `Int`
`orderAsc` - `Boolean`
`criteria` - `String`
`operator` - `String`
`value` - `Object`

Example

{
  "orderPosition": 987,
  "orderAsc": true,
  "criteria": "xyz789",
  "operator": "xyz789",
  "value": Object
}

Types

SQLDataFilterInfo

Fields

Field Name	Description
`where` - `String`
`constraints` - `[SQLDataFilterConstraintInfo!]!`

Example

{
  "where": "xyz789",
  "constraints": [SQLDataFilterConstraintInfo]
}

Types

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": "abc123",
  "dataTypes": ["xyz789"],
  "functions": ["xyz789"],
  "reservedWords": ["xyz789"],
  "quoteStrings": ["xyz789"],
  "singleLineComments": ["abc123"],
  "multiLineComments": ["xyz789"],
  "catalogSeparator": "abc123",
  "structSeparator": "xyz789",
  "scriptDelimiter": "xyz789",
  "supportsExplainExecutionPlan": false
}

Types

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": "abc123",
  "duration": 123,
  "filterText": "xyz789",
  "fullQuery": "abc123",
  "results": [SQLQueryResults]
}

Types

SQLExecutionPlan

Fields

Field Name	Description
`query` - `String!`
`nodes` - `[SQLExecutionPlanNode!]!`

Example

{
  "query": "xyz789",
  "nodes": [SQLExecutionPlanNode]
}

Types

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": "abc123",
  "type": "xyz789",
  "condition": "xyz789",
  "description": "xyz789",
  "properties": [ObjectPropertyInfo]
}

Types

SQLQueryGenerator

Fields

Field Name	Description
`id` - `String!`
`label` - `String!`
`description` - `String`
`order` - `Int!`
`multiObject` - `Boolean!`

Example

{
  "id": "abc123",
  "label": "abc123",
  "description": "abc123",
  "order": 987,
  "multiObject": false
}

Types

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": 123.45,
  "sourceQuery": "xyz789",
  "dataFormat": "resultset",
  "resultSet": SQLResultSet
}

Types

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": "xyz789",
  "entityName": "xyz789",
  "dataKind": "xyz789",
  "typeName": "xyz789",
  "fullTypeName": "xyz789",
  "maxLength": 123.45,
  "scale": 123,
  "precision": 123,
  "required": true,
  "autoGenerated": false,
  "readOnly": false,
  "readOnlyStatus": "abc123",
  "supportedOperations": [DataTypeLogicalOperation]
}

Types

SQLResultRow

Fields

Input Field	Description
`data` - `[Object]!`
`updateValues` - `Object`
`metaData` - `Object`

Example

{
  "data": [Object],
  "updateValues": Object,
  "metaData": Object
}

Types

SQLResultRowMetaData

Fields

Field Name	Description
`data` - `[Object]!`
`metaData` - `Object`

Example

{
  "data": [Object],
  "metaData": Object
}

Types

SQLResultRowMetaDataInput

Fields

Input Field	Description
`data` - `[Object]`
`metaData` - `Object!`

Example

{
  "data": [Object],
  "metaData": Object
}

Types

SQLResultSet

Fields

Field Name	Description
`id` - `ID!`
`columns` - `[SQLResultColumn]`
`rows` - `[Object]`	No longer supported
`rowsWithMetaData` - `[SQLResultRowMetaData]`
`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!`	can't update data or load LOB file if hasRowIdentifier = false
`hasChildrenCollection` - `Boolean!`
`hasDynamicTrace` - `Boolean!`
`isSupportsDataFilter` - `Boolean!`
`readOnly` - `Boolean!`
`readOnlyStatus` - `String`

Example

{
  "id": "4",
  "columns": [SQLResultColumn],
  "rows": [Object],
  "rowsWithMetaData": [SQLResultRowMetaData],
  "singleEntity": true,
  "hasMoreData": false,
  "hasRowIdentifier": false,
  "hasChildrenCollection": true,
  "hasDynamicTrace": false,
  "isSupportsDataFilter": true,
  "readOnly": true,
  "readOnlyStatus": "abc123"
}

Types

SQLScriptInfo

Fields

Field Name	Description
`queries` - `[SQLScriptQuery!]!`

Example

{"queries": [SQLScriptQuery]}

Types

SQLScriptQuery

Fields

Field Name	Description
`start` - `Int!`
`end` - `Int!`

Example

{"start": 123, "end": 123}

Types

SecretConfiguration

Fields

Field Name	Description
`configurationId` - `String!`
`configurationName` - `String!`
`providerId` - `String!`
`description` - `String`
`parameters` - `[ObjectPropertyInfo!]!`

Example

{
  "configurationId": "abc123",
  "configurationName": "xyz789",
  "providerId": "xyz789",
  "description": "abc123",
  "parameters": [ObjectPropertyInfo]
}

Types

SecretConfigurationInput

Fields

Input Field	Description
`configurationId` - `String!`
`configurationName` - `String!`
`providerId` - `String!`
`description` - `String`
`parameters` - `Object!`

Example

{
  "configurationId": "abc123",
  "configurationName": "abc123",
  "providerId": "xyz789",
  "description": "xyz789",
  "parameters": Object
}

Types

SecretInfo

Fields

Field Name	Description
`displayName` - `String!`
`secretId` - `String!`

Example

{
  "displayName": "abc123",
  "secretId": "xyz789"
}

Types

SecretManagementInfo

Fields

Field Name	Description
`id` - `String!`
`label` - `String!`
`description` - `String!`
`configurationId` - `String`
`configurationName` - `String`

Example

{
  "id": "abc123",
  "label": "xyz789",
  "description": "xyz789",
  "configurationId": "xyz789",
  "configurationName": "abc123"
}

Types

ServerConfig

Fields

Field Name	Description
`name` - `String!`
`version` - `String!`
`workspaceId` - `ID!`
`anonymousAccessEnabled` - `Boolean!`
`supportsCustomConnections` - `Boolean!`
`resourceManagerEnabled` - `Boolean!`
`secretManagerEnabled` - `Boolean!`
`publicCredentialsSaveEnabled` - `Boolean!`
`adminCredentialsSaveEnabled` - `Boolean!`
`licenseRequired` - `Boolean!`
`licenseValid` - `Boolean!`
`licenseStatus` - `String`
`configurationMode` - `Boolean!`
`developmentMode` - `Boolean!`
`distributed` - `Boolean!`
`enabledFeatures` - `[ID!]!`
`disabledBetaFeatures` - `[ID!]`
`serverFeatures` - `[ID!]`
`supportedLanguages` - `[ServerLanguage!]!`
`services` - `[WebServiceConfig]`
`productConfiguration` - `Object!`
`productInfo` - `ProductInfo!`
`defaultNavigatorSettings` - `NavigatorSettings!`
`disabledDrivers` - `[ID!]!`
`resourceQuotas` - `Object!`

Example

{
  "name": "abc123",
  "version": "abc123",
  "workspaceId": 4,
  "anonymousAccessEnabled": true,
  "supportsCustomConnections": true,
  "resourceManagerEnabled": true,
  "secretManagerEnabled": true,
  "publicCredentialsSaveEnabled": false,
  "adminCredentialsSaveEnabled": true,
  "licenseRequired": false,
  "licenseValid": true,
  "licenseStatus": "abc123",
  "configurationMode": false,
  "developmentMode": true,
  "distributed": false,
  "enabledFeatures": [4],
  "disabledBetaFeatures": ["4"],
  "serverFeatures": [4],
  "supportedLanguages": [ServerLanguage],
  "services": [WebServiceConfig],
  "productConfiguration": Object,
  "productInfo": ProductInfo,
  "defaultNavigatorSettings": NavigatorSettings,
  "disabledDrivers": [4],
  "resourceQuotas": Object
}

Types

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": "xyz789",
  "serverURL": "xyz789",
  "adminName": "xyz789",
  "adminPassword": "xyz789",
  "anonymousAccessEnabled": false,
  "authenticationEnabled": false,
  "customConnectionsEnabled": false,
  "publicCredentialsSaveEnabled": false,
  "adminCredentialsSaveEnabled": true,
  "resourceManagerEnabled": false,
  "secretManagerEnabled": true,
  "enabledFeatures": ["4"],
  "enabledAuthProviders": [4],
  "disabledDrivers": [4],
  "sessionExpireTime": 987
}

Types

ServerError

Fields

Field Name	Description
`message` - `String`
`errorCode` - `String`
`errorType` - `String`
`stackTrace` - `String`
`causedBy` - `ServerError`

Example

{
  "message": "abc123",
  "errorCode": "xyz789",
  "errorType": "xyz789",
  "stackTrace": "xyz789",
  "causedBy": ServerError
}

Types

ServerLanguage

Fields

Field Name	Description
`isoCode` - `String!`
`displayName` - `String`
`nativeName` - `String`

Example

{
  "isoCode": "xyz789",
  "displayName": "abc123",
  "nativeName": "xyz789"
}

Types

ServerMessage

Fields

Field Name	Description
`time` - `String`
`message` - `String`

Example

{
  "time": "abc123",
  "message": "xyz789"
}

Types

SessionInfo

Fields

Field Name	Description
`createTime` - `String!`
`lastAccessTime` - `String!`
`locale` - `String!`
`cacheExpired` - `Boolean!`
`serverMessages` - `[ServerMessage]`
`connections` - `[ConnectionInfo!]!`
`actionParameters` - `Object`
`valid` - `Boolean!`
`remainingTime` - `Int!`

Example

{
  "createTime": "abc123",
  "lastAccessTime": "abc123",
  "locale": "abc123",
  "cacheExpired": false,
  "serverMessages": [ServerMessage],
  "connections": [ConnectionInfo],
  "actionParameters": Object,
  "valid": true,
  "remainingTime": 123
}

Types

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

"abc123"

Types

SubCollectionInfo

Fields

Field Name	Description
`icon` - `String!`
`name` - `String!`
`path` - `String!`

Example

{
  "icon": "xyz789",
  "name": "xyz789",
  "path": "abc123"
}

Types

TeamInfo

Fields

Field Name	Description
`teamId` - `String!`
`teamName` - `String!`

Example

{
  "teamId": "abc123",
  "teamName": "xyz789"
}

Types

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": "xyz789",
  "queryString": "xyz789",
  "durationMs": 123,
  "rows": 987,
  "result": "abc123"
}

Types

TransactionLogInfos

Fields

Field Name	Description
`count` - `Int!`
`transactionLogInfos` - `[TransactionLogInfoItem!]!`

Example

{
  "count": 123,
  "transactionLogInfos": [TransactionLogInfoItem]
}

Types

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": "xyz789",
  "displayName": "abc123",
  "message": "abc123",
  "origin": ObjectOrigin
}

Types

UserImportList

Fields

Input Field	Description
`users` - `[ExternalUserInput!]!`
`authRole` - `String`

Example

{
  "users": [ExternalUserInput],
  "authRole": "abc123"
}

Types

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!`

Example

{
  "userId": 4,
  "displayName": "abc123",
  "authRole": 4,
  "authTokens": [UserAuthToken],
  "linkedAuthProviders": ["xyz789"],
  "metaParameters": Object,
  "configurationParameters": Object,
  "teams": [UserTeamInfo],
  "isAnonymous": true
}

Types

UserTeamInfo

Fields

Field Name	Description
`teamId` - `String!`
`teamName` - `String!`
`teamRole` - `String`

Example

{
  "teamId": "xyz789",
  "teamName": "abc123",
  "teamRole": "abc123"
}

Types

VQBAssociationInput

Fields

Input Field	Description
`source` - `VQBEntityAttributeReferenceInput`
`target` - `VQBEntityAttributeReferenceInput`
`type` - `VQBAssociationType`

Example

{
  "source": VQBEntityAttributeReferenceInput,
  "target": VQBEntityAttributeReferenceInput,
  "type": "WHERE"
}

Types

VQBAssociationType

Values

Enum Value	Description
`WHERE`
`JOIN`

Example

"WHERE"

Types

VQBDataInput

Fields

Input Field	Description
`entities` - `[VQBEntityInput!]!`
`associations` - `[VQBAssociationInput!]`
`whereString` - `String`

Example

{
  "entities": [VQBEntityInput],
  "associations": [VQBAssociationInput],
  "whereString": "xyz789"
}

Types

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
}

Types

VQBEntityAttributeOrderType

Values

Enum Value	Description
`ASC`
`DESC`

Example

"ASC"

Types

VQBEntityAttributeReferenceInput

Fields

Input Field	Description
`entityId` - `Int!`
`attribute` - `String`

Example

{"entityId": 987, "attribute": "abc123"}

Types

VQBEntityInput

Fields

Input Field	Description
`id` - `Int!`
`name` - `String!`
`alias` - `String`
`fqn` - `String`
`nodeId` - `ID`
`attributes` - `[VQBEntityAttributeInput!]`
`operator` - `VQBLogicalOperator`
`joinType` - `VQBJoinType`

Example

{
  "id": 987,
  "name": "abc123",
  "alias": "xyz789",
  "fqn": "abc123",
  "nodeId": 4,
  "attributes": [VQBEntityAttributeInput],
  "operator": "ALL",
  "joinType": "SIMPLE"
}

Types

VQBJoinType

Values

Enum Value	Description
`SIMPLE`
`CROSS`
`INNER`
`LEFT`
`LEFT_OUTER`
`RIGHT`
`RIGHT_OUTER`
`FULL`
`FULL_OUTER`

Example

"SIMPLE"

Types

VQBLogicalOperator

Values

Enum Value	Description
`ALL`
`AND`
`ANY`
`BETWEEN`
`EXISTS`
`IN`
`LIKE`
`NOT`
`OR`
`SOME`

Example

"ALL"

Types

VQBQueryConfigInput

Fields

Input Field	Description
`data` - `VQBDataInput`

Example

{"data": VQBDataInput}

Types

WebFeatureSet

Fields

Field Name	Description
`id` - `String!`
`label` - `String!`
`description` - `String`
`icon` - `String`
`enabled` - `Boolean!`

Example

{
  "id": "xyz789",
  "label": "xyz789",
  "description": "abc123",
  "icon": "abc123",
  "enabled": false
}

Types

WebServiceConfig

Fields

Field Name	Description
`id` - `String!`
`name` - `String!`
`description` - `String!`
`bundleVersion` - `String!`

Example

{
  "id": "xyz789",
  "name": "abc123",
  "description": "xyz789",
  "bundleVersion": "abc123"
}

Documentation by Anvil SpectaQL