Skip to main content
POST
/
api
/
entities
/
v1
/
by-id
BatchGetEntities
curl --request POST \
  --url https://developer.synq.io/api/entities/v1/by-id \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "ids": [
    {
      "airflowDag": {
        "integrationId": "<string>",
        "dagId": "<string>"
      }
    }
  ]
}'
{
  "entities": [
    {
      "workspace": "<string>",
      "id": {
        "airflowDag": {
          "integrationId": "<string>",
          "dagId": "<string>"
        }
      },
      "typeId": 500,
      "entityType": "ENTITY_TYPE_UNSPECIFIED",
      "name": "<string>",
      "description": "<string>",
      "createdAt": "2023-01-15T01:30:15.01Z",
      "updatedAt": "2023-01-15T01:30:15.01Z",
      "deletedAt": "2023-01-15T01:30:15.01Z",
      "synqPath": "<string>",
      "synqCatalogUrl": "<string>",
      "ids": [
        {
          "airflowDag": {
            "integrationId": "<string>",
            "dagId": "<string>"
          }
        }
      ],
      "synqPaths": [
        "<string>"
      ],
      "annotations": [
        {
          "name": "<string>",
          "values": [
            "<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.

  • airflow_dag
  • airflow_task
  • bigquery_table
  • clickhouse_table
  • custom
  • databricks_table
  • dataproduct
  • dbt_cloud_node
  • dbt_core_node
  • monitor
  • mysql_table
  • postgres_table
  • redshift_table
  • snowflake_table
  • sql_mesh_audit
  • sql_mesh_model
  • synq_path
  • trino_table

Response

200 - application/json

Success

BatchGetEntitiesResponse is the response message for the BatchGetEntities method.

entities
Entity · object[]

The entities that were retrieved.

I