POST
/
api
/
coordinates
/
v1
/
database
/
by-id
BatchDatabaseCoordinates
curl --request POST \
  --url https://developer.synq.io/api/coordinates/v1/database/by-id \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "ids": [
    {
      "airflowDag": {
        "integrationId": "<string>",
        "dagId": "<string>"
      }
    }
  ]
}'
{
  "coordinates": [
    {
      "identifiers": [
        {
          "airflowDag": {
            "integrationId": "<string>",
            "dagId": "<string>"
          }
        }
      ],
      "synqPaths": [
        "<string>"
      ],
      "dialectName": "<string>",
      "dialect": "SQL_DIALECT_UNSPECIFIED",
      "dataPlatform": {
        "bigquery": {
          "project": "<string>"
        }
      },
      "dataPlatformType": "DATA_PLATFORM_TYPE_UNSPECIFIED",
      "connectionId": "<string>",
      "instanceName": "<string>",
      "databaseName": "<string>",
      "schemaName": "<string>",
      "objectName": "<string>",
      "sqlFqn": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

BatchGetEntitiesRequest is the request message for the BatchGetEntities method.

​
ids
(airflow_dag · object | airflow_task · object | bigquery_table · object | clickhouse_table · object | custom · object | databricks_table · object | dataproduct · object | dbt_cloud_node · object | dbt_core_node · object | monitor · object | mysql_table · object | postgres_table · object | redshift_table · object | snowflake_table · object | sql_mesh_audit · object | sql_mesh_model · object | synq_path · object | trino_table · object)[]

Identifiers of the entities to get.

Response

200 - application/json

Success

BatchGetEntitiesResponse is the response message for the BatchGetEntities method.

​
coordinates
DatabaseCoordinates · object[]

The entities that were retrieved.