Team Edition REST API (26.1.2-SNAPSHOT)

Complete REST API reference for Team Edition. Use this reference to explore available endpoints, request parameters, and response schemas.

Authentication

1. Send a GET request to dc/auth/api and save the applicationWorkspaceId from the response.
2. Send a POST request to dc/auth with your credentials in userCredentials (password must be MD5-hashed when using local provider), appSessionId set to the applicationWorkspaceId from step 1, and sessionType set to {"sessionType": "db-session"}. Save the smAccessToken from the response.
3. Add the smAccessToken from step 2 to the Authorization header for all subsequent requests.

Health

Health check endpoints

Health check HealthController.health

Responses

Response Schema: text/plain

string

AdminObjects

Admin object management endpoints

Add object permissions DCAdminObjectsController.addObjectPermissions

query Parameters

objectIds required	Array of strings
objectType required	string (SMObjectType) Enum: "datasource" "project"
subjectIds required	Array of strings
permissions required	Array of strings

Responses

Delete object permissions DCAdminObjectsController.deleteObjectPermissions

query Parameters

objectIds required	Array of strings
objectType required	string (SMObjectType) Enum: "datasource" "project"
subjectIds required	Array of strings
permissions required	Array of strings

Responses

Delete object DCAdminObjectsController.deleteObject

query Parameters

projectId required	string
objectType required	string (SMObjectType) Enum: "datasource" "project"
objectId required	string

Responses

Get subject object permission grants DCAdminObjectsController.getSubjectObjectPermissionGrants

query Parameters

subjectId required	string
objectType required	string (SMObjectType) Enum: "datasource" "project"

Responses

Response Schema: application/json

Array

subjectId	string
subjectType	string (SMSubjectType) Enum: "user" "team"
	object (SMObjectPermissions)

Response samples

200

Content type

application/json

[{"subjectId": "string",
"subjectType": "user",
"objectPermissions": {"objectId": "string",
"permissions": ["string"
]
}
}
]

Delete all subject object permissions DCAdminObjectsController.deleteAllSubjectObjectPermissions

query Parameters

subjectId required	string
objectType required	string (SMObjectType) Enum: "datasource" "project"

Responses

Lock subject by brute force protection DCAdminObjectsController.lockSubjectByBruteForceProtection

query Parameters

projectId required	string
objectId required	string
objectType required	string (SMObjectType) Enum: "datasource" "project"
subjectId required	string

Responses

AdminSubjects

Admin subject management endpoints

Get meta parameters by subject type DCAdminSubjectsController.getMetaParametersBySubjectType

query Parameters

subjectType

required

string (SMSubjectType)

Enum: "user" "team"

Responses

Response Schema: application/json

Array

category	string
id	string
displayName	string
description	string
required	boolean
length	string (PropertyLength) Enum: "TINY" "SHORT" "MEDIUM" "LONG" "MULTILINE"
features	Array of strings

Response samples

200

Content type

application/json

[{"category": "string",
"id": "string",
"displayName": "string",
"description": "string",
"required": true,
"length": "TINY",
"features": ["string"
]
}
]

Get global default permissions DCAdminSubjectsController.getGlobalDefaultPermissions

Responses

Response Schema: application/json

Array

id	string
enabled	boolean

Response samples

200

Content type

application/json

[{"id": "string",
"enabled": true
}
]

Set global default permissions DCAdminSubjectsController.setGlobalDefaultPermissions

query Parameters

grantorId

required

string

Request Body schema: application/json

Array

id	string
enabled	boolean

Responses

Request samples

Payload

Content type

application/json

[{"id": "string",
"enabled": true
}
]

Set subject permissions DCAdminSubjectsController.setSubjectPermissions

query Parameters

subjectId

required

string

Request Body schema: application/json

permissionIds

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"permissionIds": ["string"
]
}

Set global subject permissions DCAdminSubjectsController.setGlobalSubjectPermissions

query Parameters

subjectId required	string
grantorId required	string

Request Body schema: application/json

Array

id	string
enabled	boolean

Responses

Request samples

Payload

Content type

application/json

[{"id": "string",
"enabled": true
}
]

Get granted global permissions DCAdminSubjectsController.getGrantedGlobalPermissions

query Parameters

subjectId

required

string

Responses

Response Schema: application/json

Array

subjectId	string
subjectType	string (SMSubjectType) Enum: "user" "team"
permissionId	string
enabled	boolean

Response samples

200

Content type

application/json

[{"subjectId": "string",
"subjectType": "user",
"permissionId": "string",
"enabled": true
}
]

AdminTeams

Admin teams management endpoints

Get all teams DCAdminTeamsController.getAllTeams

Responses

Response Schema: application/json

Array

subjectId	string
secretStorage	boolean
	object
teamName	string
description	string
permissions	Array of strings unique
teamId	string
name	string

Response samples

200

Content type

application/json

[{"subjectId": "string",
"secretStorage": true,
"metaParameters": {"property1": "string",
"property2": "string"
},
"teamName": "string",
"description": "string",
"permissions": ["string"
],
"teamId": "string",
"name": "string"
}
]

Create team DCAdminTeamsController.createTeam

Request Body schema: application/json

teamId	string
name	string
description	string
grantor	string

Responses

Response Schema: application/json

subjectId	string
secretStorage	boolean
	object
teamName	string
description	string
permissions	Array of strings unique
teamId	string
name	string

Request samples

Payload

Content type

application/json

{"teamId": "string",
"name": "string",
"description": "string",
"grantor": "string"
}

Response samples

200

Content type

application/json

{"subjectId": "string",
"secretStorage": true,
"metaParameters": {"property1": "string",
"property2": "string"
},
"teamName": "string",
"description": "string",
"permissions": ["string"
],
"teamId": "string",
"name": "string"
}

Find team by id DCAdminTeamsController.findTeam

query Parameters

teamId

required

string

Responses

Response Schema: application/json

subjectId	string
secretStorage	boolean
	object
teamName	string
description	string
permissions	Array of strings unique
teamId	string
name	string

Response samples

200

Content type

application/json

{"subjectId": "string",
"secretStorage": true,
"metaParameters": {"property1": "string",
"property2": "string"
},
"teamName": "string",
"description": "string",
"permissions": ["string"
],
"teamId": "string",
"name": "string"
}

Update team DCAdminTeamsController.updateTeam

query Parameters

teamId

required

string

Request Body schema: application/json

name	string
description	string
permissions	Array of strings unique

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"permissions": ["string"
]
}

Delete team DCAdminTeamsController.deleteTeam

query Parameters

teamId required	string
force required	boolean

Responses

Get team members info DCAdminTeamsController.getTeamMembersInfo

query Parameters

teamId

required

string

Responses

Response Schema: application/json

Array

userId	string
teamRole	string

Response samples

200

Content type

application/json

[{"userId": "string",
"teamRole": "string"
}
]

Set user team role DCAdminTeamsController.setUserTeamRole

query Parameters

userId required	string
teamId required	string
teamRole required	string

Responses

Get team members (legacy) Deprecated DCAdminTeamsController.getTeamMembers

query Parameters

teamId

required

string

Responses

Response Schema: application/json

Array

string

Response samples

200

Content type

application/json

["string"
]

AdminUsers

Admin users management endpoints

Find users by mask DCAdminUsersController.findUsers

query Parameters

userNameMask

required

string

Responses

Response Schema: application/json

Array

subjectId	string
secretStorage	boolean
	object
userTeams	Array of strings
enabled	boolean
authRole	string
disableDate	string <date-time>
disabledBy	string
disableReason	string
lastLoginTime	string <date-time>
name	string
userId	string

Response samples

200

Content type

application/json

[{"subjectId": "string",
"secretStorage": true,
"metaParameters": {"property1": "string",
"property2": "string"
},
"userTeams": ["string"
],
"enabled": true,
"authRole": "string",
"disableDate": "2019-08-24T14:15:22Z",
"disabledBy": "string",
"disableReason": "string",
"lastLoginTime": "2019-08-24T14:15:22Z",
"name": "string",
"userId": "string"
}
]

Create user DCAdminUsersController.createUser

Request Body schema: application/json

userId	string
	object
enabled	boolean
authRole	string

Responses

Request samples

Payload

Content type

application/json

{"userId": "string",
"metaParameters": {"property1": "string",
"property2": "string"
},
"enabled": true,
"authRole": "string"
}

Count users DCAdminUsersController.countUsers

Request Body schema: application/json

userIdMask	string
enabledState	boolean
	object (DBPPage)

Responses

Response Schema: application/json

integer <int32>

Request samples

Payload

Content type

application/json

{"userIdMask": "string",
"enabledState": true,
"page": {"offset": 0,
"limit": 0
}
}

Response samples

200

Content type

application/json

0

0

Find users by filter DCAdminUsersController.findUsers2

Request Body schema: application/json

userIdMask	string
enabledState	boolean
	object (DBPPage)

Responses

Response Schema: application/json

Array

subjectId	string
secretStorage	boolean
	object
userTeams	Array of strings
enabled	boolean
authRole	string
disableDate	string <date-time>
disabledBy	string
disableReason	string
lastLoginTime	string <date-time>
name	string
userId	string

Request samples

Payload

Content type

application/json

{"userIdMask": "string",
"enabledState": true,
"page": {"offset": 0,
"limit": 0
}
}

Response samples

200

Content type

application/json

[{"subjectId": "string",
"secretStorage": true,
"metaParameters": {"property1": "string",
"property2": "string"
},
"userTeams": ["string"
],
"enabled": true,
"authRole": "string",
"disableDate": "2019-08-24T14:15:22Z",
"disabledBy": "string",
"disableReason": "string",
"lastLoginTime": "2019-08-24T14:15:22Z",
"name": "string",
"userId": "string"
}
]

Import users DCAdminUsersController.importUsers

Request Body schema: application/json

	Array of objects (SMUserProvisioning)
authRole	string

Responses

Request samples

Payload

Content type

application/json

{"users": [{"userId": "string",
"metaParameters": {"property1": "string",
"property2": "string"
},
"authRole": "string"
}
],
"authRole": "string"
}

Invalidate all tokens DCAdminUsersController.invalidateAllTokens

Responses

Get user by id DCAdminUsersController.getUserById

query Parameters

userId

required

string

Responses

Response Schema: application/json

subjectId	string
secretStorage	boolean
	object
userTeams	Array of strings
enabled	boolean
authRole	string
disableDate	string <date-time>
disabledBy	string
disableReason	string
lastLoginTime	string <date-time>
name	string
userId	string

Response samples

200

Content type

application/json

