Skip to main content
POST
BatchGetEntityAnnotations

Authorizations

Authorization
string
header
required

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

Body

application/json

BatchGetEntityAnnotationsRequest is the request message for the BatchGetEntityAnnotations method.

ids
Identifier · object[]

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.

Required array length: 1 - 1000 elements

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.

Response

200 - application/json

Success

BatchGetEntityAnnotationsResponse is the response message for the BatchGetEntityAnnotations method.

entityAnnotations
EntityAnnotations · object[]

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.