Glossary - Assign Term To Entities

Referencia

Servicio:: Purview

Versión de la API:: 2023-09-01

Asigne el término especificado a la lista proporcionada de objetos relacionados. Se recomienda usar lotes pequeños con varias llamadas API.

La operación De creación o actualización de entidades es una alternativa a asignar un término a varias entidades.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string
termId	path	True	string	Identificador único global del término del glosario.

Cuerpo de la solicitud

Nombre	Tipo	Description
body	AtlasRelatedObjectId[]	Matriz de identificadores de objeto relacionados a los que se debe asociar el término.

Respuestas

Nombre	Tipo	Description
204 No Content		No hay contenido que enviar para esta solicitud, pero los encabezados pueden ser útiles.
Other Status Codes	AtlasErrorResponse	Respuesta de error inesperada.

Seguridad

OAuth2Auth

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
https://purview.azure.net/.default

Ejemplos

Glossary_AssignTermToEntities

Solicitud de ejemplo

HTTP

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"
      }
    }
  }
]

Respuesta de muestra

status code:: 204

Definiciones

Nombre	Description
AtlasErrorResponse	Respuesta de error del servicio
AtlasRelatedObjectId	Referencia a una instancia de objeto del tipo AtlasEntity usado en los valores de atributo de relación
AtlasStruct	Captura los detalles del contenido de la estructura. No se crea una instancia directamente, solo se usa a través de AtlasEntity, AtlasClassification.
EntityStatus	Estado: puede estar activo o eliminado.
StatusAtlasRelationship	Estado de la relación atlas

AtlasErrorResponse

Respuesta de error del servicio

Nombre	Tipo	Description
errorCode	string	Código de error.
errorMessage	string	El mensaje de error.
requestId	string	El identificador de solicitud.

AtlasRelatedObjectId

Referencia a una instancia de objeto del tipo AtlasEntity usado en los valores de atributo de relación

Nombre	Tipo	Description
displayText	string	Texto que se muestra.
entityStatus	EntityStatus	Estado de la entidad: puede estar activo o eliminado. No se quitan las entidades eliminadas.
guid	string	GUID del objeto .
relationshipAttributes	AtlasStruct	Captura los detalles del contenido de la estructura. No se crea una instancia directamente, solo se usa a través de AtlasEntity, AtlasClassification.
relationshipGuid	string	GUID de la relación.
relationshipStatus	StatusAtlasRelationship	Enumeración del estado de la relación.
relationshipType	string	Tipo de relación
typeName	string	Nombre del tipo.
uniqueAttributes		Atributos únicos del objeto .

AtlasStruct

Captura los detalles del contenido de la estructura. No se crea una instancia directamente, solo se usa a través de AtlasEntity, AtlasClassification.

Nombre	Tipo	Description
attributes		Atributos de la estructura.
lastModifiedTS	string	ETag para el control de simultaneidad.
typeName	string	Nombre del tipo.

EntityStatus

Estado: puede estar activo o eliminado.

Nombre	Tipo	Description
ACTIVE	string	El estado está activo.
DELETED	string	El estado se elimina.

StatusAtlasRelationship

Estado de la relación atlas

Nombre	Tipo	Description
ACTIVE	string	active
DELETED	string	deleted

Compartir a través de