Team Edition REST API (26.0.4-SNAPSHOT)

Download OpenAPI specification:

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

Health

Health check endpoints

Health check

Responses

AdminObjects

Admin object management endpoints

Add object permissions

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

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

query Parameters

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

Responses

Get subject object permission grants

query Parameters

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

Responses

Response samples

200

Content type

application/json

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

Delete all subject object permissions

query Parameters

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

Responses

Lock subject by brute force protection

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

query Parameters

subjectType

required

string (SMSubjectType)

Enum: "user" "team"

Responses

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

Responses

Response samples

200

Content type

application/json

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

Set global default permissions

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

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

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

query Parameters

subjectId

required

string

Responses

Response samples

200

Content type

application/json

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

AdminTeams

Admin teams management endpoints

Get all teams

Responses

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

Request Body schema: application/json

teamId	string
name	string
description	string
grantor	string

Responses

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

query Parameters

teamId

required

string

Responses

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

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

query Parameters

teamId required	string
force required	boolean

Responses

Get team members info

query Parameters

teamId

required

string

Responses

Response samples

200

Content type

application/json

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

Set user team role

query Parameters

userId required	string
teamId required	string
teamRole required	string

Responses

Get team members (legacy) Deprecated

query Parameters

teamId

required

string

Responses

Response samples

200

Content type

application/json

["string"
]

AdminUsers

Admin users management endpoints

Find users by mask

query Parameters

userNameMask

required

string

Responses

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",
"name": "string",
"userId": "string"
}
]

Create user

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

Request Body schema: application/json

userIdMask	string
enabledState	boolean
	object (DBPPage)

Responses

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

Request Body schema: application/json

userIdMask	string
enabledState	boolean
	object (DBPPage)

Responses

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",
"name": "string",
"userId": "string"
}
]

Import users

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

Responses

Get user by id

query Parameters

userId

required

string

Responses

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",
"name": "string",
"userId": "string"
}

Delete user

query Parameters

userId

required

string

Responses

Update user auth role

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

query Parameters

userId

required

string

Responses

Get user credentials

query Parameters

userId required	string
authProviderId required	string

Responses

Response samples

200

Content type

application/json

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

Set user credentials

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

query Parameters

userId required	string
authProviderId required	string

Responses

Enable or disable user

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

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

query Parameters

userId

required

string

Responses

Response samples

200

Content type

application/json

["string"
]

Get user teams

query Parameters

userId

required

string

Responses

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

query Parameters

userId required	string
arg1 required	Array of strings
grantorId required	string

Responses

Update user teams

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

query Parameters

userId required	string
arg1 required	Array of strings

Responses

Auth

Authentication endpoints

Authenticate session

Request Body schema: application/json

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

Responses

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

Responses

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

Responses

Response samples

200

Content type

application/json

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

Get current auth permissions

Responses

Response samples

200

Content type

application/json

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

Logout current session

Responses

Ping auth service

Responses

Get available auth providers

Responses

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,
"dataType": null,
"requiredFeatures": ["string"
],
"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,
"dataType": null,
"requiredFeatures": ["string"
],
"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

query Parameters

refreshToken

required

string

Responses

Response samples

200

Content type

application/json

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

Restore user session by appSessionId

query Parameters

appSessionId

required

string

Responses

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

query Parameters

authId

required

string

Responses

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

path Parameters

authId

required

string

Responses

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

Returns application-level configuration

Responses

Response samples

200

Content type

application/json

{"enabledServices": ["string"
],
"defaultTeamId": "string",
"applicationWorkspaceId": "string",
"productConfiguration": {"property1": null,
"property2": null
},
"integratedDeploymentInfo": {"descriptorId": "string",
"deploymentType": "string",
"deploymentIdentifier": "string",
"regionIdentifier": "string",
"hostIdentifier": "string",
"accountIdentifier": "string",
"productDisplayName": "string",
"appInfoDetails": "string",
"techSupportLinkParametersTemplate": "string",
"userIdentityLabel": "string",
"userIdentityValue": "string",
"autoLicensed": true,
"marketplaceProduct": {"pluginId": "string",
"id": "string",
"displayName": "string",
"description": "string",
"icon": {"location": "string"
},
"productType": "cloud",
"productDeploymentType": "instance",
"deploymentHostOS": "string",
"deploymentHostArch": "string",
"localDataPath": "string",
"productIdentifier": "string",
"application": {"pluginId": "string",
"id": "string",
"label": "string",
"userIdentityLabel": "string",
"userIdentityDescription": "string",
"instance": {"autoLicensed": true,
"descriptorId": "string",
"deploymentType": "string",
"deploymentIdentifier": "string",
"regionIdentifier": "string",
"hostIdentifier": "string",
"accountIdentifier": "string",
"productDisplayName": "string",
"appInfoDetails": "string",
"userIdentityLabel": "string",
"techSupportLinkParametersTemplate": "string",
"marketplaceProduct": { },
"userIdentityValue": "string"
},
"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": [{ }
]
}
}
}
}
}

