Share via

Glossary - Delete Term Assignment From Entities

Service:
Purview
API Version:
2023-09-01

Delete the term assignment for the given list of related objects.

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

URI Parameters

Name In Required Type Description
endpoint
 path True

string (uri)

termId
 path True

string

The globally unique identifier for glossary term.

Request Body

Name Type Description
body

AtlasRelatedObjectId[]

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

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_RemoveTermAssignmentFromEntities

Sample request

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

[
  {
    "guid": "16feb2a1-2c79-ade1-338d-fb24fcb8b8bd",
    "relationshipGuid": "624f08bb-3c93-4f03-9ce1-ed2ce2c7c8d5"
  }
]

Sample response

Status code:
204

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

Object

An error response from the service

Name Type Description
errorCode

string

The error code.
errorMessage

string

The error message.
requestId

string (uuid)

The request ID.

AtlasRelatedObjectId

Object

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 (uuid)

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

Object

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

Enumeration

Status - can be active or deleted

Value Description
ACTIVE

The status is active.
DELETED

The status is deleted.

StatusAtlasRelationship

Enumeration

Status for atlas relationship

Value Description
ACTIVE

active
DELETED

deleted