{"subjectId": "string",
"secretStorage": true,
"metaParameters": {"property1": "string",
"property2": "string"
},
"userTeams": ["string"
],
"enabled": true,
"authRole": "string",
"disableDate": "2019-08-24T14:15:22Z",
"disabledBy": "string",
"disableReason": "string",
"lastLoginTime": "2019-08-24T14:15:22Z",
"name": "string",
"userId": "string"
}

Delete user DCAdminUsersController.deleteUser

query Parameters

userId

required

string

Responses

Update user auth role DCAdminUsersController.updateUserAuthRole

query Parameters

userId

required

string

Request Body schema: application/json

authRole

string

Responses

Request samples

Payload

Content type

application/json

{"authRole": "string"
}

Block user by brute force protection DCAdminUsersController.blockUserByBruteForceProtection

query Parameters

userId

required

string

Responses

Get user credentials DCAdminUsersController.getUserCredentials

query Parameters

userId required	string
authProviderId required	string

Responses

Response Schema: application/json

property name*

additional property

any

Response samples

200

Content type

application/json

{"property1": null,
"property2": null
}

Set user credentials DCAdminUsersController.setUserCredentials

query Parameters

userId

required

string

Request Body schema: application/json

authProviderId	string
	object

Responses

Request samples

Payload

Content type

application/json

{"authProviderId": "string",
"credentials": {"property1": null,
"property2": null
}
}

Delete user credentials DCAdminUsersController.deleteUserCredentials

query Parameters

userId required	string
authProviderId required	string

Responses

Enable or disable user DCAdminUsersController.enableUser

query Parameters

userId

required

string

Request Body schema: application/json

enabled

boolean

Responses

Request samples

Payload

Content type

application/json

{"enabled": true
}

Update user meta DCAdminUsersController.updateUserMeta

query Parameters

userId

required

string

Request Body schema: application/json

property name*

additional property

string

Responses

Request samples

Payload

Content type

application/json

{"property1": "string",
"property2": "string"
}

Get user linked providers DCAdminUsersController.getUserLinkedProviders

query Parameters

userId

required

string

Responses

Response Schema: application/json

Array

string

Response samples

200

Content type

application/json

["string"
]

Get user teams DCAdminUsersController.getUserTeams

query Parameters

userId

required

string

Responses

Response Schema: application/json

Array

subjectId	string
secretStorage	boolean
	object
teamName	string
description	string
permissions	Array of strings unique
teamId	string
name	string

Response samples

200

Content type

application/json

[{"subjectId": "string",
"secretStorage": true,
"metaParameters": {"property1": "string",
"property2": "string"
},
"teamName": "string",
"description": "string",
"permissions": ["string"
],
"teamId": "string",
"name": "string"
}
]

Add user teams DCAdminUsersController.addUserTeams

query Parameters

userId required	string
arg1 required	Array of strings
grantorId required	string

Responses

Update user teams DCAdminUsersController.updateUserTeams

query Parameters

userId

required

string

Request Body schema: application/json

teamIds

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"teamIds": ["string"
]
}

Delete user teams DCAdminUsersController.deleteUserTeams

query Parameters

userId required	string
arg1 required	Array of strings

Responses

Auth

Authentication endpoints

Authenticate session DCAuthController.authenticate

Request Body schema: application/json

authProviderId	string
authProviderConfigurationId	string
	object
appSessionId	string
previousSmSessionId	string
forceSessionsLogout	boolean
	object
	object (SMSessionType)

Responses

Response Schema: application/json

authStatus	string (SMAuthStatus) Enum: "SUCCESS" "IN_PROGRESS" "ERROR" "EXPIRED"
error	string
authAttemptId	string
	object
redirectUrl	string
signOutLink	string
smAccessToken	string
smRefreshToken	string
authRole	string
	object (SMAuthPermissions)
mainAuth	boolean
forceSessionsLogout	boolean
errorCode	string
appSessionId	string
signInLink	string

Request samples

Payload

Content type

application/json

{"authProviderId": "string",
"authProviderConfigurationId": "string",
"userCredentials": {"property1": null,
"property2": null
},
"appSessionId": "string",
"previousSmSessionId": "string",
"forceSessionsLogout": true,
"sessionParameters": {"property1": null,
"property2": null
},
"sessionType": {"sessionType": "string"
}
}

Response samples

200

Content type

application/json

{"authStatus": "SUCCESS",
"error": "string",
"authAttemptId": "string",
"authData": {"property1": null,
"property2": null
},
"redirectUrl": "string",
"signOutLink": "string",
"smAccessToken": "string",
"smRefreshToken": "string",
"authRole": "string",
"authPermissions": {"userId": "string",
"sessionId": "string",
"permissions": ["string"
]
},
"mainAuth": true,
"forceSessionsLogout": true,
"errorCode": "string",
"appSessionId": "string",
"signInLink": "string"
}

Get server API info DCAuthController.getServerAPI

Responses

Response Schema: application/json

serverId	string
serverVersion	string
serverApiVersion	string
minimumClientApiVersion	string
secretController	string
companyName	string
applicationWorkspaceId	string

Response samples

200

Content type

application/json

{"serverId": "string",
"serverVersion": "string",
"serverApiVersion": "string",
"minimumClientApiVersion": "string",
"secretController": "string",
"companyName": "string",
"applicationWorkspaceId": "string"
}

Get internal database information DCAuthController.getInternalDatabaseInformation

Responses

Response Schema: application/json

url	string
driverName	string
productName	string
productVersion	string

Response samples

200

Content type

application/json

{"url": "string",
"driverName": "string",
"productName": "string",
"productVersion": "string"
}

Get current auth permissions DCAuthController.currentAuthInfo

Responses

Response Schema: application/json

userId	string
sessionId	string
permissions	Array of strings unique

Response samples

200

Content type

application/json

{"userId": "string",
"sessionId": "string",
"permissions": ["string"
]
}

Logout current session DCAuthController.logout

Responses

Ping auth service DCAuthController.ping

Responses

Response Schema: text/plain

string

Get available auth providers DCAuthController.getAvailableAuthProviders

Responses

Response Schema: application/json

Array

id	string
label	string
description	string
icon	string
	Array of objects (SMAuthCredentialsProfile)
	Array of objects (SMAuthProviderCustomConfiguration)

Response samples

200

Content type

application/json

[{"id": "string",
"label": "string",
"description": "string",
"icon": "string",
"credentialProfiles": [{"id": "string",
"label": "string",
"description": "string",
"credentialParameters": {"property1": {"id": "string",
"name": "string",
"description": "string",
"hint": "string",
"category": "string",
"propertyType": "t_string",
"required": true,
"defaultValue": null,
"desktop": true,
"hidden": true,
"length": "TINY",
"features": ["string"
],
"encryption": "none",
"identifying": true,
"admin": true,
"user": true,
"requiredFeatures": ["string"
],
"dataType": null,
"displayName": "string"
},
"property2": {"id": "string",
"name": "string",
"description": "string",
"hint": "string",
"category": "string",
"propertyType": "t_string",
"required": true,
"defaultValue": null,
"desktop": true,
"hidden": true,
"length": "TINY",
"features": ["string"
],
"encryption": "none",
"identifying": true,
"admin": true,
"user": true,
"requiredFeatures": ["string"
],
"dataType": null,
"displayName": "string"
}
}
}
],
"customConfigurations": [{"id": "string",
"provider": "string",
"displayName": "string",
"disabled": true,
"iconURL": "string",
"description": "string",
"parameters": {"property1": null,
"property2": null
},
"authConfigurationReference": {"authProviderId": "string",
"authProviderConfigurationId": "string"
}
}
]
}
]

Refresh session tokens DCAuthController.refreshSession

query Parameters

refreshToken

required

string

Responses

Response Schema: application/json

smAccessToken	string
smRefreshToken	string

Response samples

200

Content type

application/json

{"smAccessToken": "string",
"smRefreshToken": "string"
}

Restore user session by appSessionId DCAuthController.restoreUserSession

query Parameters

appSessionId

required

string

Responses

Response Schema: application/json

authStatus	string (SMAuthStatus) Enum: "SUCCESS" "IN_PROGRESS" "ERROR" "EXPIRED"
error	string
authAttemptId	string
	object
redirectUrl	string
signOutLink	string
smAccessToken	string
smRefreshToken	string
authRole	string
	object (SMAuthPermissions)
mainAuth	boolean
forceSessionsLogout	boolean
errorCode	string
appSessionId	string
signInLink	string

Response samples

200

Content type

application/json

{"authStatus": "SUCCESS",
"error": "string",
"authAttemptId": "string",
"authData": {"property1": null,
"property2": null
},
"redirectUrl": "string",
"signOutLink": "string",
"smAccessToken": "string",
"smRefreshToken": "string",
"authRole": "string",
"authPermissions": {"userId": "string",
"sessionId": "string",
"permissions": ["string"
]
},
"mainAuth": true,
"forceSessionsLogout": true,
"errorCode": "string",
"appSessionId": "string",
"signInLink": "string"
}

Get auth status DCAuthController.getAuthStatus

query Parameters

authId

required

string

Responses

Response Schema: application/json

authStatus	string (SMAuthStatus) Enum: "SUCCESS" "IN_PROGRESS" "ERROR" "EXPIRED"
error	string
authAttemptId	string
	object
redirectUrl	string
signOutLink	string
smAccessToken	string
smRefreshToken	string
authRole	string
	object (SMAuthPermissions)
mainAuth	boolean
forceSessionsLogout	boolean
errorCode	string
appSessionId	string
signInLink	string

Response samples

200

Content type

application/json

{"authStatus": "SUCCESS",
"error": "string",
"authAttemptId": "string",
"authData": {"property1": null,
"property2": null
},
"redirectUrl": "string",
"signOutLink": "string",
"smAccessToken": "string",
"smRefreshToken": "string",
"authRole": "string",
"authPermissions": {"userId": "string",
"sessionId": "string",
"permissions": ["string"
]
},
"mainAuth": true,
"forceSessionsLogout": true,
"errorCode": "string",
"appSessionId": "string",
"signInLink": "string"
}

(Deprecated) Get auth status from path variable Deprecated DCAuthController.getAuthStatusFromPathVariable

path Parameters

authId

required

string

Responses

Response Schema: application/json

authStatus	string (SMAuthStatus) Enum: "SUCCESS" "IN_PROGRESS" "ERROR" "EXPIRED"
error	string
authAttemptId	string
	object
redirectUrl	string
signOutLink	string
smAccessToken	string
smRefreshToken	string
authRole	string
	object (SMAuthPermissions)
mainAuth	boolean
forceSessionsLogout	boolean
errorCode	string
appSessionId	string
signInLink	string

Response samples

200

Content type

application/json