Update common configuration

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

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 samples

200

Content type

application/json

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

Save service configuration

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

Returns user configuration based on request origin

Responses

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

Request Body schema: application/json

user	string
password	string
	Array of objects (AuthInfo)

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

Responses

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

Request Body schema: application/json

license

string

Responses

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

query Parameters

licenseId

required

string

Responses

Get active product license

query Parameters

validate

required

boolean

Responses

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

Responses

Invalidate license

Responses

Response samples

200

Content type

application/json

true

Get active product

Responses

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

Responses

OAuthModel

Database OAuth token endpoints

Create OAuth state

Responses

Get OAuth access token

query Parameters

state

required

string

Responses

Save OAuth access token

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

Responses

Response samples

200

Content type

application/json

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

Save OAuth client

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

query Parameters

clientId

required

string

Responses

Response samples

200

Content type

application/json

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

Delete OAuth client

query Parameters

clientId

required

string

Responses

Save OAuth authorization request

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

query Parameters

code

required

string

Responses

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

query Parameters

code

required

string

Responses

Objects

Object permissions and settings endpoints

Get all available objects permissions

query Parameters

objectType

required

string (SMObjectType)

Enum: "datasource" "project"

Responses

Response samples

200

Content type

application/json

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

Set object permissions

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

query Parameters

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

Responses

Response samples

200

Content type

application/json

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

Set object settings

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

query Parameters

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

Responses

Response samples

200

Content type

application/json

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

Delete all object permissions

query Parameters

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

Responses

Get object permission grants

query Parameters

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

Responses

Response samples

200

Content type

application/json

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

Verify data source connect access

query Parameters

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

Responses

Response samples

200

Content type

application/json

true

Secrets

Secret storage and management endpoints

Get secret

query Parameters

secretId

required

string

Responses

Response samples

200

Content type

application/json

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

Flush secret changes

Responses

List secrets

query Parameters

path

required

string

Responses

Response samples

200

Content type

application/json

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

List all shared secrets

Request Body schema: application/json

object (DBSSecretObject)

Responses

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

Request Body schema: application/json

object (DBSSecretObject)

Responses

Request samples

Payload

Content type

application/json

{ }

Discover current user secrets

Request Body schema: application/json

object (DBSSecretObject)

Responses

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

query Parameters

projectId

required

string

Responses

Delete subject secrets

query Parameters

subjectId

required

string

Responses

Set subject secret value

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

query Parameters

secretId

required

string

Responses

Set private secret value by object

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

query Parameters

secretId required	string
arg1 required	string

Responses

Delete secret

query Parameters

secretId

required

string

Responses

Clear all secrets

query Parameters

keyPrefix

required

string

Responses

Sessions

Session management endpoints

Update session

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

query Parameters

sessionId

required

string

Responses

Response samples

200

Content type

application/json

true

SingletonTasks

Singleton task management endpoints

Create singleton task

query Parameters

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

Responses

Response samples

200

Content type

application/json

true

End singleton task

query Parameters

type

required

string (SMSingletonTaskType)

Value: "DEPLOYMENT_DOMAIN_REFRESH"

Responses

Response samples

200

Content type

application/json

true

Subjects

Subjects management endpoints

Get subject permissions

query Parameters

subjectId

required

string

Responses

Response samples

200

Content type

application/json

["string"
]

Users

User endpoints

Get current user

Responses

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",
"name": "string",
"userId": "string"
}

Check access to users

query Parameters

teamRole

required

string

Request Body schema: application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

200

Content type

application/json

true

Get user credentials

query Parameters

authProviderId

required

string

Responses

Response samples

200

Content type

application/json

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

Set user credentials

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

Responses

Response samples

200

Content type

application/json

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

Set user parameters

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

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

Responses

Response samples

200

Content type

application/json

["string"
]

Get user teams

Responses

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

query Parameters

teamId

required

string

Responses

Response samples

200

Content type

application/json

["string"
]

Get API tokens

Responses

Response samples

200

Content type

application/json

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

