Entity - Get Header

Servicio:

Purview

Versión de la API:

2023-09-01

Obtenga el encabezado de entidad según su GUID.

GET {endpoint}/datamap/api/atlas/v2/entity/guid/{guid}/header

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string (uri)
guid	path	True	string	Identificador único global de la entidad.

Respuestas

Nombre	Tipo	Description
200 OK	AtlasEntityHeader	La solicitud se ha realizado correctamente.
Other Status Codes	AtlasErrorResponse	Una 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

Entity_GetHeader

Solicitud de ejemplo

HTTP

GET {endpoint}/datamap/api/atlas/v2/entity/guid/9fb74c11-ac48-4650-95bc-760665c5bd92/header

Respuesta de muestra

status code:

200

{
  "classificationNames": [
    "MICROSOFT.PERSONAL.EMAIL"
  ],
  "displayText": "Example Storage Account",
  "guid": "9fb74c11-ac48-4650-95bc-760665c5bd92",
  "meaningNames": [],
  "meanings": [],
  "status": "ACTIVE",
  "lastModifiedTS": "3",
  "attributes": {
    "owner": "ExampleOwner",
    "createTime": 0,
    "qualifiedName": "https://exampleaccount.core.windows.net",
    "name": "ExampleStorageAccount"
  },
  "typeName": "azure_storage_account"
}

Definiciones

Nombre	Description
AtlasClassification	Una instancia de una clasificación; no tiene una identidad, este objeto solo existe cuando está asociado a una entidad.
AtlasEntityHeader	Instancia de una entidad, como hive_table, hive_database.
AtlasErrorResponse	Respuesta de error del servicio
AtlasTermAssignmentHeader	Encabezado para la asignación de términos.
AtlasTermAssignmentStatus	Estado de la asignación de términos
EntityStatus	Estado: se puede activar o eliminar.
TimeBoundary	Captura los detalles del límite de tiempo

AtlasClassification

Object

Una instancia de una clasificación; no tiene una identidad, este objeto solo existe cuando está asociado a una entidad.

Nombre	Tipo	Description
attributes		Atributos de la estructura.
entityGuid	string	GUID de la entidad.
entityStatus	EntityStatus	Estado de la entidad: se puede activar o eliminar. Las entidades eliminadas no se quitan.
lastModifiedTS	string	ETag para el control de simultaneidad.
removePropagationsOnEntityDelete	boolean	Determina si se quitarán las propagaciones en la eliminación de entidades.
typeName	string	Nombre del tipo.
validityPeriods	TimeBoundary[]	Matriz de límites de tiempo que indica períodos de validez.

AtlasEntityHeader

Object

Instancia de una entidad, como hive_table, hive_database.

Nombre	Tipo	Description
attributes		Atributos de la estructura.
classificationNames	string[]	Matriz de nombres de clasificación.
classifications	AtlasClassification[]	Matriz de clasificaciones.
displayText	string	Texto para mostrar.
guid	string	GUID del registro.
isIncomplete	boolean	Si es una entidad de shell
labels	string[]	Etiquetas
lastModifiedTS	string	ETag para el control de simultaneidad.
meaningNames	string[]	Matriz de significados.
meanings	AtlasTermAssignmentHeader[]	Matriz de encabezados de asignación de términos.
status	EntityStatus	Estado de la entidad: se puede activar o eliminar. Las entidades eliminadas no se quitan.
typeName	string	Nombre del tipo.

AtlasErrorResponse

Object

Respuesta de error del servicio

Nombre	Tipo	Description
errorCode	string	Código de error.
errorMessage	string	Mensaje de error.
requestId	string (uuid)	Identificador de solicitud.

AtlasTermAssignmentHeader

Object

Encabezado para la asignación de términos.

Nombre	Tipo	Description
confidence	integer (int32)	Confianza de la asignación de términos.
createdBy	string	Usuario que creó el registro.
description	string	Descripción de la asignación de términos.
displayText	string	Texto para mostrar.
expression	string	Expresión de la asignación de términos.
relationGuid	string (uuid)	GUID de la relación.
status	AtlasTermAssignmentStatus	Estado de la asignación de términos.
steward	string	El administrador del término.
termGuid	string (uuid)	GUID del término.

AtlasTermAssignmentStatus

Enumeración

Estado de la asignación de términos

Valor	Description
DEPRECATED	El estado está en desuso.
DISCOVERED	El estado se detecta.
IMPORTED	El estado se importa.
OBSOLETE	El estado está obsoleto.
OTHER	Otro estado.
PROPOSED	Se propone el estado.
VALIDATED	El estado se valida.

EntityStatus

Enumeración

Estado: se puede activar o eliminar.

Valor	Description
ACTIVE	El estado está activo.
DELETED	El estado se elimina.

TimeBoundary

Object

Captura los detalles del límite de tiempo

Nombre	Tipo	Description
endTime	string	Fin del límite de tiempo.
startTime	string	Inicio del límite de hora.
timeZone	string	Zona horaria del límite horario.