{"authStatus": "SUCCESS",
"error": "string",
"authAttemptId": "string",
"authData": {"property1": null,
"property2": null
},
"redirectUrl": "string",
"signOutLink": "string",
"smAccessToken": "string",
"smRefreshToken": "string",
"authRole": "string",
"authPermissions": {"userId": "string",
"sessionId": "string",
"permissions": ["string"
]
},
"mainAuth": true,
"forceSessionsLogout": true,
"errorCode": "string",
"appSessionId": "string",
"signInLink": "string"
}

Configuration

Endpoints to manage service, common, user and application configurations

Get application configuration MSConfigurationController.getApplicationConfiguration

Returns application-level configuration

Responses

Response Schema: application/json

enabledServices	Array of strings
defaultTeamId	string
applicationWorkspaceId	string
	object

Response samples

200

Content type

application/json

{"enabledServices": ["string"
],
"defaultTeamId": "string",
"applicationWorkspaceId": "string",
"productConfiguration": {"property1": null,
"property2": null
}
}

Update common configuration MSConfigurationController.updateCommonConfiguration

Update common configuration and trigger configuration update notifications

Request Body schema: application/json

property name*

additional property

any

Responses

Request samples

Payload

Content type

application/json

{"property1": null,
"property2": null
}

Get service configuration MSConfigurationController.getServiceConfiguration

Returns configuration for a specific service type

query Parameters

serviceType

required

string (MSServiceType)

Enum: "CLOUDBEAVER" "DOMAIN_CONTROLLER" "RESOURCE_MANAGER" "QUERY_MANAGER" "EVENT_MANAGER" "TASK_MANAGER"

Responses

Response Schema: application/json

property name*

additional property

any

Response samples

200

Content type

application/json

{"property1": null,
"property2": null
}

Save service configuration MSConfigurationController.saveServiceConfiguration

Save configuration for a specific service type and notify instances

query Parameters

serviceType

required

string (MSServiceType)

Enum: "CLOUDBEAVER" "DOMAIN_CONTROLLER" "RESOURCE_MANAGER" "QUERY_MANAGER" "EVENT_MANAGER" "TASK_MANAGER"

Request Body schema: application/json

property name*

additional property

any

Responses

Request samples

Payload

Content type

application/json

{"property1": null,
"property2": null
}

Get user configuration MSConfigurationController.getUserConfiguration

Returns user configuration based on request origin

Responses

Response Schema: application/json

	object
	Array of objects (SMProjectPermissions)
	object
	object

Response samples

200

Content type

application/json

{"userPreferences": {"property1": null,
"property2": null
},
"projectPermissions": [{"projectId": "string",
"permissions": ["read"
]
}
],
"serviceEndpoints": {"property1": "string",
"property2": "string"
},
"userMetaParameters": {"property1": null,
"property2": null
}
}

EasyConfig

Easy configuration endpoints

Finish security service configuration DCEasyConfigController.finishSecurityServiceConfiguration

Request Body schema: application/json

user	string
password	string
	Array of objects (SMAuthConfiguration)

Responses

Request samples

Payload

Content type

application/json

{"user": "string",
"password": "string",
"authInfos": [{"authProvider": "string",
"userCredentials": {"property1": null,
"property2": null
}
}
]
}

License

Product license management endpoints

Get all product licenses DCLicenseController.getAllProductLicenses

Responses

Response Schema: application/json

Array

licenseId	string
licenseType	string (LMLicenseType) Enum: "STANDARD" "YEAR_UPDATE" "YEAR_CORPORATE" "ULTIMATE" "LIMITED" "PARTNER" "TRIAL" "EAP" "ACADEMIC" "TEAM" "MARKETPLACE" "CUSTOM" "PER_MACHINE"
licenseIssueTime	string <date-time>
licenseStartTime	string <date-time>
licenseEndTime	string <date-time>
flags	integer <int64>
productId	string
productVersion	string
ownerId	string
ownerCompany	string
ownerName	string
ownerEmail	string
usersNumber	integer <int32>
	Array of objects (LMLicenseRole)
features	Array of strings

Response samples

200

Content type

application/json

[{"licenseId": "string",
"licenseType": "STANDARD",
"licenseIssueTime": "2019-08-24T14:15:22Z",
"licenseStartTime": "2019-08-24T14:15:22Z",
"licenseEndTime": "2019-08-24T14:15:22Z",
"flags": 0,
"productId": "string",
"productVersion": "string",
"ownerId": "string",
"ownerCompany": "string",
"ownerName": "string",
"ownerEmail": "string",
"usersNumber": 0,
"roles": [{"role": "ADMINISTRATOR",
"usersNumber": 0
}
],
"features": ["string"
]
}
]

Import product license DCLicenseController.importProductLicense

Request Body schema: application/json

license

string

Responses

Response Schema: application/json

licenseId	string
licenseType	string (LMLicenseType) Enum: "STANDARD" "YEAR_UPDATE" "YEAR_CORPORATE" "ULTIMATE" "LIMITED" "PARTNER" "TRIAL" "EAP" "ACADEMIC" "TEAM" "MARKETPLACE" "CUSTOM" "PER_MACHINE"
licenseIssueTime	string <date-time>
licenseStartTime	string <date-time>
licenseEndTime	string <date-time>
flags	integer <int64>
productId	string
productVersion	string
ownerId	string
ownerCompany	string
ownerName	string
ownerEmail	string
usersNumber	integer <int32>
	Array of objects (LMLicenseRole)
features	Array of strings

Request samples

Payload

Content type

application/json

{"license": "string"
}

Response samples

200

Content type

application/json

{"licenseId": "string",
"licenseType": "STANDARD",
"licenseIssueTime": "2019-08-24T14:15:22Z",
"licenseStartTime": "2019-08-24T14:15:22Z",
"licenseEndTime": "2019-08-24T14:15:22Z",
"flags": 0,
"productId": "string",
"productVersion": "string",
"ownerId": "string",
"ownerCompany": "string",
"ownerName": "string",
"ownerEmail": "string",
"usersNumber": 0,
"roles": [{"role": "ADMINISTRATOR",
"usersNumber": 0
}
],
"features": ["string"
]
}

Delete license DCLicenseController.deleteLicense

query Parameters

licenseId

required

string

Responses

Get active product license DCLicenseController.getActiveProductLicense

query Parameters

validate

required

boolean

Responses

Response Schema: application/json

licenseId	string
licenseType	string (LMLicenseType) Enum: "STANDARD" "YEAR_UPDATE" "YEAR_CORPORATE" "ULTIMATE" "LIMITED" "PARTNER" "TRIAL" "EAP" "ACADEMIC" "TEAM" "MARKETPLACE" "CUSTOM" "PER_MACHINE"
licenseIssueTime	string <date-time>
licenseStartTime	string <date-time>
licenseEndTime	string <date-time>
flags	integer <int64>
productId	string
productVersion	string
ownerId	string
ownerCompany	string
ownerName	string
ownerEmail	string
usersNumber	integer <int32>
	Array of objects (LMLicenseRole)
features	Array of strings

Response samples

200

Content type

application/json

{"licenseId": "string",
"licenseType": "STANDARD",
"licenseIssueTime": "2019-08-24T14:15:22Z",
"licenseStartTime": "2019-08-24T14:15:22Z",
"licenseEndTime": "2019-08-24T14:15:22Z",
"flags": 0,
"productId": "string",
"productVersion": "string",
"ownerId": "string",
"ownerCompany": "string",
"ownerName": "string",
"ownerEmail": "string",
"usersNumber": 0,
"roles": [{"role": "ADMINISTRATOR",
"usersNumber": 0
}
],
"features": ["string"
]
}

Get active encoded license DCLicenseController.getActiveEncodedLicense

Responses

Response Schema: text/plain

string

Invalidate license DCLicenseController.invalidateLicense

Responses

Response Schema: application/json

boolean

Response samples

200

Content type

application/json

true

Get active product DCLicenseController.getActiveProduct

Responses

Response Schema: application/json

id	string
prefix	string
name	string
description	string
version	string
latestVersion	string
releaseDate	string <date-time>
umbrellaProducts	Array of strings
type	string (LMProductType) Enum: "DESKTOP" "SERVER"

Response samples

200

Content type

application/json

{"id": "string",
"prefix": "string",
"name": "string",
"description": "string",
"version": "string",
"latestVersion": "string",
"releaseDate": "2019-08-24T14:15:22Z",
"umbrellaProducts": ["string"
],
"type": "DESKTOP"
}

Get active license status DCLicenseController.getActiveLicenseStatus

Responses

Response Schema: text/plain

string

OAuthModel

Database OAuth token endpoints

Create OAuth state DCOAuthModelController.createOAuthState

Responses

Response Schema: text/plain

string

Get OAuth access token DCOAuthModelController.getOAuthAccessToken

query Parameters

state

required

string

Responses

Response Schema: text/plain

string

Save OAuth access token DCOAuthModelController.saveOAuthAccessToken

Request Body schema: application/json

state	string
token	string
errorMessage	string

Responses

Request samples

Payload

Content type

application/json

{"state": "string",
"token": "string",
"errorMessage": "string"
}

OAuthStorage

OAuth client and authorization request storage endpoints

Get OAuth clients DCOAuthStorageController.getOAuthClients

Responses

Response Schema: application/json

Array

clientId	string
clientSecret	string
clientName	string
redirectUris	Array of strings
scope	string

Response samples

200

Content type

application/json

[{"clientId": "string",
"clientSecret": "string",
"clientName": "string",
"redirectUris": ["string"
],
"scope": "string"
}
]

Save OAuth client DCOAuthStorageController.saveOAuthClient

Request Body schema: application/json

clientId	string
clientSecret	string
clientName	string
redirectUris	Array of strings
scope	string

Responses

Request samples

Payload

Content type

application/json

{"clientId": "string",
"clientSecret": "string",
"clientName": "string",
"redirectUris": ["string"
],
"scope": "string"
}

Get OAuth client DCOAuthStorageController.getOAuthClient

query Parameters

clientId

required

string

Responses

Response Schema: application/json

clientId	string
clientSecret	string
clientName	string
redirectUris	Array of strings
scope	string

Response samples

200

Content type

application/json

{"clientId": "string",
"clientSecret": "string",
"clientName": "string",
"redirectUris": ["string"
],
"scope": "string"
}

Delete OAuth client DCOAuthStorageController.deleteOAuthClient

query Parameters

clientId

required

string

Responses

Save OAuth authorization request DCOAuthStorageController.saveOAuthAuthRequest

Request Body schema: application/json

code	string
clientId	string
redirectUri	string
scope	string
state	string
smAccessToken	string
codeChallenge	string
codeChallengeMethod	string
createTime	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"code": "string",
"clientId": "string",
"redirectUri": "string",
"scope": "string",
"state": "string",
"smAccessToken": "string",
"codeChallenge": "string",
"codeChallengeMethod": "string",
"createTime": "2019-08-24T14:15:22Z"
}

