BatchIdsByCoordinates

Given database FQN return possible entity ids.

POST /api/coordinates/v1/database/by-fqn

BatchIdsByCoordinates

cURL

curl --request POST \
  --url https://developer.synq.io/api/coordinates/v1/database/by-fqn \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sqlFqn": [
    "<string>"
  ]
}
'

200

{
  "matchedCoordinates": [
    {
      "sqlFqn": "<string>",
      "candidates": [
        {
          "identifiers": [
            {
              "airflowDag": {
                "integrationId": "<string>",
                "dagId": "<string>"
              }
            }
          ],
          "synqPaths": [
            "<string>"
          ],
          "dialectName": "<string>",
          "dataPlatform": {
            "athena": {
              "instance": "<string>",
              "catalog": "<string>"
            }
          },
          "connectionId": "<string>",
          "instanceName": "<string>",
          "databaseName": "<string>",
          "schemaName": "<string>",
          "objectName": "<string>",
          "sqlFqn": "<string>",
          "sqlDatabaseName": "<string>",
          "sqlSchemaName": "<string>",
          "sqlObjectName": "<string>"
        }
      ]
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Body

application/json

sqlFqn · string[]

Databases coordinates as present in the SQL, e.g. db.schema.table

Response

200 - application/json

Success

matchedCoordinates · MatchedCoordinates · object[]

Show child attributes