v3

latestSwagger 2.02026-07-139789260.9 KB

Get complete definition of an entity given its type and unique attribute.

In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:<attrName>=<attrValue>.

NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName.

The REST request would look something like this: GET /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.

get/atlas/v2/entity/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:qualifiedNamestring

The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)

Response

The request has succeeded.

referredEntitiesobject

The referred entities.