Get OAuth authorization request DCOAuthStorageController.getOAuthAuthRequest

query Parameters

code

required

string

Responses

Response Schema: application/json

code	string
clientId	string
redirectUri	string
scope	string
state	string
smAccessToken	string
codeChallenge	string
codeChallengeMethod	string
createTime	string <date-time>

Response samples

200

Content type

application/json

{"code": "string",
"clientId": "string",
"redirectUri": "string",
"scope": "string",
"state": "string",
"smAccessToken": "string",
"codeChallenge": "string",
"codeChallengeMethod": "string",
"createTime": "2019-08-24T14:15:22Z"
}

Delete OAuth authorization request DCOAuthStorageController.deleteOAuthAuthRequest

query Parameters

code

required

string

Responses

Objects

Object permissions and settings endpoints

Get all available objects permissions DCObjectsController.getAllAvailableObjectsPermissions

query Parameters

objectType

required

string (SMObjectType)

Enum: "datasource" "project"

Responses

Response Schema: application/json

Array

objectId	string
permissions	Array of strings

Response samples

200

Content type

application/json

[{"objectId": "string",
"permissions": ["string"
]
}
]

Set object permissions DCObjectsController.setObjectPermissions

Request Body schema: application/json

objectIds	Array of strings unique
objectType	string (SMObjectType) Enum: "datasource" "project"
subjectIds	Array of strings unique
permissions	Array of strings unique

Responses

Request samples

Payload

Content type

application/json

{"objectIds": ["string"
],
"objectType": "datasource",
"subjectIds": ["string"
],
"permissions": ["string"
]
}

Get object settings DCObjectsController.getObjectSettings

query Parameters

projectId required	string
objectType required	string (SMObjectType) Enum: "datasource" "project"
objectId required	string
settingIds required	Array of strings

Responses

Response Schema: application/json

Array

objectType	string (SMObjectType) Enum: "datasource" "project"
objectId	string
	object

Response samples

200

Content type

application/json

[{"objectType": "datasource",
"objectId": "string",
"settings": {"property1": "string",
"property2": "string"
}
}
]

Set object settings DCObjectsController.setObjectSettings

Request Body schema: application/json

projectId	string
objectId	string
objectType	string (SMObjectType) Enum: "datasource" "project"
	object

Responses

Request samples

Payload

Content type

application/json

{"projectId": "string",
"objectId": "string",
"objectType": "datasource",
"settings": {"property1": "string",
"property2": "string"
}
}

Get object permissions DCObjectsController.getObjectPermissions

query Parameters

subjectId required	string
objectId required	string
objectType required	string (SMObjectType) Enum: "datasource" "project"

Responses

Response Schema: application/json

objectId	string
permissions	Array of strings

Response samples

200

Content type

application/json

{"objectId": "string",
"permissions": ["string"
]
}

Delete all object permissions DCObjectsController.deleteAllObjectPermissions

query Parameters

objectId required	string
objectType required	string (SMObjectType) Enum: "datasource" "project"

Responses

Get object permission grants DCObjectsController.getObjectPermissionGrants

query Parameters

objectId required	string
objectType required	string (SMObjectType) Enum: "datasource" "project"

Responses

Response Schema: application/json

Array

subjectId	string
subjectType	string (SMSubjectType) Enum: "user" "team"
	object (SMObjectPermissions)

Response samples

200

Content type

application/json

[{"subjectId": "string",
"subjectType": "user",
"objectPermissions": {"objectId": "string",
"permissions": ["string"
]
}
}
]

Verify data source connect access DCObjectsController.verifyDataSourceConnectAccess

query Parameters

projectId required	string
objectId required	string
objectType required	string (SMObjectType) Enum: "datasource" "project"

Responses

Response Schema: application/json

boolean

Response samples

200

Content type

application/json

true

Secrets

Secret storage and management endpoints

Get secret DCSecretController.getSecret

query Parameters

secretId

required

string

Responses

Response Schema: application/json

id	string
name	string
description	string

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"description": "string"
}

Flush secret changes DCSecretController.flushChanges

Responses

List secrets DCSecretController.listSecrets

query Parameters

path

required

string

Responses

Response Schema: application/json

Array

id	string
name	string
description	string

Response samples

200

Content type

application/json

[{"id": "string",
"name": "string",
"description": "string"
}
]

List all shared secrets DCSecretController.listAllSharedSecrets

Request Body schema: application/json

object (DBSSecretObject)

Responses

Response Schema: application/json

Array

subjectId	string
id	string
displayName	string
value	string
uniqueId	string

Request samples

Payload

Content type

application/json

{ }

Response samples

200

Content type

application/json

[{"subjectId": "string",
"id": "string",
"displayName": "string",
"value": "string",
"uniqueId": "string"
}
]

Delete object secrets DCSecretController.deleteObjectSecrets

Request Body schema: application/json

object (DBSSecretObject)

Responses

Request samples

Payload

Content type

application/json

{ }

Discover current user secrets DCSecretController.discoverCurrentUserSecrets

Request Body schema: application/json

object (DBSSecretObject)

Responses

Response Schema: application/json

Array

subjectId	string
id	string
displayName	string
value	string
uniqueId	string

Request samples

Payload

Content type

application/json

{ }

Response samples

200

Content type

application/json

[{"subjectId": "string",
"id": "string",
"displayName": "string",
"value": "string",
"uniqueId": "string"
}
]

Delete project secrets DCSecretController.deleteProjectSecrets

query Parameters

projectId

required

string

Responses

Delete subject secrets DCSecretController.deleteSubjectSecrets

query Parameters

subjectId

required

string

Responses

Set subject secret value DCSecretController.setSubjectSecretValue

path Parameters

subjectId

required

string

query Parameters

projectId	string
secretObjectType	string
secretObjectId	string

Request Body schema: application/json

subjectId	string
id	string
displayName	string
value	string

Responses

Request samples

Payload

Content type

application/json

{"subjectId": "string",
"id": "string",
"displayName": "string",
"value": "string"
}

Get private secret value DCSecretController.getPrivateSecretValue

query Parameters

secretId

required

string

Responses

Response Schema: text/plain

string

Set private secret value by object DCSecretController.setPrivateSecretValue

query Parameters

projectId	string
secretObjectType	string
secretObjectId	string

Request Body schema: application/json

subjectId	string
id	string
displayName	string
value	string

Responses

Request samples

Payload

Content type

application/json

{"subjectId": "string",
"id": "string",
"displayName": "string",
"value": "string"
}

Set private secret value DCSecretController.setPrivateSecretValue2

query Parameters

secretId required	string
arg1 required	string

Responses

Delete secret DCSecretController.deleteSecret

query Parameters

secretId

required

string

Responses

Clear all secrets DCSecretController.clearAllSecrets

query Parameters

keyPrefix

required

string

Responses

Sessions

Session management endpoints

Update session DCSessionController.updateSession

query Parameters

sessionId

required

string

Request Body schema: application/json

userId	string
	object

Responses

Request samples

Payload

Content type

application/json

{"userId": "string",
"parameters": {"property1": null,
"property2": null
}
}

Check if session is persisted DCSessionController.isSessionPersisted

query Parameters

sessionId

required

string

Responses

Response Schema: application/json

boolean

Response samples

200

Content type

application/json

true

SingletonTasks

Singleton task management endpoints

Create singleton task DCSingletonTaskController.createSingletonTask

query Parameters

type required	string (SMSingletonTaskType) Value: "DEPLOYMENT_DOMAIN_REFRESH"
timeout required	integer <int32>

Responses

Response Schema: application/json

boolean

Response samples

200

Content type

application/json

true

End singleton task DCSingletonTaskController.endTask

query Parameters

type

required

string (SMSingletonTaskType)

Value: "DEPLOYMENT_DOMAIN_REFRESH"

Responses

Response Schema: application/json

boolean

Response samples

200

Content type

application/json

true

Subjects

Subjects management endpoints

Get subject permissions DCSubjectsController.getSubjectPermissions

query Parameters

subjectId

required

string

Responses

Response Schema: application/json

Array

string

Response samples

200

Content type

application/json

["string"
]

Users

User endpoints

Get current user DCUsersController.getCurrentUser

Responses

Response Schema: application/json

subjectId	string
secretStorage	boolean
	object
userTeams	Array of strings
enabled	boolean
authRole	string
disableDate	string <date-time>
disabledBy	string
disableReason	string
lastLoginTime	string <date-time>
name	string
userId	string

Response samples

200

Content type

application/json

{"subjectId": "string",
"secretStorage": true,
"metaParameters": {"property1": "string",
"property2": "string"
},
"userTeams": ["string"
],
"enabled": true,
"authRole": "string",
"disableDate": "2019-08-24T14:15:22Z",
"disabledBy": "string",
"disableReason": "string",
"lastLoginTime": "2019-08-24T14:15:22Z",
"name": "string",
"userId": "string"
}

Check access to users DCUsersController.hasAccessToUsers

query Parameters

teamRole

required

string

Request Body schema: application/json

Array

string

Responses

Response Schema: application/json

boolean

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200

Content type

application/json

true

Get user credentials DCUsersController.getUserCredentials

query Parameters

authProviderId

required

string

Responses

Response Schema: application/json

property name*

additional property

any

Response samples

200

Content type

application/json

{"property1": null,
"property2": null
}

Set user credentials DCUsersController.setUserCredentials

Request Body schema: application/json

authProviderId	string
	object

Responses

Request samples

Payload

Content type

application/json

{"authProviderId": "string",
"credentials": {"property1": null,
"property2": null
}
}

Get user parameters DCUsersController.getUserParameters

Responses

Response Schema: application/json

property name*

additional property

any

Response samples

200

Content type

application/json

{"property1": null,
"property2": null
}

Set user parameters DCUsersController.setUserParameters

Request Body schema: application/json

property name*

additional property

any

Responses

Request samples

Payload

Content type

application/json

{"property1": null,
"property2": null
}

Set user parameter DCUsersController.setUserParameter

Request Body schema: application/json

name	string
value	any

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"value": null
}

Get user linked providers DCUsersController.getUserLinkedProviders

Responses

Response Schema: application/json

Array

string

Response samples

200

Content type

application/json

["string"
]

Get user teams DCUsersController.getUserTeams

Responses

Response Schema: application/json

Array

subjectId	string
secretStorage	boolean
	object
teamName	string
description	string
permissions	Array of strings unique
teamId	string
name	string

Response samples

200

Content type

application/json

[{"subjectId": "string",
"secretStorage": true,
"metaParameters": {"property1": "string",
"property2": "string"
},
"teamName": "string",
"description": "string",
"permissions": ["string"
],
"teamId": "string",
"name": "string"
}
]

