Glossary - List Entities Assigned With Term
List all related objects assigned with the specified term. Recommend using limit/offset to get pagination result.
GET {endpoint}/datamap/api/atlas/v2/glossary/terms/{termId}/assignedEntities
GET {endpoint}/datamap/api/atlas/v2/glossary/terms/{termId}/assignedEntities?limit={limit}&offset={offset}&sort={sort}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
|
term
|
path | True |
string |
The globally unique identifier for glossary term. |
limit
|
query |
integer int32 |
The page size - by default there is no paging. |
|
offset
|
query |
integer int32 |
The offset for pagination purpose. |
|
sort
|
query |
string |
The sort order, ASC (default) or DESC. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
The request has succeeded. |
|
Other Status Codes |
An unexpected error response. |
Security
OAuth2Auth
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
https://purview.azure.net/.default |
Examples
Glossary_ListEntitiesAssignedWithTerm
Sample request
GET {endpoint}/datamap/api/atlas/v2/glossary/terms/daf0ba4d-bc9a-4536-8a88-4b58e39dd3d4/assignedEntities?limit=-1&offset=0&sort=ASC
Sample response
[
{
"guid": "ea116881-222e-41c8-8acb-9af6f6f60009",
"typeName": "column",
"entityStatus": "ACTIVE",
"displayText": "ExampleColumnName",
"relationshipType": "AtlasGlossarySemanticAssignment",
"relationshipGuid": "ff9023a5-8495-49d6-bf04-a22c3634151e",
"relationshipStatus": "ACTIVE",
"relationshipAttributes": {
"typeName": "AtlasGlossarySemanticAssignment",
"attributes": {
"expression": null,
"createdBy": null,
"steward": null,
"confidence": null,
"description": null,
"source": null,
"status": null
}
}
},
{
"guid": "fbf0a84d-7080-456b-b889-b5ba42186c2e",
"typeName": "azure_blob_path",
"entityStatus": "ACTIVE",
"displayText": "exampledata.csv",
"relationshipType": "AtlasGlossarySemanticAssignment",
"relationshipGuid": "dedc1294-a893-4e52-ba27-6be9b8694748",
"relationshipStatus": "ACTIVE",
"relationshipAttributes": {
"typeName": "AtlasGlossarySemanticAssignment",
"attributes": {
"expression": null,
"createdBy": null,
"steward": null,
"confidence": null,
"description": null,
"source": null,
"status": null
}
}
}
]
Definitions
Name | Description |
---|---|
Atlas |
An error response from the service |
Atlas |
Reference to an object-instance of AtlasEntity type used in relationship attribute values |
Atlas |
Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. |
Entity |
Status - can be active or deleted |
Status |
Status for atlas relationship |
AtlasErrorResponse
An error response from the service
Name | Type | Description |
---|---|---|
errorCode |
string |
The error code. |
errorMessage |
string |
The error message. |
requestId |
string |
The request ID. |
AtlasRelatedObjectId
Reference to an object-instance of AtlasEntity type used in relationship attribute values
Name | Type | Description |
---|---|---|
displayText |
string |
The display text. |
entityStatus |
Status of the entity - can be active or deleted. Deleted entities are not removed. |
|
guid |
string |
The GUID of the object. |
relationshipAttributes |
Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. |
|
relationshipGuid |
string |
The GUID of the relationship. |
relationshipStatus |
The enum of relationship status. |
|
relationshipType |
string |
Relationship type |
typeName |
string |
The name of the type. |
uniqueAttributes |
|
The unique attributes of the object. |
AtlasStruct
Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.
Name | Type | Description |
---|---|---|
attributes |
|
The attributes of the struct. |
lastModifiedTS |
string |
ETag for concurrency control. |
typeName |
string |
The name of the type. |
EntityStatus
Status - can be active or deleted
Name | Type | Description |
---|---|---|
ACTIVE |
string |
The status is active. |
DELETED |
string |
The status is deleted. |
StatusAtlasRelationship
Status for atlas relationship
Name | Type | Description |
---|---|---|
ACTIVE |
string |
active |
DELETED |
string |
deleted |