Create API token

Request Body schema: application/json

tokenName	string
period	integer <int32>

Responses

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

query Parameters

tokenName

required

string

Responses

Get user permissions

query Parameters

userId

required

string

Responses

Response samples

200

Content type

application/json

["string"
]

QM

Query manager endpoints

Get conversation history metadata by conversationId

query Parameters

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

Responses

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

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

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

query Parameters

appSessionId

required

string

Responses

Delete AI conversation

query Parameters

conversationId

required

string

Responses

Extend conversation context

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

query Parameters

conversationId required	string
messageId required	integer <int32>

Responses

Append messages to conversation

query Parameters

conversationId

required

string

Request Body schema: application/json

Array

id	integer <int32>
content	string
displayMessage	string
role	string (QMAIChatRole) Enum: "ASSISTANT" "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

query Parameters

conversationId required	string
arg1 required	string

Responses

Find AI conversations for session

query Parameters

sessionId

required

string

Responses

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

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

Responses

Response samples

200

Content type

application/json

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

Get admin query history cursor

Request Body schema: application/json

filter	object (QMEventFilter)
sessionId	string

Responses

Request samples

Payload

Content type

application/json

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

Response samples

200

Content type

application/json

{"totalSize": 0
}

Get query history cursor

Request Body schema: application/json

	object (QMEventCriteria)
filter	object (QMEventFilter)
sessionId	string

Responses

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

Request Body schema: application/json

filter	object (QMEventFilter)
sessionId	string

Responses

Request samples

Payload

Content type

application/json

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

Response samples

200

Content type

application/json

{"totalSize": 0
}

Open QM session

Request Body schema: application/json

userName	string
userDomain	string
userIp	string

Responses

Request samples

Payload

Content type

application/json

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

Ping QM service

Responses

Get query filter history

query Parameters

sessionId required	string
query required	string

Responses

Response samples

200

Content type

application/json

["string"
]

Save query filter value

query Parameters

sessionId

required

string

Request Body schema: application/json

query	string
filterValue	string

Responses

Request samples

Payload

Content type

application/json

{"query": "string",
"filterValue": "string"
}

Delete query filter value

query Parameters

sessionId

required

string

Request Body schema: application/json

query	string
filterValue	string

Responses

Request samples

Payload

Content type

application/json

{"query": "string",
"filterValue": "string"
}

Read smart completion history

query Parameters

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

Responses

Response samples

200

Content type

application/json

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

Dispatch API call events

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

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

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

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

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

Request Body schema: application/json

Array

	object (RAGDataSourceKey)
objectName	string

Responses

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

Request Body schema: application/json

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

Responses

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

Request Body schema: application/json

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

Responses

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

query Parameters

olderThan

required

string <date-time>

Responses

Response samples

200

Content type

application/json

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

Save RAG embeddings

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

query Parameters

projectId

required

string

Responses

Restore project backup

query Parameters

projectId required	string
backupId required	string

Responses

Read project configuration

query Parameters

projectId required	string
configurationPath required	string

Responses

Save project configuration

query Parameters

projectId required	string
configurationPath required	string
arg2 required	string

Responses

RMConfig

Resource manager configuration endpoints

Load configuration file

query Parameters

filePath

required

string

Responses

Save configuration file

query Parameters

filePath required	string
arg1 required	string

Responses

Load secure configuration file

query Parameters

secureFilePath

required

string

Responses

Save secure configuration file

query Parameters

secureFilePath required	string
arg1 required	string

Responses

RMFiles

Resource manager file endpoints

Load file data (legacy)

path Parameters

fileType

required

string

query Parameters

filePath

required

string

Responses

Save file data (legacy)

path Parameters

fileType

required

string

query Parameters

filePath

required

string

Request Body schema: text/plain

string <binary>

Responses

Delete file

query Parameters

fileType required	string
filePath required	string
recursive required	boolean

Responses

Load file data (encrypted)

query Parameters

fileType required	string
filePath required	string

Responses

Save file data (encrypted)

query Parameters

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

Responses

List files

query Parameters

fileType required	string
filePath required	string

Responses

Response samples

200

Content type

application/json

["string"
]

RMProjects

Resource manager project endpoints

List accessible projects

Responses

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",
"folder": true,
"shared": true
}
]

Create project

query Parameters

name required	string
description required	string

Responses

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

Ping RM service

Responses

List all shared projects

Responses

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",
"folder": true,
"shared": true
}
]

Get project

query Parameters

projectId required	string
readResources required	boolean
readProperties required	boolean