Get team members DCUsersController.getTeamMembers

query Parameters

teamId

required

string

Responses

Response Schema: application/json

Array

string

Response samples

200

Content type

application/json

["string"
]

Get API tokens DCUsersController.getAPITokens

Responses

Response Schema: application/json

Array

tokenName	string
token	string
createTime	string <date>
expireTime	string <date>

Response samples

200

Content type

application/json

[{"tokenName": "string",
"token": "string",
"createTime": "2019-08-24",
"expireTime": "2019-08-24"
}
]

Create API token DCUsersController.createAPIToken

Request Body schema: application/json

tokenName	string
period	integer <int32>

Responses

Response Schema: application/json

tokenName	string
token	string
createTime	string <date>
expireTime	string <date>

Request samples

Payload

Content type

application/json

{"tokenName": "string",
"period": 0
}

Response samples

200

Content type

application/json

{"tokenName": "string",
"token": "string",
"createTime": "2019-08-24",
"expireTime": "2019-08-24"
}

Delete API token DCUsersController.deleteAPIToken

query Parameters

tokenName

required

string

Responses

Get user permissions DCUsersController.getUserPermissions

query Parameters

userId

required

string

Responses

Response Schema: application/json

Array

string

Response samples

200

Content type

application/json

["string"
]

DCDeployInfoController

DCDeployInfoController.getDimensionPriceInfo DCDeployInfoController.getDimensionPriceInfo

Responses

Response Schema: application/json

Array

dimensionId	string
price	number <double>
currencyCode	string

Response samples

200

Content type

application/json

[{"dimensionId": "string",
"price": 0.1,
"currencyCode": "string"
}
]

DCDeployInfoController.getIntegratedDeployment DCDeployInfoController.getIntegratedDeployment

Responses

Response Schema: application/json

descriptorId	string
autoLicensed	boolean
	object (MarketplaceProductDescriptor)
deploymentType	string
deploymentIdentifier	string
regionIdentifier	string
hostIdentifier	string
accountIdentifier	string
productDisplayName	string
appInfoDetails	string
techSupportLinkParametersTemplate	string
userIdentityLabel	string
userIdentityValue	string

Response samples

200

Content type

application/json

{"descriptorId": "string",
"autoLicensed": true,
"marketplaceProduct": {"pluginId": "string",
"id": "string",
"displayName": "string",
"description": "string",
"icon": {"location": "string"
},
"productType": "cloud",
"productDeploymentType": "instance",
"deploymentHostOS": "string",
"deploymentHostArch": "string",
"additionalData": "string",
"downloadUrl": {"absolute": true,
"scheme": "string",
"opaque": true,
"rawAuthority": "string",
"rawFragment": "string",
"rawQuery": "string",
"rawPath": "string",
"host": "string",
"port": 0,
"authority": "string",
"query": "string",
"path": "string",
"userInfo": "string",
"rawSchemeSpecificPart": "string",
"schemeSpecificPart": "string",
"rawUserInfo": "string",
"fragment": "string"
},
"localDataPath": "string",
"productIdentifier": "string",
"application": {"pluginId": "string",
"id": "string",
"label": "string",
"userIdentityLabel": "string",
"userIdentityDescription": "string",
"instance": { },
"marketplaceProducts": [{ }
],
"contributorBundle": {"location": "string",
"state": 0,
"lastModified": 0,
"version": {"major": 0,
"minor": 0,
"micro": 0,
"qualifier": "string"
},
"headers": {"empty": true
},
"symbolicName": "string",
"bundleId": 0,
"registeredServices": [{"properties": {"empty": true
},
"bundle": { },
"propertyKeys": ["string"
],
"usingBundles": [{ }
]
}
],
"servicesInUse": [{"properties": {"empty": true
},
"bundle": { },
"propertyKeys": ["string"
],
"usingBundles": [{ }
]
}
],
"bundleContext": {"bundle": { },
"bundles": [{ }
]
}
}
},
"contributorBundle": {"location": "string",
"state": 0,
"lastModified": 0,
"version": {"major": 0,
"minor": 0,
"micro": 0,
"qualifier": "string"
},
"headers": {"empty": true
},
"symbolicName": "string",
"bundleId": 0,
"registeredServices": [{"properties": {"empty": true
},
"bundle": { },
"propertyKeys": ["string"
],
"usingBundles": [{ }
]
}
],
"servicesInUse": [{"properties": {"empty": true
},
"bundle": { },
"propertyKeys": ["string"
],
"usingBundles": [{ }
]
}
],
"bundleContext": {"bundle": { },
"bundles": [{ }
]
}
}
},
"deploymentType": "string",
"deploymentIdentifier": "string",
"regionIdentifier": "string",
"hostIdentifier": "string",
"accountIdentifier": "string",
"productDisplayName": "string",
"appInfoDetails": "string",
"techSupportLinkParametersTemplate": "string",
"userIdentityLabel": "string",
"userIdentityValue": "string"
}

QM

Query manager endpoints

Get conversation history metadata by conversationId QMServerController.getConversationHistoryMeta

query Parameters

conversationId	any
sessionId required	string
engineId required	string
from required	string <date-time>
to required	string <date-time>

Responses

Response Schema: application/json

Array

type	string
engineId	string
modelId	string
systemPromptLength	integer <int32>
	object (Duration)
totalInputTokens	integer <int32>
cachedTokens	integer <int32>
totalOutputTokens	integer <int32>
reasoningTokens	integer <int32>

Response samples

200

Content type

application/json

[{"type": "string",
"engineId": "string",
"modelId": "string",
"systemPromptLength": 0,
"timeSpent": {"seconds": 0,
"zero": true,
"nano": 0,
"negative": true,
"positive": true,
"units": [{"durationEstimated": true,
"duration": { },
"timeBased": true,
"dateBased": true
}
]
},
"totalInputTokens": 0,
"cachedTokens": 0,
"totalOutputTokens": 0,
"reasoningTokens": 0
}
]

Get API call log QMServerController.getApiCallLog

Request Body schema: application/json

from	string <date-time>
to	string <date-time>
offset	integer <int64>
limit	integer <int32>
	Array of objects (QMApiCallLogSortItem)
ipAddress	Array of strings unique
userName	Array of strings unique
endpoint	Array of strings unique
httpMethod	Array of strings unique
errorOnly	boolean
apiProtocol	Array of strings unique

Responses

Response Schema: application/json

Array

id	integer <int64>
userName	string
qmSessionId	string
apiProtocol	string
endpoint	string
httpMethod	string
errorMessage	string
serviceType	string
requestTime	string <date-time>
	object
ipAddress	string

Request samples

Payload

Content type

application/json

{"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"offset": 0,
"limit": 0,
"sortItems": [{"sortBy": "REQUEST_TIME",
"sortDesc": true
}
],
"ipAddress": ["string"
],
"userName": ["string"
],
"endpoint": ["string"
],
"httpMethod": ["string"
],
"errorOnly": true,
"apiProtocol": ["string"
]
}

Response samples

200

Content type

application/json

[{"id": 0,
"userName": "string",
"qmSessionId": "string",
"apiProtocol": "string",
"endpoint": "string",
"httpMethod": "string",
"errorMessage": "string",
"serviceType": "string",
"requestTime": "2019-08-24T14:15:22Z",
"parameters": {"property1": null,
"property2": null
},
"ipAddress": "string"
}
]

Close QM session by appSessionId QMServerController.closeSession

query Parameters

appSessionId

required

string

Responses

Delete AI conversation QMServerController.deleteConversation

query Parameters

conversationId

required

string

Responses

Extend conversation context QMServerController.extendContext

query Parameters

conversationId

required

string

Request Body schema: application/json

Array

name	string
type	string (QMAIContextObjectType) Enum: "DATASOURCE" "DATABASE" "SCHEMA" "TABLE"

Responses

Request samples

Payload

Content type

application/json

[{"name": "string",
"type": "DATASOURCE"
}
]

Delete chat message QMServerController.deleteMessage

query Parameters

conversationId required	string
messageId required	integer <int32>

Responses

Append messages to conversation QMServerController.appendMessages

query Parameters

conversationId

required

string

Request Body schema: application/json

Array

id	integer <int32>
content	string
displayMessage	string
role	string (QMAIChatRole) Enum: "ASSISTANT" "CONFIRMATION" "USER" "FUNCTION" "WARNING" "ERROR"
functionCall	string
functionResult	string
timestamp	string <date-time>
deleted	boolean
	Array of objects (QMAIMessageMeta)

Responses

Request samples

Payload

Content type

application/json

[{"id": 0,
"content": "string",
"displayMessage": "string",
"role": "ASSISTANT",
"functionCall": "string",
"functionResult": "string",
"timestamp": "2019-08-24T14:15:22Z",
"deleted": true,
"meta": [{"type": "string",
"engineId": "string",
"modelId": "string",
"systemPromptLength": 0,
"timeSpent": {"seconds": 0
},
"totalInputTokens": 0,
"cachedTokens": 0,
"totalOutputTokens": 0,
"reasoningTokens": 0
}
]
}
]

Rename AI conversation QMServerController.renameConversation

query Parameters

conversationId required	string
arg1 required	string

Responses

Find AI conversations for session QMServerController.findConversations

query Parameters

sessionId

required

string

Responses

Response Schema: application/json

Array

id	string
caption	string
promptGeneratorId	string
	object (QMAIDataSource)
	Array of objects (QMAIChatMessage)
	object (QMAIContext)
nextMessageId	integer <int32>
deleted	boolean

Response samples

200

Content type

application/json

[{"id": "string",
"caption": "string",
"promptGeneratorId": "string",
"dataSource": {"projectId": "string",
"dataSourceId": "string"
},
"messages": [{"id": 0,
"content": "string",
"displayMessage": "string",
"role": "ASSISTANT",
"functionCall": "string",
"functionResult": "string",
"timestamp": "2019-08-24T14:15:22Z",
"deleted": true,
"meta": [{"type": "string",
"engineId": "string",
"modelId": "string",
"systemPromptLength": 0,
"timeSpent": {"seconds": 0,
"zero": true,
"nano": 0,
"negative": true,
"positive": true,
"units": [{"durationEstimated": true,
"duration": { },
"timeBased": true,
"dateBased": true
}
]
},
"totalInputTokens": 0,
"cachedTokens": 0,
"totalOutputTokens": 0,
"reasoningTokens": 0
}
]
}
],
"context": {"contextJson": "string",
"objects": [{"name": "string",
"type": "DATASOURCE"
}
]
},
"nextMessageId": 0,
"deleted": true
}
]

Save AI conversation QMServerController.saveConversation

query Parameters

sessionId

required

string

Request Body schema: application/json

