API Reference#
This page details the Testing Suite API endpoints available.
- GET /api/v1/metadata#
- Query Parameters
jdbcUrl (string) –
user (string) –
password (string) –
sqlDialect (string) –
- Status Codes
200 OK – OK
- Response JSON Object
dialect (string) –
id (string) – (required)
procedures[] (string) –
schemas[] (string) –
tables[].database_id (string) – (required)
tables[].fields[].data_type.length (integer) –
tables[].fields[].data_type.nullable (boolean) – (required)
tables[].fields[].data_type.precision (integer) –
tables[].fields[].data_type.scale (integer) –
tables[].fields[].data_type.sql_type_name (string) –
tables[].fields[].data_type.type_name (string) – (required)
tables[].fields[].database_id (string) – (required)
tables[].fields[].name (string) – (required)
tables[].fields[].schema (string) –
tables[].fields[].table (string) – (required)
tables[].foreign_keys[].database_id (string) – (required)
tables[].foreign_keys[].fields[] (string) –
tables[].foreign_keys[].name (string) – (required)
tables[].foreign_keys[].referred_database_id (string) – (required)
tables[].foreign_keys[].referred_fields[] (string) –
tables[].foreign_keys[].referred_name (string) – (required)
tables[].foreign_keys[].referred_schema (string) –
tables[].foreign_keys[].referred_table (string) –
tables[].foreign_keys[].schema (string) –
tables[].foreign_keys[].table (string) – (required)
tables[].indexes[] (string) –
tables[].name (string) – (required)
tables[].primary_key.database_id (string) – (required)
tables[].primary_key.fields[] (string) –
tables[].primary_key.name (string) – (required)
tables[].primary_key.schema (string) –
tables[].primary_key.table (string) – (required)
tables[].schema (string) –
tables[].unique_keys[].database_id (string) – (required)
tables[].unique_keys[].fields[] (string) –
tables[].unique_keys[].name (string) – (required)
tables[].unique_keys[].schema (string) –
tables[].unique_keys[].table (string) – (required)
triggers[] (string) –
users[] (string) –
views[] (string) –
- POST /api/v1/validate-connection#
- Request JSON Object
jdbc_url (string) – (required)
password (string) –
sql_dialect (string) –
user (string) –
- Status Codes
200 OK – OK
- Response JSON Object
failed (boolean) – (required)
messages[] (string) –
- POST /api/v1/validate-workflow#
- Request JSON Object
config (string) – (required)
input_connection.jdbc_url (string) – (required)
input_connection.password (string) –
input_connection.sql_dialect (string) –
input_connection.user (string) –
output_connection.jdbc_url (string) – (required)
output_connection.password (string) –
output_connection.sql_dialect (string) –
output_connection.user (string) –
- Status Codes
200 OK – OK
- Response JSON Object
failed (boolean) – (required)
messages[] (string) –
- POST /api/v1/workflow-run#
- Request JSON Object
config (string) – (required)
input_connection.jdbc_url (string) – (required)
input_connection.password (string) –
input_connection.sql_dialect (string) –
input_connection.user (string) –
output_connection.jdbc_url (string) – (required)
output_connection.password (string) –
output_connection.sql_dialect (string) –
output_connection.user (string) –
user_id (integer) –
workflow_id (integer) – (required)
workflow_name (string) – (required)
- Status Codes
200 OK – OK
- Response JSON Object
end_date (string) –
start_date (string) –
user_id (integer) –
workflow_run_id (integer) – (required)
workflow_run_status (string) –