REST API Reference

Back Next

Viewing the supported database types for a saved SQL query

Use the following URI to view the supported database types for a saved SQL query:

GET /datavalidation-service/api/v1/databaseType

Use the IDS-SESSION-ID header in the GET request.

GET request: Optionally, you can provide a specific connection ID as a parameter to get the database type of that connection.

If you don't provide a connection ID, the API returns a list of all the supported database types for a saved SQL query.
GET response: If you had provided a connection ID, the GET request returns a
200 Successful operation
response and the following response fields:

Field
Type
Description

id
String
<>

databaseTypeName
String
If you provided a connection ID, displays the type of the database associated with the specified connection ID.
If you had not provided a connection ID, displays the following list of all the supported database types for a saved SQL query:

Amazon Redshift v2
Databricks
DB2
Google BigQuery V2
Microsoft Azure Synapse SQL
MySQL
Oracle
PostgreSQL
Snowflake Data Cloud
SqlServer; If there was a server issue, the GET request returns a
500 Internal Server
response and the following response fields:

Field
Type
Description

code
String
Code of the error message.

message
String
Error message.

debugMessage
String
Message that can be used for debugging the issue.

requestId
String
String that uniquely identifies the request. Used for debugging purposes.

details
String
Detailed information about the error message.

Field	Type	Description
id	String	<>
databaseTypeName	String	If you provided a connection ID, displays the type of the database associated with the specified connection ID. If you had not provided a connection ID, displays the following list of all the supported database types for a saved SQL query: Amazon Redshift v2 Databricks DB2 Google BigQuery V2 Microsoft Azure Synapse SQL MySQL Oracle PostgreSQL Snowflake Data Cloud SqlServer

Field	Type	Description
code	String	Code of the error message.
message	String	Error message.
debugMessage	String	Message that can be used for debugging the issue.
requestId	String	String that uniquely identifies the request. Used for debugging purposes.
details	String	Detailed information about the error message.