id	string
caption	string
promptGeneratorId	string
	object (QMAIDataSource)
	Array of objects (QMAIChatMessage)
	object (QMAIContext)
nextMessageId	integer <int32>
deleted	boolean

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"caption": "string",
"promptGeneratorId": "string",
"dataSource": {"projectId": "string",
"dataSourceId": "string"
},
"messages": [{"id": 0,
"content": "string",
"displayMessage": "string",
"role": "ASSISTANT",
"functionCall": "string",
"functionResult": "string",
"timestamp": "2019-08-24T14:15:22Z",
"deleted": true,
"meta": [{"type": "string",
"engineId": "string",
"modelId": "string",
"systemPromptLength": 0,
"timeSpent": {"seconds": 0
},
"totalInputTokens": 0,
"cachedTokens": 0,
"totalOutputTokens": 0,
"reasoningTokens": 0
}
]
}
],
"context": {"contextJson": "string",
"objects": [{"name": "string",
"type": "DATASOURCE"
}
]
},
"nextMessageId": 0,
"deleted": true
}

Get internal database information for QM service QMServerController.getInternalDatabaseInformation

Responses

Response Schema: application/json

url	string
driverName	string
productName	string
productVersion	string

Response samples

200

Content type

application/json

{"url": "string",
"driverName": "string",
"productName": "string",
"productVersion": "string"
}

Get admin query history cursor QMServerController.getAdminQueryHistoryCursor

Request Body schema: application/json

filter	object (QMEventFilter)
sessionId	string

Responses

Response Schema: application/json

totalSize

integer <int64>

Request samples

Payload

Content type

application/json

{"filter": { },
"sessionId": "string"
}

Response samples

200

Content type

application/json

{"totalSize": 0
}

Get query history cursor QMServerController.getQueryHistoryCursor

Request Body schema: application/json

	object (QMEventCriteria)
filter	object (QMEventFilter)
sessionId	string

Responses

Response Schema: application/json

totalSize

integer <int64>

Request samples

Payload

Content type

application/json

{"criteria": {"containerId": "string",
"sessionId": 0,
"objectTypes": ["session"
],
"queryTypes": ["USER"
],
"skipEmptyQueries": true,
"searchString": "string",
"lastEventId": 0,
"driverIds": ["string"
],
"eventStatuses": ["FAILED"
],
"projectIds": ["string"
],
"dataSourceIds": ["string"
],
"schemas": ["string"
],
"catalogs": ["string"
],
"sortField": "DATE",
"desc": true,
"fetchingSize": 0,
"dateRange": {"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z"
}
},
"filter": { },
"sessionId": "string"
}

Response samples

200

Content type

application/json

{"totalSize": 0
}

Get supervisor query history cursor QMServerController.getSupervisorQueryHistoryCursor

Request Body schema: application/json

filter	object (QMEventFilter)
sessionId	string

Responses

Response Schema: application/json

totalSize

integer <int64>

Request samples

Payload

Content type

application/json

{"filter": { },
"sessionId": "string"
}

Response samples

200

Content type

application/json

{"totalSize": 0
}

Open QM session QMServerController.openSession

Request Body schema: application/json

userName	string
userDomain	string
userIp	string

Responses

Response Schema: text/plain

string

Request samples

Payload

Content type

application/json

{"userName": "string",
"userDomain": "string",
"userIp": "string"
}

Ping QM service QMServerController.ping

Responses

Response Schema: text/plain

string

Get query filter history QMServerController.getQueryFilterHistory

query Parameters

sessionId required	string
query required	string

Responses

Response Schema: application/json

Array

Response samples

200

Content type

application/json

[{ }
]

Mark query filter as used QMServerController.useQueryFilter

query Parameters

sessionId

required

string

Request Body schema: application/json

title

string

Responses

Request samples

Payload

Content type

application/json

{"title": "string"
}

Save query filter value QMServerController.saveQueryFilterValue

query Parameters

sessionId

required

string

Request Body schema: application/json

title

string

Responses

Request samples

Payload

Content type

application/json

{"title": "string"
}

Delete query filter value QMServerController.deleteQueryFilterValue

query Parameters

sessionId

required

string

Request Body schema: application/json

title

string

Responses

Request samples

Payload

Content type

application/json

{"title": "string"
}

Read smart completion history QMServerController.readSmartCompletionHistory

query Parameters

sessionId required	string
dataSourceId required	string
logicalDataSourceName required	string
currentCatalog required	string
currentSchema required	string
maxCount required	integer <int32>

Responses

Response Schema: application/json

Array

id	string
naturalText	string
completionText	string
time	string <date-time>

Response samples

200

Content type

application/json

[{"id": "string",
"naturalText": "string",
"completionText": "string",
"time": "2019-08-24T14:15:22Z"
}
]

Dispatch API call events QMServerController.dispatchApiCallEvent

Request Body schema: application/json

Array

id	integer <int64>
userName	string
qmSessionId	string
apiProtocol	string
endpoint	string
httpMethod	string
errorMessage	string
serviceType	string
requestTime	string <date-time>
	object
ipAddress	string

Responses

Request samples

Payload

Content type

application/json

[{"id": 0,
"userName": "string",
"qmSessionId": "string",
"apiProtocol": "string",
"endpoint": "string",
"httpMethod": "string",
"errorMessage": "string",
"serviceType": "string",
"requestTime": "2019-08-24T14:15:22Z",
"parameters": {"property1": null,
"property2": null
},
"ipAddress": "string"
}
]

Save data source connect error info QMServerController.saveDataSourceConnectError

query Parameters

sessionId

required

string

Request Body schema: application/json

objectId	integer <int64>
openTime	integer <int64>
closeTime	integer <int64>
projectId	string
containerId	string
containerName	string
driverId	string
connectionUrl	string
errorType	string
errorMessage	string

Responses

Request samples

Payload

Content type

application/json

{"objectId": 0,
"openTime": 0,
"closeTime": 0,
"projectId": "string",
"containerId": "string",
"containerName": "string",
"driverId": "string",
"connectionUrl": "string",
"errorType": "string",
"errorMessage": "string"
}

Save QM events QMServerController.saveEvents

Request Body schema: application/json

Array

	object (QMMObject)
action	string (QMEventAction) Enum: "BEGIN" "END" "UPDATE"
timestamp	integer <int64>
sessionId	string

Responses

Request samples

Payload

Content type

application/json

[{"object": {"objectId": 0,
"openTime": 0,
"closeTime": 0
},
"action": "BEGIN",
"timestamp": 0,
"sessionId": "string"
}
]

Save smart completion history QMServerController.saveSmartCompletionHistory

query Parameters

sessionId required	string
dataSourceId required	string
logicalDataSourceName required	string
currentCatalog required	string
currentSchema required	string
natualText required	string
arg6 required	string

Responses

RAG

RAG embedding storage endpoints

Delete RAG embeddings by data source ids RAGStorageController.deleteByDatasourceIds

Request Body schema: application/json

Array

projectId	string
datasourceId	string

Responses

Request samples

Payload

Content type

application/json

[{"projectId": "string",
"datasourceId": "string"
}
]

Find RAG embeddings by object keys RAGStorageController.findByKeys

Request Body schema: application/json

Array

	object (RAGDataSourceKey)
objectName	string

Responses

Response Schema: application/json

Array

	object (RAGObjectKey)
checksum	integer <int64>
modelName	string
embedding	Array of numbers <float> [ items <float > ]

Request samples

Payload

Content type

application/json

[{"datasourceKey": {"projectId": "string",
"datasourceId": "string"
},
"objectName": "string"
}
]

Response samples

200

Content type

application/json

[{"key": {"datasourceKey": {"projectId": "string",
"datasourceId": "string"
},
"objectName": "string"
},
"checksum": 0,
"modelName": "string",
"embedding": [0.1
]
}
]

Find relevant RAG records by prefix filter RAGStorageController.findRelevantRecords

Request Body schema: application/json

	object (RAGObjectKey)
query	Array of numbers <float> [ items <float > ]
topK	integer <int32>

Responses

Response Schema: application/json

Array

	object (RAGObjectKey)
checksum	integer <int64>
modelName	string
embedding	Array of numbers <float> [ items <float > ]

Request samples

Payload

Content type

application/json

{"objectKey": {"datasourceKey": {"projectId": "string",
"datasourceId": "string"
},
"objectName": "string"
},
"query": [0.1
],
"topK": 0
}

Response samples

200

Content type

application/json

[{"key": {"datasourceKey": {"projectId": "string",
"datasourceId": "string"
},
"objectName": "string"
},
"checksum": 0,
"modelName": "string",
"embedding": [0.1
]
}
]

Find relevant RAG records by filter RAGStorageController.findRelevantRecords2

Request Body schema: application/json

	Array of objects (RAGObjectKey)
query	Array of numbers <float> [ items <float > ]
topK	integer <int32>

Responses

Response Schema: application/json

Array

	object (RAGObjectKey)
checksum	integer <int64>
modelName	string
embedding	Array of numbers <float> [ items <float > ]

Request samples

Payload

Content type

application/json

{"objectKeys": [{"datasourceKey": {"projectId": "string",
"datasourceId": "string"
},
"objectName": "string"
}
],
"query": [0.1
],
"topK": 0
}

Response samples

200

Content type

application/json

[{"key": {"datasourceKey": {"projectId": "string",
"datasourceId": "string"
},
"objectName": "string"
},
"checksum": 0,
"modelName": "string",
"embedding": [0.1
]
}
]

Find stale RAG data sources older than provided timestamp RAGStorageController.findStaleDataSources

query Parameters

olderThan

required

string <date-time>

Responses

Response Schema: application/json

Array

projectId	string
datasourceId	string

Response samples

200

Content type

application/json

[{"projectId": "string",
"datasourceId": "string"
}
]

Save RAG embeddings RAGStorageController.save

Request Body schema: application/json

Array

	object (RAGObjectKey)
checksum	integer <int64>
modelName	string
embedding	Array of numbers <float> [ items <float > ]

Responses

Request samples

Payload

Content type

application/json

[{"key": {"datasourceKey": {"projectId": "string",
"datasourceId": "string"
},
"objectName": "string"
},
"checksum": 0,
"modelName": "string",
"embedding": [0.1
]
}
]

RMAdminProjects

Admin endpoints for RM projects

Backup project RMAdminProjectsController.backupProject

query Parameters

projectId

required

string

Responses

Response Schema: text/plain

string

Restore project backup RMAdminProjectsController.restoreBackup

query Parameters

projectId required	string
backupId required	string

Responses

Read project configuration RMAdminProjectsController.readProjectConfiguration

query Parameters

projectId required	string
configurationPath required	string

Responses

Response Schema: text/plain

string

Save project configuration RMAdminProjectsController.saveProjectConfiguration

query Parameters

