Entity - Get By Unique Attributes
Obtenga una definición completa de una entidad dada su tipo y atributo único.
Además del parámetro de ruta de acceso typeName, se pueden proporcionar pares clave-valor de atributo en el siguiente formato: attr:<attrName>=.
NOTA: AttrName y attrValue deben ser únicos entre entidades, por ejemplo. qualifiedName.
La solicitud REST tendría un aspecto similar al siguiente: GET /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
GET {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/{typeName}
GET {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/{typeName}?minExtInfo={minExtInfo}&ignoreRelationships={ignoreRelationships}&attr:qualifiedName={attr:qualifiedName}
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
|
type
|
path | True |
string |
Nombre del tipo. |
attr:qualified
|
query |
string |
Nombre completo de la entidad. (Este es solo un ejemplo. qualifiedName se puede cambiar a otros atributos únicos). |
|
ignore
|
query |
boolean |
Si se omiten los atributos de relación. |
|
min
|
query |
boolean |
Si se devuelve información mínima para las entidades a las que se hace referencia. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
La solicitud se ha realizado correctamente. |
|
Other Status Codes |
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_GetByUniqueAttributes
Solicitud de ejemplo
GET {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/azure_storage_account?minExtInfo=True&attr:qualifiedName=https://exampleaccount.core.windows.net
Respuesta de muestra
{
"entity": {
"createTime": 1605703532110,
"createdBy": "8c062c84-5d25-449f-a990-9d8ab70b8ec7",
"guid": "e0ba3f20-f3b5-4d52-b769-ed35a02df60a",
"relationshipAttributes": {
"services": [],
"meanings": []
},
"status": "ACTIVE",
"updateTime": 1605703532110,
"updatedBy": "8c062c84-5d25-449f-a990-9d8ab70b8ec7",
"lastModifiedTS": "2",
"version": 0,
"attributes": {
"owner": "ExampleOwner",
"qualifiedName": "https://exampleaccount.core.windows.net",
"createTime": 0,
"name": "ExampleNewName"
},
"typeName": "azure_storage_account"
},
"referredEntities": {}
}
Definiciones
Nombre | Description |
---|---|
Atlas |
Instancia de una clasificación; no tiene una identidad, este objeto solo existe cuando está asociado a una entidad. |
Atlas |
Una instancia de una entidad, como hive_table, hive_database. |
Atlas |
Una instancia de una entidad junto con información extendida, como hive_table, hive_database. |
Atlas |
Respuesta de error del servicio |
Atlas |
Encabezado para la asignación de términos. |
Atlas |
Estado de la asignación de términos |
Entity |
Estado: puede estar activo o eliminado. |
Time |
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 |
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 |
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 |
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 |
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 |
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 |
Una instancia de una entidad, como hive_table, hive_database. |
|
referredEntities |
<string,
Atlas |
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 |
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. |