> ## Documentation Index > Fetch the complete documentation index at: https://docs.synq.io/llms.txt > Use this file to discover all available pages before exploring further. # BatchGetEntityAnnotations > Read the annotations carried by specific entities. ListAnnotations answers what the workspace annotates by and how often; this answers what one entity carries. They are separate reads because an entity's annotations are not part of the entity: `synq.entities.v1.Entity` is the shape `synq.entities.custom.v1.UpsertEntity` accepts, so the `annotations` field on it is what a producer ASSERTS about an entity, and answering a read with it would make a read-edit-write round trip write one entity's annotations onto another. ## OpenAPI ````yaml /api-reference/openapi.yaml post /api/entities/annotations/v1/batchGet openapi: 3.1.0 info: version: '1.0' title: SYNQ servers: - url: https://developer.synq.io - url: https://api.us.synq.io - url: https://api.au.synq.io security: - bearerAuth: [] tags: - name: synq.deliveries.v1.DeliveriesService description: >- DeliveriesService reports what was sent to your notification integrations — webhooks, PagerDuty, Opsgenie — and what came back. It answers the three questions an integration owner has. "Did this event reach my endpoint": list the deliveries for an event id and read the outcome of each. "Why did my endpoint reject it": read the attempts, which carry the request as it was sent and the response as it came back. "Why did I get nothing at all": every delivery that sent nothing records a reason, so a silent integration can be explained rather than guessed at. Deliveries are kept for 90 days. Credential-bearing header values are never returned, on either side of an attempt — see `Header`. - name: synq.ingest.cloudwatch.v1.CloudwatchService - name: synq.ingest.dwh.v1.DwhService - name: synq.ingest.openlineage.v1.OpenlineageService - name: synq.ingest.airflow.v1.AirflowLogsService - name: synq.alerts.services.v1.AlertsService description: |- AlertsService provides operations for managing alert configurations. Deprecated: use synq.alerts.services.v2.AlertsService. The v2 service selects entities with the canonical synq.queries.v1.Query + resolver_ql trigger; this v1 service, which uses the bespoke EntityGroupQuery selection, is scheduled for removal. Migrate existing integrations to v2. - name: synq.alerts.services.v2.AlertsService description: |- AlertsService provides operations for managing alert configurations. It supersedes synq.alerts.services.v1.AlertsService: entities are selected with the canonical synq.queries.v1.Query + resolver_ql trigger rather than the bespoke EntityGroupQuery. - name: synq.entities.folders.v1.FoldersService description: >- FoldersService discovers and browses the folder / containment hierarchy of the catalog: the roots data hangs from, the sub-folders under any folder, the folders a given entity lives in, and the entities contained in a folder. It is a read / navigation surface, not folder management — there are no create, move, or delete operations. Addressing: every folder has an opaque `folder_entity_id` (round-trip it verbatim) and a structured `FolderRef{root_entity_id, folders[]}` (the human-friendly form). Entities — both folder members and the ids you pass to `GetFolderOf` — are named by their opaque entity id, the same id used across the rest of the entities API. Depth footgun: membership is SHALLOW by default. `Browse` returns only the direct children of a folder, and `ListMembers` returns only the entities placed directly in the folder. Set `deep = true` (or raise `Browse.depth`) to recurse into sub-folders. - name: synq.entities.typedefs.v1.TypeDefsService description: >- TypeDefsService tells you what the type values in every other endpoint mean. Responses across the API describe things by enum — an entity is an `ENTITY_TYPE_BQ_TABLE`, it belongs to `DATA_PLATFORM_TYPE_BIGQUERY`, a run is an `EXECUTION_TYPE_DBT_INVOCATION`. This service turns each of those into a name you can display and a set of facts you can act on: is this a transformation model, does it live in a warehouse, can it be monitored. Read it instead of keeping your own copy of the list. New entity types and new platforms are added as Coalesce Quality supports more tools, and a hard-coded table in your code will label them with whatever its fallback produces and miss that an existing type gained a capability. Everything here comes from the server, so you pick both up without changing your code. A typical integration calls all three once at startup, keeps them in a map, and looks types up as responses arrive. Scoping and freshness: * ListEntityTypeDefs is per workspace, because the types you defined yourself are part of your workspace's vocabulary. It returns the built-in types and your own custom types together. * ListPlatformDefs and ListExecutionTypeDefs are the same for everyone. * The built-in half changes only when Coalesce Quality is upgraded, so caching it for the life of your process is fine. You can add or edit your own custom types at any time, so if a newly created type needs to appear promptly, cache the entity types for minutes rather than hours, or re-read after you change one. The workspace comes from your credentials; there is nothing to pass. Each list is small — hundreds of entries — so every call returns the whole set and none of them page. - name: synq.entities.entities.v1.EntitiesService description: EntitiesService is a service for retriving any entity. - name: synq.entities.checks.v1.ChecksCategoriesService description: |- ChecksCategoriesService lets workspace admins set explicit category overrides on individual checks. An explicit category is the authoritative category for a check — it takes precedence over the categories computed by the workspace's categorisation rules. It is a public API so customers can manage check categories programmatically; the same service is also mounted on the internal API. The workspace and the acting identity are always taken from the request context, never from the payload. - name: synq.entities.checks.v2.ChecksCategorisationRulesService description: |- ChecksCategorisationRulesService manages the rules that categorise a workspace's checks automatically. A rule says "checks matching this predicate get this category on this dimension". Rules are the scalable way to categorise: they apply to checks that already exist and to every check ingested afterwards, so a new dbt package or a new warehouse does not mean a fresh round of manual tagging. A rule-computed category is the lowest-precedence source — a category set explicitly on a check through ChecksCategoriesService, and one the producing tool declared, both win over it. A typical loop is: ListCategorisationFilters to see what the workspace's checks look like, PreviewRule to check the reach of a candidate, UpsertRule to save it, then GetRecategorisationStatus to confirm the existing checks have caught up. Every workspace starts with a set of platform-provided rules covering the common cases. They are visible here, they can be superseded by a workspace rule of any priority, and they cannot be edited from a workspace. - name: synq.entities.checks.v2.ChecksCategoriesService description: |- ChecksCategoriesService reads and edits the categories of the checks in a workspace. Categorising checks is what turns a long list of tests into a picture of data quality: it lets you ask how much of a data product is covered for completeness, or which freshness checks exist across three warehouses that each name the same idea differently. Every check resolves to at most one category per dimension: * technical — what kind of check this is, mechanically ("nullness", "uniqueness", "freshness"); * governance — what the check is for, in data-quality terms ("Completeness", "Accuracy", "Timeliness"). The two are independent, and each resolves from three sources, in descending precedence: a category set explicitly on the check through this service, a category the producing tool declared, and a category one of the workspace's categorisation rules computed. Rules are managed by ChecksCategorisationRulesService and are the right tool for anything that generalises; set a category explicitly only for the checks that are genuine exceptions. The workspace and the acting identity always come from the request credentials, never from the payload. - name: synq.entities.code.v1.CodeService description: >- CodeService is a service for retrieving code associated with entities in the system. It provides functionality to access and manage code artifacts such as SQL queries, Python scripts, dbt models, and other code configurations that are part of Coalesce Quality entities. - name: synq.entities.schemas.v1.SchemaMismatchesService description: >- SchemaMismatchesService provides access to schema drift information between data platform tables and their definitions (e.g., dbt models). - name: synq.entities.schemas.v1.SchemasService description: EntitiesService is a service for retriving any entity. - name: synq.entities.constraints.v1.TableConstraintsService description: >- TableConstraintsService provides access to table constraint and index information. - name: synq.entities.sql_insights.v1.SqlInsightsService description: >- SqlInsightsService exposes analytical information about the SQL used across a workspace's entities. It answers questions such as "which SQL constructs are used in my warehouse, and by how many entities" and "what SQL constructs does this specific entity use", without requiring the caller to re-parse any SQL. - name: synq.entities.orchestration.v1.OrchestrationService description: >- OrchestrationService provides information about orchestration relationships between entities. This includes relationships between Airflow tasks and transformation models (dbt, SQLMesh), as well as task-to-task dependencies. - name: synq.entities.resolve.v1.IdentifierResolveService description: >- IdentifierResolveService resolves identifiers to their Coalesce Quality paths and identities. - name: synq.entities.status.v1.EntityIssuesService description: EntityIssuesService is the service which retrieves entity issues status. - name: synq.entities.status.v1.EntityIncidentsService description: EntityIncidentsService is the service which retrieves entity status. - name: synq.entities.changes.v1.ChangesService description: >- ChangesService provides functionality to track and retrieve all types of changes to data entities. This unified service returns ALL change types for an entity: - Git commits: Changes to code files (dbt models, SQL files) tracked in version control - Schema changes: Database schema modifications (columns added/removed/changed) - SQL definition changes: View/materialized view definition updates detected by Coalesce Quality Changes are returned with structured metadata including: - For git commits: structured statistics (directories, file types, top changes) - For schema changes: detailed column-level diffs - For SQL changes: before/after SQL definitions Use cases: - "What changed in the last week for table X?" → Returns git commits, schema changes, SQL changes - "Show me all commits affecting this dbt model" → Returns git commits with lineage context - "What schema changes happened to this table?" → Returns schema changes detected by Coalesce Quality - name: synq.entities.annotations.v1.AnnotationsService description: >- AnnotationsService provides operations for managing and querying entity annotations. Annotations are key-value pairs that can be attached to entities for categorization and filtering. - name: synq.entities.lineage.v1.LineageService description: |- LineageService allows you to fetch: * Entity level lineage from a starting point of one or more entities. * Column Level lineage from a starting point of multiple columns of a single entity. - name: synq.entities.custom.v1.EntityExecutionsService - name: synq.entities.custom.v1.GroupsService description: >- It eliminates the need to keep state on client side to remember which assets were already created and which should be deleted. The server will keep track of the current state of the group and client can always send the intended new state. The server will calculate the diff and entities that are no longer present in the group will be removed. Example: 1. group has entities A, B, C at time t1 2. client sends group with entities B, C, D at time t2 3. server will remove entity A from the system and update the current state of the group to B, C, D The service is designed to be idempotent and can be called multiple times with the same state without causing any side effects. - name: synq.entities.custom.v1.EntitiesService description: >- custom.EntitiesService is a service for managing custom entities. Entities can represent various data platform concepts such as services, consumers, applications or data pipelines that are not natively available in Coalesce Quality. Entities are identified by a unique identifier and can be created, updated, read and deleted. - name: synq.entities.custom.v1.TypesService description: TypesService is a service for managing custom entity types. - name: synq.entities.custom.v1.RelationshipsService description: >- RelationshipsService allow management of relationships between entities. Relationships can be created, updated, and deleted between 2 custom entities, or between a custom entity and Coalesce Quality native entity.enum There is no option to create relationships between 2 Coalesce Quality native entities (dbt model, BI dashboard, etc.). - name: synq.entities.custom.v1.ChecksRelationshipsService - name: synq.entities.custom.v1.FeaturesService - name: synq.entities.impact.v1.ImpactService - name: synq.entities.executions.v1.EntityExecutionsService description: 'Deprecated: Use [synq.entities.custom.v1.EntityExecutionsService] instead' - name: synq.entities.executions.v2.EntityExecutionsService description: >- EntityExecutionsService provides read-only access to entity execution history. This service allows customers to retrieve information about all executions that happened on their entities, including execution status, timing, and messages. Use cases: - Retrieve execution history for specific entities - Filter executions by time range, status, or execution type - Get aggregated summaries of execution activity - Track execution trends and patterns - name: synq.entities.coordinates.v1.DatabaseCoordinatesService description: >- DatabaseCoordinatesService is a service for getting database coordinates of Entities. - name: synq.overlays.v1.OverlaysService description: |- OverlaysService answers which organizational overlays claim an entity. An overlay is a grouping you lay over your catalog rather than something the warehouse itself knows about. Two kinds exist today: a **data product**, which groups the assets that make up something your organization delivers, and an **owner**, which names the person or team responsible for a set of assets and where alerts about them go. Each is defined by a membership rule, not by an explicit list, so what belongs to one changes as your warehouse does. "Owner" here means stewardship — who is accountable for an asset and who hears about it when something breaks. It is not the structural containment sense the word carries elsewhere in the API, where an asset can be said to own the checks and monitors declared on it. Nothing this service returns describes that relationship. This service reads that membership backwards. The defining services answer "what is in this data product"; this one answers "which data products and owners claim this table" — the question you have when you are looking at one asset and want to know who cares about it and what it feeds. Membership follows identity. Where the same table is represented more than once in your catalog — a transformation model and the warehouse table it builds — an overlay whose rule matches one of them claims the others too. So an alert routed by ownership reaches the responsible party whichever representation raised it, and you do not have to know which one a rule was written against. Two consequences worth planning around. You can ask about whichever representation you happen to hold and get the same answer, so there is no need to resolve an identity group first. And if you do ask about several members of one group in a single call, each comes back with its own entry carrying the same overlays — correct, but redundant, so ask about one member per group when you are near the request limit. Related services: - `synq.dataproducts.v2.DataproductsService` and `synq.owners.v1.OwnersService` define the overlays read here, and turn an id from a response into a name, a description and its contact channels. - `synq.entities.resolve.v1.IdentifierResolveService` turns an identifier you already hold — a warehouse table name, a dbt model — into the `entity_id` these calls take. - name: synq.monitors.history.v1.HistoryService - name: synq.monitors.info.v1.MonitorInfoService - name: synq.monitors.predictions.v1.MonitorPredictionsService description: Access to anomaly detection model predictions and raw metric timeseries. - name: synq.monitors.automated_monitors.v1.DeploymentRulesService - name: synq.monitors.custom_monitors.v1.CustomMonitorsService - name: synq.monitors.segments.v1.MonitorSegmentsService description: |- Reads and names the segments of a segmented custom monitor. A monitor configured with a segmentation expression splits the data it monitors into one time series per distinct value of that expression, and each of those is a segment. The label is what every downstream surface shows for a segment: the name of the check it produces, the search result, the alert. A segment with no label falls back to its raw value, so a monitor segmented on something encoded (an id, a code, a hashed bucket) reads as that raw value everywhere until the segment is named. - name: synq.queries.v1.NLQueryService description: >- NLQueryService generates structured Query protos from natural language descriptions using an LLM. - name: synq.queries.v1.QueriesService description: |- QueriesService compiles and evaluates ResolverQL — the compact text query language used across Coalesce Quality to select entities — over the public API. ResolverQL is a string DSL (for example `with_type("TABLE")` or `in_folder(...)`); a structured `synq.queries.v1.Query` is its parsed, machine-readable form. This service is the bridge between the two and the read-only execution surface for both: - `TranslateResolverQl` compiles a ResolverQL expression into a structured `Query` without evaluating it — inspect it, validate it, or reuse it as a filter on another API (entity listing, folder browsing, ...). - `ResolveQuery` compiles a ResolverQL expression (or takes an already-structured `Query`), evaluates it against the catalog, and returns the matched entity ids. This is the general author -> resolve loop. - name: synq.datachecks.v1.TriggerService description: TriggerService provides synchronous execution of datachecks on entities. - name: synq.datachecks.sqltests.v1.SqlTestsService description: SqlTestsService is a service for managing SqlTests. - name: synq.datachecks.sqltests.v1.SqlTestsDeploymentRulesService description: |- SqlTestsDeploymentRulesService manages SqlTestDeploymentRules — rules that dynamically deploy SQL test templates onto every table or view a query matches, resyncing over time as the match set changes. - name: synq.datachecks.testsuggestions.v1.TestSuggestionsService - name: synq.integrations.v1.IntegrationsService description: |- IntegrationsService manages connections from Coalesce Quality to your data systems (warehouses, databases, and transformation tools). Concurrency: every integration carries an opaque `etag`. Read it from `GetIntegration` / `ListIntegrations`, then pass it back on `UpdateIntegration` / `DeleteIntegration` to ensure you modify the version you last saw. A stale etag is rejected with ABORTED (HTTP 409). Omit the etag for last-write-wins. Quota: each workspace has a limit on the number of integrations. Creating beyond the limit is rejected with RESOURCE_EXHAUSTED. Secrets: credential fields (passwords, tokens, keys) are write-only. They are masked (returned empty) on every read. On update, omit a secret to keep it, send a new value to rotate it, or send an explicit empty string to clear it (where the field is `optional`). - name: synq.issues.issues.v1.IssuesService description: IssuesService is a service for managing Issues. - name: synq.issues.v2.IssuesService description: IssuesService is a service for managing Issues. - name: synq.dataproducts.v1.DataproductsService description: DataproductsService can be used to manage data products. - name: synq.dataproducts.v2.DataproductsService description: |- DataproductsService manages data products — named, owned groupings of data assets with a membership definition, a priority and an optional folder. Ids are opaque UUIDs supplied by the caller, which makes writes idempotent (a retried create converges instead of duplicating). Mutable fields are optional on Upsert: a field that is set is written, a field that is omitted is left unchanged. Pass the `etag` you last read to guard against overwriting a concurrent edit. A data product is a leaf in the reference graph — its definition may not reference another data product or domain — so membership resolution always terminates. - name: synq.schedule.v1.ScheduleService description: ScheduleService provides schedule evaluation utilities. - name: synq.owners.v1.OwnersService description: |- OwnersService manages owners and their ownerships — the "alert routing as code" surface. An owner is a named responsible party with notification channels (contacts); an ownership assigns a set of assets to an owner and configures the alerts routed to it. Owner is the resource, ownership its sub-resource: an ownership is meaningless without its owner, and deleting an owner deletes its ownerships. Ids are opaque UUIDs supplied by the caller, which makes writes idempotent (a retried create converges instead of duplicating). Mutable fields are optional on the Upsert calls: a set field is written, an omitted field is left unchanged. Pass the `etag` you last read to guard against overwriting a concurrent edit. Related: `synq.dataproducts.v2.DataproductsService` (an ownership can own a whole data product), `synq.alerts.v1.AlertsService` (how the configured alerts are reported), and `synq.users.v1.UsersService` (resolve the users behind `UserContact` and Slack/Teams mentions). - name: synq.agent.sre.v1.LlmService description: Service for evaluating LLM requests and producing structured output. - name: synq.agent.sre.v1.TriageService description: >- Service for managing issue triage operations, allowing LLM agents to conclude investigations and record evidence during the triage process. - name: synq.agent.sre.v1.FeatureRequestService description: >- FeatureRequestService allows MCP clients to submit feature requests when users encounter missing capabilities. This is a last-resort service — it should only be used when no existing tool can fulfill the user's request. - name: synq.agent.recon.v1.YamlService description: >- YamlService provides stateless conversion between YAML config format and proto. This is useful for UI editors that need to display/edit suite configs as YAML. - name: synq.agent.recon.v1.SuiteDeploymentService description: |- SuiteDeploymentService is the platform plane of reconciliation. SuiteConfigService is the developer/authoring sandbox (edit, version, run ad-hoc with your own credentials — preview-only, no Entity, no Run, no Issue). A deployment is what SYNQ actually runs on the workspace's behalf: a frozen snapshot of a suite config, mapped to workspace-level SYNQ integrations, optionally scheduled or triggerable by API. Identity: every deployment has a stable deployment_id (UUIDv7) assigned on first promote. It survives re-promotes, schedule/mapping changes, and pause/resume. Downstream AssetCommand / RunCommand publication keys off deployment_id so Entity identity does not fragment on promote churn. - name: synq.savedviews.v1.SavedViewsService description: >- SavedViewsService manages saved views — named, reusable selections over your entities (and other surfaces) with display configuration, sharing and per-user pinning. A saved view is owned by the user who created it. It can be kept private, shared with the whole workspace, or granted to specific users. Reads return, for the calling user, how each view relates to them (mine / shared / granted) and what they are allowed to do with it. Workspace administrators can manage any view in the workspace. - name: synq.auth.iam.v1.IamService - name: synq.platforms.v1.PlatformsService description: PlatformsService is a service for managing Platforms and Integrations. - name: synq.incidents.v1.IncidentsService description: IncidentsService is a service for managing Incidents. - name: synq.git.commits.v1.CommitsService - name: synq.domains.v1.DomainsService description: DomainsService can be used to manage domains. - name: synq.domains.v2.DomainsService description: >- DomainsService manages data domains — named areas of ownership that group the assets, data products and sub-domains belonging to one part of the business. Ids are opaque UUIDs supplied by the caller, which makes writes idempotent (a retried create converges instead of duplicating). Mutable fields are optional on Upsert: a field that is set is written, a field that is omitted is left unchanged. Pass the `etag` you last read to guard against overwriting a concurrent edit. A domain may contain other domains and data products, so membership resolution is recursive. Every write that adds such a reference — including a change of `parent_id` — is rejected if it would close a loop, so a definition can always be resolved in finite time. - name: synq.domains.members.v1.DomainMembersService description: DomainMembersService can be used to manage domain memberships. - name: synq.extensions.atlan.integrations.v1.AtlanIntegrationService - name: synq.extensions.atlan.workflows.v1.AtlanWorkflowService - name: synq.extensions.atlan.provider.v1.AtlanProviderService paths: /api/entities/annotations/v1/batchGet: post: tags: - synq.entities.annotations.v1.AnnotationsService summary: BatchGetEntityAnnotations description: |- Read the annotations carried by specific entities. ListAnnotations answers what the workspace annotates by and how often; this answers what one entity carries. They are separate reads because an entity's annotations are not part of the entity: `synq.entities.v1.Entity` is the shape `synq.entities.custom.v1.UpsertEntity` accepts, so the `annotations` field on it is what a producer ASSERTS about an entity, and answering a read with it would make a read-edit-write round trip write one entity's annotations onto another. operationId: >- synq.entities.annotations.v1.AnnotationsService.BatchGetEntityAnnotations requestBody: content: application/json: schema: $ref: >- #/components/schemas/synq.entities.annotations.v1.BatchGetEntityAnnotationsRequest required: true responses: '200': description: Success content: application/json: schema: $ref: >- #/components/schemas/synq.entities.annotations.v1.BatchGetEntityAnnotationsResponse components: schemas: synq.entities.annotations.v1.BatchGetEntityAnnotationsRequest: type: object properties: ids: type: array items: $ref: '#/components/schemas/synq.entities.v1.Identifier' maxItems: 1000 minItems: 1 description: |- The entities to read annotations for. Each entry is validated by Identifier's own rules — its `id` oneof is `required`, and protovalidate recurses into the elements of a repeated message field — so an identifier naming nothing is refused here. There is no per-item `required` to add beside it: `repeated.items.required` is unenforceable and buf lint rejects it, and it would have nothing to catch, because an entry on the wire is always a message rather than a null. title: BatchGetEntityAnnotationsRequest additionalProperties: false description: |- BatchGetEntityAnnotationsRequest is the request message for the BatchGetEntityAnnotations method. synq.entities.annotations.v1.BatchGetEntityAnnotationsResponse: type: object properties: entityAnnotations: type: array items: $ref: >- #/components/schemas/synq.entities.annotations.v1.EntityAnnotations description: >- One entry per requested entity that carries any annotation. An entity with none is omitted rather than returned empty, so the response says which of the requested entities are annotated at all. title: BatchGetEntityAnnotationsResponse additionalProperties: false description: |- BatchGetEntityAnnotationsResponse is the response message for the BatchGetEntityAnnotations method. synq.entities.v1.Identifier: type: object allOf: - properties: entityId: type: string title: entity_id maxLength: 1024 description: >- Opaque id of the entity, set on every identifier the API returns. Round-trip it verbatim; the format is not part of this contract and may change, and it is never constructed by hand. OUTPUT ONLY. On a request this field is ignored — the structured variant is what resolves. That is what lets you hand an identifier straight back unchanged, or edit its structured fields, without the two disagreeing about which entity you meant. To name an entity BY opaque id on a request, set the `synq_path` variant to that id: it carries exactly this string, and it is also how an entity whose platform has no structured variant is named. - oneOf: - properties: airflowDag: $ref: '#/components/schemas/synq.entities.v1.AirflowDagIdentifier' title: airflow_dag description: Airflow DAG identifier title: airflow_dag required: - airflowDag - properties: airflowTask: $ref: '#/components/schemas/synq.entities.v1.AirflowTaskIdentifier' title: airflow_task description: Airflow task identifier within a given DAG title: airflow_task required: - airflowTask - properties: athenaTable: $ref: '#/components/schemas/synq.entities.v1.AthenaTableIdentifier' title: athena_table description: Amazon Athena (Glue) table identifier title: athena_table required: - athenaTable - properties: bigqueryTable: $ref: >- #/components/schemas/synq.entities.v1.BigqueryTableIdentifier title: bigquery_table description: BigQuery table identifier title: bigquery_table required: - bigqueryTable - properties: clickhouseTable: $ref: >- #/components/schemas/synq.entities.v1.ClickhouseTableIdentifier title: clickhouse_table description: Clickhouse table identifier title: clickhouse_table required: - clickhouseTable - properties: custom: $ref: '#/components/schemas/synq.entities.v1.CustomIdentifier' title: custom description: >- Custom identifier to be used with all custom created entities title: custom required: - custom - properties: databricksTable: $ref: >- #/components/schemas/synq.entities.v1.DatabricksTableIdentifier title: databricks_table description: Databricks table identifier title: databricks_table required: - databricksTable - properties: dataproduct: $ref: '#/components/schemas/synq.entities.v1.DataproductIdentifier' title: dataproduct description: Dataproduct identifier title: dataproduct required: - dataproduct - properties: dbtCloudNode: $ref: '#/components/schemas/synq.entities.v1.DbtCloudNodeIdentifier' title: dbt_cloud_node description: >- Dbt node that identifies one of dbt DAG nodes (model, test, etc) in dbt Cloud project title: dbt_cloud_node required: - dbtCloudNode - properties: dbtCoreNode: $ref: '#/components/schemas/synq.entities.v1.DbtCoreNodeIdentifier' title: dbt_core_node description: >- Dbt node that identifies one of dbt DAG nodes (model, test, etc) in dbt Core project title: dbt_core_node required: - dbtCoreNode - properties: fabricTable: $ref: '#/components/schemas/synq.entities.v1.FabricTableIdentifier' title: fabric_table description: Microsoft Fabric table identifier title: fabric_table required: - fabricTable - properties: monitor: $ref: '#/components/schemas/synq.entities.v1.MonitorIdentifier' title: monitor description: Monitor identifier title: monitor required: - monitor - properties: mssqlTable: $ref: '#/components/schemas/synq.entities.v1.MssqlTableIdentifier' title: mssql_table description: SQL Server table identifier title: mssql_table required: - mssqlTable - properties: mysqlTable: $ref: '#/components/schemas/synq.entities.v1.MysqlTableIdentifier' title: mysql_table description: Mysql table identifier title: mysql_table required: - mysqlTable - properties: oracleTable: $ref: '#/components/schemas/synq.entities.v1.OracleTableIdentifier' title: oracle_table description: Oracle table identifier title: oracle_table required: - oracleTable - properties: postgresTable: $ref: >- #/components/schemas/synq.entities.v1.PostgresTableIdentifier title: postgres_table description: Postgres table identifier title: postgres_table required: - postgresTable - properties: redshiftTable: $ref: >- #/components/schemas/synq.entities.v1.RedshiftTableIdentifier title: redshift_table description: Redshift table identifier title: redshift_table required: - redshiftTable - properties: savedView: $ref: '#/components/schemas/synq.entities.v1.SavedViewIdentifier' title: saved_view description: Saved view identifier title: saved_view required: - savedView - properties: snowflakeTable: $ref: >- #/components/schemas/synq.entities.v1.SnowflakeTableIdentifier title: snowflake_table description: Snowflake table identifier title: snowflake_table required: - snowflakeTable - properties: sqlMeshAudit: $ref: '#/components/schemas/synq.entities.v1.SqlMeshAuditIdentifier' title: sql_mesh_audit description: SQLMesh Audit identifier title: sql_mesh_audit required: - sqlMeshAudit - properties: sqlMeshModel: $ref: '#/components/schemas/synq.entities.v1.SqlMeshModelIdentifier' title: sql_mesh_model description: SQLMesh Model identifier title: sql_mesh_model required: - sqlMeshModel - properties: synqPath: $ref: '#/components/schemas/synq.entities.v1.SynqPathIdentifier' title: synq_path description: SynqPath identifier title: synq_path required: - synqPath - properties: trinoTable: $ref: '#/components/schemas/synq.entities.v1.TrinoTableIdentifier' title: trino_table description: Trino table identifier title: trino_table required: - trinoTable title: Identifier additionalProperties: false description: >- Identifier is a unique reference to an entity in Coalesce Quality 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. Every identifier the API RETURNS also carries `entity_id`, the entity's opaque id. Read it when you just need to name the entity again — it is one string for every platform, where the structured variants below only cover the platforms that have one. synq.entities.annotations.v1.EntityAnnotations: type: object properties: id: $ref: '#/components/schemas/synq.entities.v1.Identifier' description: The entity, echoed back in the spelling it was requested in. annotations: type: array items: $ref: '#/components/schemas/synq.entities.v1.Annotation' description: |- Annotations the entity carries, one entry per name, ordered by name. Read over the entity's whole identity group rather than the one id asked for: a dbt model, the warehouse table it builds and a catalog entity virtualising the same table are one entity to a reader, and which of them an annotation was published against is a property of the producer, not of the thing being annotated. title: EntityAnnotations additionalProperties: false description: EntityAnnotations is the annotations one entity carries. synq.entities.v1.AirflowDagIdentifier: type: object properties: integrationId: type: string description: Coalesce Quality integration_id that identifies the Airflow instance dagId: type: string description: Airflow dag_id that identifies the DAG title: AirflowDagIdentifier required: - integrationId - dagId additionalProperties: false synq.entities.v1.AirflowTaskIdentifier: type: object properties: integrationId: type: string description: Coalesce Quality integration_id that identifies the Airflow instance dagId: type: string description: Airflow dag_id that identifies the DAG taskId: type: string description: Airflow task_id that identifies the task within the DAG title: AirflowTaskIdentifier required: - integrationId - dagId - taskId additionalProperties: false synq.entities.v1.AthenaTableIdentifier: type: object properties: instance: type: string description: |- AWS account and region the Athena workgroup runs in, formatted as "." (e.g. "123456789012.eu-west-1"). Auto-derived from sts:GetCallerIdentity at integration setup time. catalog: type: string description: |- Glue Data Catalog name. Almost always "AwsDataCatalog" — the default catalog for Athena unless the customer registered a federated catalog. database: type: string description: Glue database (the namespace users typically filter on). table: type: string description: Glue table or view name. title: AthenaTableIdentifier required: - instance - catalog - database - table additionalProperties: false synq.entities.v1.BigqueryTableIdentifier: type: object properties: project: type: string description: BigQuery project dataset: type: string description: BigQuery dataset id table: type: string description: BigQuery table name title: BigqueryTableIdentifier required: - project - dataset - table additionalProperties: false synq.entities.v1.ClickhouseTableIdentifier: type: object properties: host: type: string description: Clickhouse hostname without port schema: type: string description: Clickhouse database table: type: string description: Clickhouse table title: ClickhouseTableIdentifier required: - host - schema - table additionalProperties: false synq.entities.v1.CustomIdentifier: type: object properties: id: type: string description: |- Id that identifies the custom entity The Id should be unique within the custom entity Identifier. title: CustomIdentifier required: - id additionalProperties: false synq.entities.v1.DatabricksTableIdentifier: type: object properties: workspace: type: string description: URL of Databricks workspace catalog: type: string description: Databricks catalog schema: type: string description: Databricks schema table: type: string description: Databricks table or view title: DatabricksTableIdentifier required: - workspace - catalog - schema - table additionalProperties: false synq.entities.v1.DataproductIdentifier: type: object properties: id: type: string format: uuid description: Dataproduct id that identifies the Dataproduct title: DataproductIdentifier required: - id additionalProperties: false synq.entities.v1.DbtCloudNodeIdentifier: type: object properties: projectId: type: string description: Your dbt Cloud project id accountId: type: string description: Your dbt Cloud account id nodeId: type: string description: Dbt node_id that identifies one of dbt DAG nodes (model, test, etc) title: DbtCloudNodeIdentifier required: - projectId - nodeId additionalProperties: false synq.entities.v1.DbtCoreNodeIdentifier: type: object properties: integrationId: type: string description: >- Opaque identifier of the dbt Core project. Usually the Coalesce Quality integration id (a UUID), but may also be the dbt project name from manifest.json when the integration is configured to identify assets by project name. Treat it as an opaque string, not a UUID. nodeId: type: string description: Dbt node_id that identifies one of dbt DAG nodes (model, test, etc) title: DbtCoreNodeIdentifier required: - integrationId - nodeId additionalProperties: false synq.entities.v1.FabricTableIdentifier: type: object properties: instance: type: string description: |- Workspace SQL analytics endpoint host, e.g. ".datawarehouse.fabric.microsoft.com". database: type: string description: Fabric warehouse / lakehouse (database). schema: type: string description: Schema within the database. table: type: string description: Table or view name. workspaceId: type: string description: |- Fabric workspace GUID, decoded from the endpoint host in `instance`. Optional and informational: the table is addressed by instance/database/schema/table, so leave it empty if you don't have it — it does not affect how the identifier resolves. tenantId: type: string description: >- Entra (Azure AD) tenant GUID, decoded from the endpoint host in `instance`. Optional and informational, like workspace_id. title: FabricTableIdentifier required: - instance - database - schema - table additionalProperties: false description: |- Microsoft Fabric warehouse/lakehouse table identifier. Fabric is workspace-scoped with cross-database three-part [database].[schema].[table] T-SQL names. synq.entities.v1.MonitorIdentifier: type: object properties: monitoredId: $ref: '#/components/schemas/synq.entities.v1.Identifier' description: Identifier of the monitored entity monitorId: type: string description: Identifier of the monitor segment: type: string description: Optional monitor segmentation identifier nullable: true integrationId: type: string description: Coalesce Quality integration_id of the monitored identifier nullable: true deprecated: true title: MonitorIdentifier required: - monitoredId - monitorId additionalProperties: false synq.entities.v1.MssqlTableIdentifier: type: object properties: host: type: string description: Hostname of the SQL Server instance database: type: string description: SQL Server database schema: type: string description: SQL Server schema (e.g. "dbo") table: type: string description: SQL Server table or view title: MssqlTableIdentifier required: - host - database - schema - table additionalProperties: false synq.entities.v1.MysqlTableIdentifier: type: object properties: host: type: string description: Mysql hostname without port schema: type: string description: Mysql database table: type: string description: Mysql table title: MysqlTableIdentifier required: - host - schema - table additionalProperties: false synq.entities.v1.OracleTableIdentifier: type: object properties: host: type: string description: Hostname of the Oracle instance serviceName: type: string description: Oracle service name (PDB) schema: type: string description: Oracle schema (= owning user) table: type: string description: Oracle table or view title: OracleTableIdentifier required: - host - serviceName - schema - table additionalProperties: false synq.entities.v1.PostgresTableIdentifier: type: object properties: host: type: string description: Postgres hostname without port database: type: string description: Postgres database schema: type: string description: Postgres schema table: type: string description: Postgres table title: PostgresTableIdentifier required: - host - database - schema - table additionalProperties: false synq.entities.v1.RedshiftTableIdentifier: type: object properties: cluster: type: string description: Redshift cluster database: type: string description: Redshift database schema: type: string description: Redshift schema table: type: string description: Redshift table title: RedshiftTableIdentifier required: - database - schema - table additionalProperties: false synq.entities.v1.SavedViewIdentifier: type: object properties: id: type: string format: uuid description: Saved view id (client-supplied UUID) that identifies the saved view title: SavedViewIdentifier required: - id additionalProperties: false synq.entities.v1.SnowflakeTableIdentifier: type: object properties: account: type: string description: Snowflake account database: type: string description: Snowflake database schema: type: string description: Snowflake schema table: type: string description: Snowflake table title: SnowflakeTableIdentifier required: - account - database - schema - table additionalProperties: false synq.entities.v1.SqlMeshAuditIdentifier: type: object properties: integrationId: type: string format: uuid description: Coalesce Quality integration_id that identifies the dbt Core project fqn: type: string description: SQLMesh model fully qualified name auditId: type: string description: Identifier of the audit title: SqlMeshAuditIdentifier required: - integrationId - fqn - auditId additionalProperties: false synq.entities.v1.SqlMeshModelIdentifier: type: object properties: integrationId: type: string format: uuid description: Coalesce Quality integration_id that identifies the dbt Core project fqn: type: string description: SQLMesh model fully qualified name title: SqlMeshModelIdentifier required: - integrationId - fqn additionalProperties: false synq.entities.v1.SynqPathIdentifier: type: object properties: path: type: string description: >- Coalesce Quality path that identifies the Coalesce Quality entity, needs to be one of supported paths title: SynqPathIdentifier required: - path additionalProperties: false synq.entities.v1.TrinoTableIdentifier: type: object properties: host: type: string description: Hostname of the Trino instance catalog: type: string description: Trino catalog schema: type: string description: Trino schema table: type: string description: Trino table or view title: TrinoTableIdentifier required: - host - catalog - schema - table additionalProperties: false synq.entities.v1.Annotation: type: object properties: name: type: string maxLength: 50 minLength: 1 description: String key for the annotation. values: type: array items: type: string maxLength: 100 minLength: 1 maxItems: 20 maxItems: 20 description: |- Optional list of values that the annotation can carry. A value is something entities are filtered and searched by, not free-form metadata, so keep it to a label a person would pick out of a list. The limit is set to hold an identifier or a link the annotated system generated — truncating one of those produces a value that no longer resolves, and no longer matches the filter it exists for. Put prose in the entity description instead. title: Annotation required: - name additionalProperties: false description: |- Annotations can be used to annotate any entity with a key:value pair. These annotations can be used for filtering and searching entities. securitySchemes: bearerAuth: type: http scheme: bearer ````