Entity - Get

Referencia

Servicio:: Purview

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

Obtenga la definición completa de una entidad según su GUID.

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

Con parámetros opcionales:

GET {endpoint}/datamap/api/atlas/v2/entity/guid/{guid}?minExtInfo={minExtInfo}&ignoreRelationships={ignoreRelationships}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string
guid	path	True	string	Identificador único global de la entidad.
ignoreRelationships	query		boolean	Si se omiten los atributos de relación.
minExtInfo	query		boolean	Si se devuelve información mínima para las entidades a las que se hace referencia.

Respuestas

Nombre	Tipo	Description
200 OK	AtlasEntityWithExtInfo	La solicitud se ha realizado correctamente.
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

Entity_Get

Solicitud de ejemplo

HTTP

GET {endpoint}/datamap/api/atlas/v2/entity/guid/5cf8a9e5-c9fd-abe0-2e8c-d40024263dcb?minExtInfo=True

Respuesta de muestra

status code:: 200

{
  "referredEntities": {},
  "entity": {
    "typeName": "column",
    "attributes": {
      "owner": null,
      "qualifiedName": "adl://exampleaccount.azuredatalakestore.net/123/1/DP_TFS/CBT/Extensions/DTTP.targets#:xml/Project/Target/XmlPeek/@XmlInputPath",
      "name": "~XmlInputPath",
      "description": null,
      "type": "string"
    },
    "guid": "5cf8a9e5-c9fd-abe0-2e8c-d40024263dcb",
    "status": "ACTIVE",
    "createdBy": "ExampleCreator",
    "updatedBy": "ExampleUpdator",
    "createTime": 1553072455110,
    "updateTime": 1553072455110,
    "version": 0,
    "relationshipAttributes": {
      "schema": [],
      "inputToProcesses": [],
      "composeSchema": {
        "guid": "cc6652ae-dc6d-90c9-1899-252eabc0e929",
        "typeName": "tabular_schema",
        "displayText": "tabular_schema",
        "relationshipGuid": "5a4510d4-57d0-467c-888f-4b61df42702b",
        "relationshipStatus": "ACTIVE",
        "relationshipAttributes": {
          "typeName": "tabular_schema_columns"
        }
      },
      "meanings": [],
      "outputFromProcesses": [],
      "tabular_schema": null
    },
    "contacts": {
      "Expert": [
        {
          "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
          "info": "Example Expert Info"
        }
      ],
      "Owner": [
        {
          "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
          "info": "Example Owner Info"
        }
      ]
    }
  }
}

Definiciones

Nombre	Description
AtlasClassification	Instancia de una clasificación; no tiene una identidad, este objeto solo existe cuando está asociado a una entidad.
AtlasEntity	Una instancia de una entidad, como hive_table, hive_database.
AtlasEntityWithExtInfo	Una instancia de una entidad junto con información extendida, 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: puede estar activo o eliminado.
TimeBoundary	Captura los detalles del límite de tiempo

AtlasClassification

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: puede estar activo o eliminado. No se quitan las entidades eliminadas.
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.

AtlasEntity

Una instancia de una entidad, como hive_table, hive_database.

Nombre	Tipo	Description
attributes		Atributos de la estructura.
businessAttributes		Atributos empresariales
classifications	AtlasClassification[]	Matriz de clasificaciones.
collectionId	string	Identificador de colección de la entidad.
contacts	object	Diccionario de contactos para entidades. La clave podría ser experto o propietario.
createTime	integer	Hora de creación del registro.
createdBy	string	El usuario que creó el registro.
customAttributes	object	Atributo personalizado
guid	string	GUID de la entidad.
homeId	string	Identificador de inicio de la entidad.
isIncomplete	boolean	Si es una entidad de shell
labels	string[]	labels
lastModifiedTS	string	ETag para el control de simultaneidad.
meanings	AtlasTermAssignmentHeader[]	Matriz de encabezados de asignación de términos que indican los significados de la entidad.
provenanceType	integer	Se usa para registrar la procedencia de una instancia de una entidad o relación.
proxy	boolean	Determina si hay un proxy.
relationshipAttributes		Atributos de la relación.
status	EntityStatus	Estado de la entidad: puede estar activo o eliminado. No se quitan las entidades eliminadas.
typeName	string	Nombre del tipo.
updateTime	integer	Hora de actualización del registro.
updatedBy	string	El usuario que actualizó el registro.
version	integer	Versión de la entidad.

AtlasEntityWithExtInfo

Una instancia de una entidad junto con información extendida, como hive_table, hive_database.

Nombre	Tipo	Description
entity	AtlasEntity	Una instancia de una entidad, como hive_table, hive_database.
referredEntities	<string, AtlasEntity>	Entidades a las que se hace referencia.

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.

AtlasTermAssignmentHeader

Encabezado para la asignación de términos.

Nombre	Tipo	Description
confidence	integer	Confianza de la asignación de términos.
createdBy	string	El usuario que creó el registro.
description	string	Descripción de la asignación de términos.
displayText	string	Texto que se muestra.
expression	string	Expresión de la asignación de términos.
relationGuid	string	GUID de la relación.
status	AtlasTermAssignmentStatus	Estado de la asignación de términos.
steward	string	Administrador del término.
termGuid	string	GUID del término.

AtlasTermAssignmentStatus

Estado de la asignación de términos

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

EntityStatus

Estado: puede estar activo o eliminado.

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

TimeBoundary

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 tiempo.
timeZone	string	Zona horaria del límite de tiempo.

Compartir a través de