v3

latestSwagger 2.02026-07-139789260.9 KB

Bulk API to retrieve list of entities identified by its unique attributes. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format

typeName=<typeName>&attr_1:<attrName>=<attrValue>&attr_2:<attrName>=<attrValue>&attr_3:<attrName>=<attrValue>

NOTE: The attrName should be an unique attribute for the given entity-type. The REST request would look something like this

GET /v2/entity/bulk/uniqueAttribute/type/hive_db?attr_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1

Note: at least one unique attribute must be provided.

get/atlas/v2/entity/bulk/uniqueAttribute/type/{typeName}

Path parameters

typeNamestring required

The name of the type.

Query parameters

minExtInfoboolean

Whether to return minimal information for referred entities.

ignoreRelationshipsboolean

Whether to ignore relationship attributes.

attr_N:qualifiedNamestring

Qualified name of an entity. E.g. to find 2 entities you can set attrs_1:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. (This is only an example. qualifiedName can be changed to other unique attributes)

Response

The request has succeeded.

referredEntitiesobject

The referred entities.