projectId required	string
configurationPath required	string
arg2 required	string

Responses

RMConfig

Resource manager configuration endpoints

Load configuration file RMConfigurationController.loadConfigurationFile

query Parameters

filePath

required

string

Responses

Response Schema: text/plain

string

Save configuration file RMConfigurationController.saveConfigurationFile

query Parameters

filePath required	string
arg1 required	string

Responses

Load secure configuration file RMConfigurationController.loadSecureConfigurationFile

query Parameters

secureFilePath

required

string

Responses

Response Schema: text/plain

string

Save secure configuration file RMConfigurationController.saveSecureConfigurationFile

query Parameters

secureFilePath required	string
arg1 required	string

Responses

RMFiles

Resource manager file endpoints

Load file data (legacy) RMFileController.loadFileDataLegacy

path Parameters

fileType

required

string

query Parameters

filePath

required

string

Responses

Response Schema: text/plain

string <binary>

Save file data (legacy) RMFileController.saveFileDataLegacy

path Parameters

fileType

required

string

query Parameters

filePath

required

string

Request Body schema: text/plain

string <binary>

Responses

Delete file RMFileController.deleteFile

query Parameters

fileType required	string
filePath required	string
recursive required	boolean

Responses

Load file data (encrypted) RMFileController.loadFileData

query Parameters

fileType required	string
filePath required	string

Responses

Response Schema: text/plain

string <binary>

Save file data (encrypted) RMFileController.saveFileData

query Parameters

fileType required	string
filePath required	string
arg2 required	string <binary>

Responses

List files RMFileController.listFiles

query Parameters

fileType required	string
filePath required	string

Responses

Response Schema: application/json

Array

string

Response samples

200

Content type

application/json

["string"
]

RMProjects

Resource manager project endpoints

List accessible projects RMProjectsController.listAccessibleProjects

Responses

Response Schema: application/json

Array

	Array of objects (RMResource)
name	string
id	string
description	string
type	string (RMProjectType) Enum: "GLOBAL" "SHARED" "USER"
createTime	integer <int64>
creator	string
projectPermissions	Array of strings
	Array of objects (RMResourceType)
global	boolean
displayName	string
shared	boolean
folder	boolean

Response samples

200

Content type

application/json

[{"children": [{"children": [{ }
],
"name": "string",
"folder": true,
"length": 0,
"lastModified": 0,
"changes": [{"changeId": "string",
"changeTime": "2019-08-24T14:15:22Z",
"changeUser": "2019-08-24T14:15:22Z"
}
],
"properties": {"property1": null,
"property2": null
}
}
],
"name": "string",
"id": "string",
"description": "string",
"type": "GLOBAL",
"createTime": 0,
"creator": "string",
"projectPermissions": ["string"
],
"resourceTypes": [{"id": "string",
"displayName": "string",
"rootFolder": "string",
"icon": "string",
"folderIcon": "string",
"fileExtensions": ["string"
]
}
],
"global": true,
"displayName": "string",
"shared": true,
"folder": true
}
]

Create project RMProjectsController.createProject

query Parameters

name required	string
description required	string

Responses

Response Schema: application/json

	Array of objects (RMResource)
name	string
id	string
description	string
type	string (RMProjectType) Enum: "GLOBAL" "SHARED" "USER"
createTime	integer <int64>
creator	string
projectPermissions	Array of strings
	Array of objects (RMResourceType)
global	boolean
displayName	string
shared	boolean
folder	boolean

Response samples

200

Content type

application/json

{"children": [{"children": [{ }
],
"name": "string",
"folder": true,
"length": 0,
"lastModified": 0,
"changes": [{"changeId": "string",
"changeTime": "2019-08-24T14:15:22Z",
"changeUser": "2019-08-24T14:15:22Z"
}
],
"properties": {"property1": null,
"property2": null
}
}
],
"name": "string",
"id": "string",
"description": "string",
"type": "GLOBAL",
"createTime": 0,
"creator": "string",
"projectPermissions": ["string"
],
"resourceTypes": [{"id": "string",
"displayName": "string",
"rootFolder": "string",
"icon": "string",
"folderIcon": "string",
"fileExtensions": ["string"
]
}
],
"global": true,
"displayName": "string",
"shared": true,
"folder": true
}

Ping RM service RMProjectsController.ping

Responses

Response Schema: text/plain

string

List all shared projects RMProjectsController.listAllSharedProjects

Responses

Response Schema: application/json

Array

	Array of objects (RMResource)
name	string
id	string
description	string
type	string (RMProjectType) Enum: "GLOBAL" "SHARED" "USER"
createTime	integer <int64>
creator	string
projectPermissions	Array of strings
	Array of objects (RMResourceType)
global	boolean
displayName	string
shared	boolean
folder	boolean

Response samples

200

Content type

application/json

[{"children": [{"children": [{ }
],
"name": "string",
"folder": true,
"length": 0,
"lastModified": 0,
"changes": [{"changeId": "string",
"changeTime": "2019-08-24T14:15:22Z",
"changeUser": "2019-08-24T14:15:22Z"
}
],
"properties": {"property1": null,
"property2": null
}
}
],
"name": "string",
"id": "string",
"description": "string",
"type": "GLOBAL",
"createTime": 0,
"creator": "string",
"projectPermissions": ["string"
],
"resourceTypes": [{"id": "string",
"displayName": "string",
"rootFolder": "string",
"icon": "string",
"folderIcon": "string",
"fileExtensions": ["string"
]
}
],
"global": true,
"displayName": "string",
"shared": true,
"folder": true
}
]

Get project RMProjectsController.getProject

query Parameters

projectId required	string
readResources required	boolean
readProperties required	boolean

Responses

Response Schema: application/json

	Array of objects (RMResource)
name	string
id	string
description	string
type	string (RMProjectType) Enum: "GLOBAL" "SHARED" "USER"
createTime	integer <int64>
creator	string
projectPermissions	Array of strings
	Array of objects (RMResourceType)
global	boolean
displayName	string
shared	boolean
folder	boolean

Response samples

200

Content type

application/json

{"children": [{"children": [{ }
],
"name": "string",
"folder": true,
"length": 0,
"lastModified": 0,
"changes": [{"changeId": "string",
"changeTime": "2019-08-24T14:15:22Z",
"changeUser": "2019-08-24T14:15:22Z"
}
],
"properties": {"property1": null,
"property2": null
}
}
],
"name": "string",
"id": "string",
"description": "string",
"type": "GLOBAL",
"createTime": 0,
"creator": "string",
"projectPermissions": ["string"
],
"resourceTypes": [{"id": "string",
"displayName": "string",
"rootFolder": "string",
"icon": "string",
"folderIcon": "string",
"fileExtensions": ["string"
]
}
],
"global": true,
"displayName": "string",
"shared": true,
"folder": true
}

Update project RMProjectsController.updateProject

query Parameters

projectId

required

string

Request Body schema: application/json

name	string
description	string

Responses

Response Schema: application/json

	Array of objects (RMResource)
name	string
id	string
description	string
type	string (RMProjectType) Enum: "GLOBAL" "SHARED" "USER"
createTime	integer <int64>
creator	string
projectPermissions	Array of strings
	Array of objects (RMResourceType)
global	boolean
displayName	string
shared	boolean
folder	boolean

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string"
}

Response samples

200

Content type

application/json

{"children": [{"children": [{ }
],
"name": "string",
"folder": true,
"length": 0,
"lastModified": 0,
"changes": [{"changeId": "string",
"changeTime": "2019-08-24T14:15:22Z",
"changeUser": "2019-08-24T14:15:22Z"
}
],
"properties": {"property1": null,
"property2": null
}
}
],
"name": "string",
"id": "string",
"description": "string",
"type": "GLOBAL",
"createTime": 0,
"creator": "string",
"projectPermissions": ["string"
],
"resourceTypes": [{"id": "string",
"displayName": "string",
"rootFolder": "string",
"icon": "string",
"folderIcon": "string",
"fileExtensions": ["string"
]
}
],
"global": true,
"displayName": "string",
"shared": true,
"folder": true
}

Delete project RMProjectsController.deleteProject

query Parameters

projectId

required

string

Responses

Get project datasources RMProjectsController.getProjectsDataSources

query Parameters

projectId required	string
dataSourceIds required	Array of strings

Responses

Response Schema: text/plain

string

Update project datasources RMProjectsController.updateProjectDataSources

query Parameters

projectId required	string
arg1 required	string
dataSourceIds	Array of strings

Responses

Response Schema: application/json

boolean

Response samples

200

Content type

application/json

true

Create project datasources RMProjectsController.createProjectDataSources

query Parameters

projectId required	string
arg1 required	string
dataSourceIds	Array of strings

Responses

Delete project datasources RMProjectsController.deleteProjectDataSources

query Parameters

projectId required	string
dataSourceIds required	Array of strings

Responses

Create project datasource folder RMProjectsController.createProjectDataSourceFolder

query Parameters

projectId required	string
folderPath required	string

Responses

Move project datasource folder RMProjectsController.moveProjectDataSourceFolder

query Parameters

projectId required	string
oldPath required	string
newPath required	string

Responses

Delete project datasource folders RMProjectsController.deleteProjectDataSourceFolders

query Parameters

projectId required	string
folderPaths required	Array of strings
dropContents required	boolean

Responses

Get project property RMProjectsController.getProjectProperty

query Parameters

projectId required	string
property required	string

Responses

Response Schema: application/json

any

Response samples

200

Content type

application/json

null

Set project property RMProjectsController.setProjectProperty

query Parameters

projectId required	string
property required	string

Request Body schema: application/json

any

Responses

Request samples

Payload

Content type

application/json

null

Get resource contents RMProjectsController.getResourceContents

query Parameters

projectId required	string
resourcePath required	string

Responses

Response Schema: text/plain

string <binary>

Create resource RMProjectsController.createResource

query Parameters

projectId required	string
resourcePath required	string
isFolder required	boolean

Responses

Response Schema: text/plain

string

Set resource contents RMProjectsController.setResourceContents

query Parameters

projectId required	string
resourcePath required	string
arg2 required	string <binary>
forceOverwrite required	boolean

Responses

Response Schema: text/plain

string

Delete resource RMProjectsController.deleteResource

query Parameters

projectId required	string
resourcePath required	string
recursive required	boolean

Responses

Set resource properties RMProjectsController.setResourceProperties

query Parameters

projectId required	string
resourcePath required	string

Request Body schema: application/json

property name*

additional property

any

Responses

Response Schema: text/plain

string

Request samples

Payload

Content type

application/json

{"property1": null,
"property2": null
}

List resources RMProjectsController.listResources

query Parameters

projectId required	string
folder required	string
nameMask required	string
readProperties required	boolean
readHistory required	boolean
recursive required	boolean

