Glossary - Assign Term To Entities

Assign the given term to the provided list of related objects. Recommend using small batches with multiple API calls.

Entities Create Or Update operation is an alternative to assign a term to multiple entities.

POST {endpoint}/datamap/api/atlas/v2/glossary/terms/{termId}/assignedEntities

URI Parameters

Name In Required Type Description
endpoint
path True

string

termId
path True

string

The globally unique identifier for glossary term.

Request Body

Name Type Description
body

AtlasRelatedObjectId[]

An array of related object IDs to which the term has to be associated.

Responses

Name Type Description
204 No Content

There is no content to send for this request, but the headers may be useful.

Other Status Codes

AtlasErrorResponse

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_AssignTermToEntities

Sample request

POST {endpoint}/datamap/api/atlas/v2/glossary/terms/8a7f65ec-6429-0b9b-3734-ec57bf1e34c2/assignedEntities

[
  {
    "guid": "ab9f1920-0b94-436d-aeb4-11a32c270fc0",
    "relationshipAttributes": {
      "attributes": {
        "expression": "Example Expression",
        "confidence": 100,
        "description": "Example Description",
        "source": "ExampleSource"
      }
    }
  }
]

Sample response

Definitions

Name Description
AtlasErrorResponse

An error response from the service

AtlasRelatedObjectId

Reference to an object-instance of AtlasEntity type used in relationship attribute values

AtlasStruct

Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.

EntityStatus

Status - can be active or deleted

StatusAtlasRelationship

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

EntityStatus

Status of the entity - can be active or deleted. Deleted entities are not removed.

guid

string

The GUID of the object.

relationshipAttributes

AtlasStruct

Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.

relationshipGuid

string

The GUID of the relationship.

relationshipStatus

StatusAtlasRelationship

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