Responses

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

Update project

query Parameters

projectId

required

string

Request Body schema: application/json

name	string
description	string

Responses

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

Delete project

query Parameters

projectId

required

string

Responses

Get project datasources

query Parameters

projectId required	string
dataSourceIds required	Array of strings

Responses

Update project datasources

query Parameters

projectId required	string
arg1 required	string
dataSourceIds	Array of strings

Responses

Response samples

200

Content type

application/json

true

Create project datasources

query Parameters

projectId required	string
arg1 required	string
dataSourceIds	Array of strings

Responses

Delete project datasources

query Parameters

projectId required	string
dataSourceIds required	Array of strings

Responses

Create project datasource folder

query Parameters

projectId required	string
folderPath required	string

Responses

Move project datasource folder

query Parameters

projectId required	string
oldPath required	string
newPath required	string

Responses

Delete project datasource folders

query Parameters

projectId required	string
folderPaths required	Array of strings
dropContents required	boolean

Responses

Get project property

query Parameters

projectId required	string
property required	string

Responses

Response samples

200

Content type

application/json

null

Set project property

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

query Parameters

projectId required	string
resourcePath required	string

Responses

Create resource

query Parameters

projectId required	string
resourcePath required	string
isFolder required	boolean

Responses

Set resource contents

query Parameters

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

Responses

Delete resource

query Parameters

projectId required	string
resourcePath required	string
recursive required	boolean

Responses

Set resource properties

query Parameters

projectId required	string
resourcePath required	string

Request Body schema: application/json

property name*

additional property

any

Responses

Request samples

Payload

Content type

application/json

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

List resources

query Parameters

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

Responses

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

query Parameters

projectId required	string
resourcePath required	string

Responses

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

query Parameters

projectId required	string
resourcePath required	string

Responses

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

query Parameters

projectId required	string
oldResourcePath required	string
newResourcePath required	string

Responses

Set resource property

query Parameters

projectId required	string
resourcePath required	string
propertyName required	string

Request Body schema: application/json

any

Responses

Request samples

Payload

Content type

application/json

null

RMTasks

Resource manager task endpoints

Load task configuration file

query Parameters

projectId required	string
filePath required	string

Responses

Save task configuration file

query Parameters

projectId required	string
filePath required	string
arg2 required	string

Responses

Load task configuration

query Parameters

projectId required	string
taskId required	string
filePath required	string

Responses

TMTaskInfo

Task info endpoints

Get all task runs for project

query Parameters

projectId

required

string

Responses

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

query Parameters

projectId required	string
taskId required	string

Responses

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

query Parameters

projectId required	string
taskId required	string

Responses

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

query Parameters

projectId required	string
taskId required	string
runId required	string

Responses

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

path Parameters

projectId required	string
taskId required	string
runId required	string

Responses

Download task output file

path Parameters

projectId required	string
taskId required	string
runId required	string

query Parameters

fileName

required

string

Responses

TMTasks

Task execution endpoints

Get supported tasks

Responses

Response samples

200

Content type

application/json

["string"
]

Get all task schedules

query Parameters

project

required

string

Responses

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

query Parameters

projectId required	string
taskId required	string

Responses

Schedule task

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

query Parameters

projectId required	string
taskId required	string

See DBeaver in action

Choose your product

Team Edition REST API (26.0.4-SNAPSHOT)

Health

Health check

Responses

AdminObjects

Add object permissions

query Parameters

Responses

Delete object permissions

query Parameters

Responses

Delete object

query Parameters

Responses

Get subject object permission grants

query Parameters

Responses

Response samples

Delete all subject object permissions

query Parameters

Responses

Lock subject by brute force protection

query Parameters

Responses

AdminSubjects

Get meta parameters by subject type

query Parameters

Responses

Response samples

Get global default permissions

Responses

Response samples

Set global default permissions

query Parameters

Request Body schema: application/json

Responses

Request samples

Set subject permissions

query Parameters

Request Body schema: application/json

Responses

Request samples

Set global subject permissions

query Parameters

Request Body schema: application/json

Responses

Request samples

Get granted global permissions

query Parameters

Responses

Response samples

AdminTeams

Get all teams

Responses

Response samples

Create team

Request Body schema: application/json

Responses

Request samples

Response samples

Find team by id

query Parameters

Responses

Response samples

Update team

query Parameters

Request Body schema: application/json

Responses

Request samples

Delete team

query Parameters

Responses

Get team members info

query Parameters

Responses

Response samples

Set user team role

query Parameters