Responses

Response Schema: application/json

Array

children	Array of objects (RMResource)
name	string
folder	boolean
length	integer <int64>
lastModified	integer <int64>
	Array of objects (RMResourceChange)
	object

Response samples

200

Content type

application/json

[{"children": [{ }
],
"name": "string",
"folder": true,
"length": 0,
"lastModified": 0,
"changes": [{"changeId": "string",
"changeTime": "2019-08-24T14:15:22Z",
"changeUser": "2019-08-24T14:15:22Z"
}
],
"properties": {"property1": null,
"property2": null
}
}
]

Get resource metadata RMProjectsController.getResource

query Parameters

projectId required	string
resourcePath required	string

Responses

Response Schema: application/json

children	Array of objects (RMResource)
name	string
folder	boolean
length	integer <int64>
lastModified	integer <int64>
	Array of objects (RMResourceChange)
	object

Response samples

200

Content type

application/json

{"children": [{ }
],
"name": "string",
"folder": true,
"length": 0,
"lastModified": 0,
"changes": [{"changeId": "string",
"changeTime": "2019-08-24T14:15:22Z",
"changeUser": "2019-08-24T14:15:22Z"
}
],
"properties": {"property1": null,
"property2": null
}
}

Get resource path RMProjectsController.getResourcePath

query Parameters

projectId required	string
resourcePath required	string

Responses

Response Schema: application/json

Array

children	Array of objects (RMResource)
name	string
folder	boolean
length	integer <int64>
lastModified	integer <int64>
	Array of objects (RMResourceChange)
	object

Response samples

200

Content type

application/json

[{"children": [{ }
],
"name": "string",
"folder": true,
"length": 0,
"lastModified": 0,
"changes": [{"changeId": "string",
"changeTime": "2019-08-24T14:15:22Z",
"changeUser": "2019-08-24T14:15:22Z"
}
],
"properties": {"property1": null,
"property2": null
}
}
]

Move resource RMProjectsController.moveResource

query Parameters

projectId required	string
oldResourcePath required	string
newResourcePath required	string

Responses

Response Schema: text/plain

string

Set resource property RMProjectsController.setResourceProperty

query Parameters

projectId required	string
resourcePath required	string
propertyName required	string

Request Body schema: application/json

any

Responses

Response Schema: text/plain

string

Request samples

Payload

Content type

application/json

null

RMTasks

Resource manager task endpoints

Load task configuration file RMTaskController.loadTaskConfigurationFile

query Parameters

projectId required	string
filePath required	string

Responses

Response Schema: text/plain

string

Save task configuration file RMTaskController.saveTaskConfigurationFile

query Parameters

projectId required	string
filePath required	string
arg2 required	string

Responses

Load task configuration RMTaskController.loadTaskConfiguration

query Parameters

projectId required	string
taskId required	string
filePath required	string

Responses

Response Schema: text/plain

string

TMTaskInfo

Task info endpoints

Get all task runs for project TMTaskInfoController.getAllTaskRuns

query Parameters

projectId

required

string

Responses

Response Schema: application/json

Array

taskId	string
	Array of objects (TMTaskRun)

Response samples

200

Content type

application/json

[{"taskId": "string",
"runs": [{"id": "string",
"startTime": "2019-08-24T14:15:22Z",
"startUser": "string",
"startedBy": "string",
"errorMessage": "string",
"errorStackTrace": "string",
"extraMessage": "string",
"outputFiles": [{"fileName": "string",
"fileSize": 0
}
],
"runDuration": 0,
"runSuccess": true,
"finished": true
}
]
}
]

Get all task runs for task TMTaskInfoController.getAllTaskRuns2

query Parameters

projectId required	string
taskId required	string

Responses

Response Schema: application/json

Array

id	string
startTime	string <date-time>
startUser	string
startedBy	string
errorMessage	string
errorStackTrace	string
extraMessage	string
	Array of objects (TMTaskOutputFile)
runDuration	integer <int64>
runSuccess	boolean
finished	boolean

Response samples

200

Content type

application/json

[{"id": "string",
"startTime": "2019-08-24T14:15:22Z",
"startUser": "string",
"startedBy": "string",
"errorMessage": "string",
"errorStackTrace": "string",
"extraMessage": "string",
"outputFiles": [{"fileName": "string",
"fileSize": 0
}
],
"runDuration": 0,
"runSuccess": true,
"finished": true
}
]

Get latest task run TMTaskInfoController.getLatestTaskRun

query Parameters

projectId required	string
taskId required	string

Responses

Response Schema: application/json

id	string
startTime	string <date-time>
startUser	string
startedBy	string
errorMessage	string
errorStackTrace	string
extraMessage	string
	Array of objects (TMTaskOutputFile)
runDuration	integer <int64>
runSuccess	boolean
finished	boolean

Response samples

200

Content type

application/json

{"id": "string",
"startTime": "2019-08-24T14:15:22Z",
"startUser": "string",
"startedBy": "string",
"errorMessage": "string",
"errorStackTrace": "string",
"extraMessage": "string",
"outputFiles": [{"fileName": "string",
"fileSize": 0
}
],
"runDuration": 0,
"runSuccess": true,
"finished": true
}

Get specific task run by id TMTaskInfoController.getTaskRun

query Parameters

projectId required	string
taskId required	string
runId required	string

Responses

Response Schema: application/json

id	string
startTime	string <date-time>
startUser	string
startedBy	string
errorMessage	string
errorStackTrace	string
extraMessage	string
	Array of objects (TMTaskOutputFile)
runDuration	integer <int64>
runSuccess	boolean
finished	boolean

Response samples

200

Content type

application/json

{"id": "string",
"startTime": "2019-08-24T14:15:22Z",
"startUser": "string",
"startedBy": "string",
"errorMessage": "string",
"errorStackTrace": "string",
"extraMessage": "string",
"outputFiles": [{"fileName": "string",
"fileSize": 0
}
],
"runDuration": 0,
"runSuccess": true,
"finished": true
}

Download task run logs TMTaskInfoController.downloadTaskLogs

path Parameters

projectId required	string
taskId required	string
runId required	string

Responses

Response Schema: text/plain

string <binary>

Download task output file TMTaskInfoController.downloadTaskOutputFile

path Parameters

projectId required	string
taskId required	string
runId required	string

query Parameters

fileName

required

string

Responses

Response Schema: text/plain

string <binary>

TMTasks

Task execution endpoints

Get supported tasks TMTaskExecutionController.getSupportedTasks

Responses

Response Schema: application/json

Array

string

Response samples

200

Content type

application/json

["string"
]

Get all task schedules TMTaskExecutionController.getAllTaskSchedules

query Parameters

project

required

string

Responses

Response Schema: application/json

Array

taskId	string
	object (TMTaskScheduleInfo)
	object (DBTTaskScheduleConfiguration)

Response samples

200

Content type

application/json

[{"taskId": "string",
"information": {"projectId": "string",
"taskId": "string",
"nextRunInfo": "string",
"status": "string"
},
"configuration": {"taskName": "string",
"taskDescription": "string",
"frequency": "MINUTELY",
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"recurrence": 0,
"days": [0
],
"months": [0
],
"repetitionInterval": 0,
"maxDuration": 0,
"executionMinute": 0,
"properties": {"property1": null,
"property2": null
}
}
}
]

Run task TMTaskExecutionController.runTask

query Parameters

projectId required	string
taskId required	string

Responses

Schedule task TMTaskExecutionController.scheduleTask

query Parameters

projectId required	string
taskId required	string

Request Body schema: application/json

taskName	string
taskDescription	string
frequency	string (Frequency) Enum: "MINUTELY" "HOURLY" "DAILY" "WEEKLY" "MONTHLY" "ONE_TIME" "EVENT"
startTime	string <date-time>
endTime	string <date-time>
recurrence	integer <int32>
days	Array of integers <int32> [ items <int32 > ]
months	Array of integers <int32> [ items <int32 > ]
repetitionInterval	integer <int32>
maxDuration	integer <int32>
executionMinute	integer <int32>
	object

Responses

Request samples

Payload

Content type

application/json

{"taskName": "string",
"taskDescription": "string",
"frequency": "MINUTELY",
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"recurrence": 0,
"days": [0
],
"months": [0
],
"repetitionInterval": 0,
"maxDuration": 0,
"executionMinute": 0,
"properties": {"property1": null,
"property2": null
}
}

Remove task schedule TMTaskExecutionController.removeTaskSchedule

query Parameters

projectId required	string
taskId required	string

See DBeaver in action

Choose your product

Team Edition REST API (26.1.2-SNAPSHOT)

Health

Health check HealthController.health

Responses

Response Schema: text/plain

AdminObjects

Add object permissions DCAdminObjectsController.addObjectPermissions

query Parameters

Responses

Delete object permissions DCAdminObjectsController.deleteObjectPermissions

query Parameters

Responses

Delete object DCAdminObjectsController.deleteObject

query Parameters

Responses

Get subject object permission grants DCAdminObjectsController.getSubjectObjectPermissionGrants

query Parameters

Responses

Response Schema: application/json

Response samples

Delete all subject object permissions DCAdminObjectsController.deleteAllSubjectObjectPermissions

query Parameters

Responses

Lock subject by brute force protection DCAdminObjectsController.lockSubjectByBruteForceProtection

query Parameters

Responses

AdminSubjects

Get meta parameters by subject type DCAdminSubjectsController.getMetaParametersBySubjectType

query Parameters

Responses

Response Schema: application/json

Response samples

Get global default permissions DCAdminSubjectsController.getGlobalDefaultPermissions

Responses

Response Schema: application/json

Response samples

Set global default permissions DCAdminSubjectsController.setGlobalDefaultPermissions

query Parameters

Request Body schema: application/json

Responses

Request samples

Set subject permissions DCAdminSubjectsController.setSubjectPermissions

query Parameters

Request Body schema: application/json

Responses

Request samples

Set global subject permissions DCAdminSubjectsController.setGlobalSubjectPermissions

query Parameters

Request Body schema: application/json

Responses

Request samples

Get granted global permissions DCAdminSubjectsController.getGrantedGlobalPermissions

query Parameters

Responses

Response Schema: application/json

Response samples

AdminTeams

Get all teams DCAdminTeamsController.getAllTeams

Responses

Response Schema: application/json

Response samples

Create team DCAdminTeamsController.createTeam

Request Body schema: application/json

Responses

Response Schema: application/json

Request samples

Response samples

Find team by id DCAdminTeamsController.findTeam

query Parameters

Responses

Response Schema: application/json

Response samples

Update team DCAdminTeamsController.updateTeam

query Parameters

Request Body schema: application/json

Responses

Request samples

Delete team DCAdminTeamsController.deleteTeam