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": [
    {
      "id": {
        "airflowDag": {
          "integrationId": "<string>",
          "dagId": "<string>"
        }
      },
      "name": "<string>",
      "workspace": "<string>",
      "typeId": 500,
      "entityType": "ENTITY_TYPE_UNSPECIFIED",
      "description": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z",
      "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.

Identifier is a unique reference to an entity in SYNQ system. Entity identifiers are designed to closely mimic identifiers used by data platforms and tools. To construct an identifier, you need to know the kind of the entity and the ids that you would normally use to identify it in the data platform or tool. For example, to identify a table in BigQuery, you would need to know the project, dataset, and table names.

Response

200 - application/json

Success

BatchGetEntitiesResponse is the response message for the BatchGetEntities method.

​
entities
Entity · object[]

The entities that were retrieved.