curl --request POST \
--url https://developer.synq.io/api/entities/custom/v1 \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"entity": {
"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>"
]
}
]
}
}
'{}Create or update an entity. If the entity does not exist, it will be created, otherwise it will be updated. Entities are identified and deduplicated by their Identifier in a scope of a given customer workspace.
curl --request POST \
--url https://developer.synq.io/api/entities/custom/v1 \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"entity": {
"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>"
]
}
]
}
}
'{}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
UpsertEntityRequest is the request message for the UpsertEntity method.
The entity to create or update.
Show child attributes
Unique identifier for this entity.
Name of the entity that is displayed to the user.
1 - 100Immutable workspace identifier that this entity belongs to.
Id of custom type or default type when 0, ignored for non-custom entities
0 <= x <= 1000Information about entity type
ENTITY_TYPE_UNSPECIFIED, ENTITY_TYPE_BQ_TABLE, ENTITY_TYPE_BQ_VIEW, ENTITY_TYPE_LOOKER_LOOK, ENTITY_TYPE_LOOKER_EXPLORE, ENTITY_TYPE_LOOKER_VIEW, ENTITY_TYPE_LOOKER_DASHBOARD, ENTITY_TYPE_DBT_MODEL, ENTITY_TYPE_DBT_TEST, ENTITY_TYPE_DBT_SOURCE, ENTITY_TYPE_DBT_PROJECT, ENTITY_TYPE_DBT_METRIC, ENTITY_TYPE_DBT_SNAPSHOT, ENTITY_TYPE_DBT_SEED, ENTITY_TYPE_DBT_ANALYSIS, ENTITY_TYPE_DBT_EXPOSURE, ENTITY_TYPE_DBT_GROUP, ENTITY_TYPE_DBT_CLOUD_PROJECT, ENTITY_TYPE_DBT_CLOUD_JOB, ENTITY_TYPE_SNOWFLAKE_TABLE, ENTITY_TYPE_SNOWFLAKE_VIEW, ENTITY_TYPE_SNOWFLAKE_STREAM, ENTITY_TYPE_SNOWFLAKE_DYNAMIC_TABLE, ENTITY_TYPE_SNOWFLAKE_TASK, ENTITY_TYPE_REDSHIFT_TABLE, ENTITY_TYPE_REDSHIFT_VIEW, ENTITY_TYPE_TABLEAU_EMBEDDED, ENTITY_TYPE_TABLEAU_PUBLISHED, ENTITY_TYPE_TABLEAU_CUSTOM_SQL, ENTITY_TYPE_TABLEAU_TABLE, ENTITY_TYPE_TABLEAU_SHEET, ENTITY_TYPE_TABLEAU_DASHBOARD, ENTITY_TYPE_AIRFLOW_DAG, ENTITY_TYPE_AIRFLOW_TASK, ENTITY_TYPE_CLICKHOUSE_TABLE, ENTITY_TYPE_CLICKHOUSE_VIEW, ENTITY_TYPE_ANOMALY_MONITOR, ENTITY_TYPE_ANOMALY_MONITOR_SEGMENT, ENTITY_TYPE_SQLTEST_TEST, ENTITY_TYPE_POSTGRES_TABLE, ENTITY_TYPE_POSTGRES_VIEW, ENTITY_TYPE_MYSQL_TABLE, ENTITY_TYPE_MYSQL_VIEW, ENTITY_TYPE_DATABRICKS_WAREHOUSE, ENTITY_TYPE_DATABRICKS_TABLE, ENTITY_TYPE_DATABRICKS_VIEW, ENTITY_TYPE_DATABRICKS_JOB, ENTITY_TYPE_DATABRICKS_NOTEBOOK, ENTITY_TYPE_DATABRICKS_QUERY, ENTITY_TYPE_DATABRICKS_DASHBOARD, ENTITY_TYPE_SQLMESH_PROJECT, ENTITY_TYPE_SQLMESH_SQL_MODEL, ENTITY_TYPE_SQLMESH_PYTHON_MODEL, ENTITY_TYPE_SQLMESH_EXTERNAL, ENTITY_TYPE_SQLMESH_SEED, ENTITY_TYPE_SQLMESH_AUDIT, ENTITY_TYPE_SQLMESH_UNIT_TEST, ENTITY_TYPE_SQLMESH_ENVIRONMENT, ENTITY_TYPE_SQLMESH_SNAPSHOT, ENTITY_TYPE_DUCKDB_TABLE, ENTITY_TYPE_DUCKDB_VIEW, ENTITY_TYPE_TRINO_TABLE, ENTITY_TYPE_TRINO_VIEW, ENTITY_TYPE_ATLAN_ASSET, ENTITY_TYPE_ATLAN_INTEGRATION, ENTITY_TYPE_CASTORDOC_TABLE, ENTITY_TYPE_CASTORDOC_DASHBOARD, ENTITY_TYPE_CASTORDOC_VIEW, ENTITY_TYPE_CUSTOM_ENTITY_GENERIC, ENTITY_TYPE_CUSTOM_ENTITY_CUSTOM_TYPE_MIN, ENTITY_TYPE_CUSTOM_ENTITY_CUSTOM_TYPE_MAX Description of the entity that is displayed in relevant contexts. Can contain Markdown.
10000Timestamp when the entity was created.
Timestamp when the entity was last updated.
Timestamp when the entity was deleted. If this is set, the entity is considered deleted.
Return only value. Synq Path to the entity. This is a unique path that can be used to access the entity in the Synq's UI.
Return only value. Synq URL to the entity. This is a unique URL that can be used to access the entity in the Synq's UI.
Return only value. All identifiers of entities which are tightly related
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.
Show child attributes
Return only value. Synq Path to the all identifiers of entities which are tightly related
Annotations attached to the entity. Annotations are key-value pairs that can be used to store metadata about the entity.
20Success
UpsertEntityResponse is the response message for the UpsertEntity method.