Compartir a través de

Relationship - Get

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

Obtiene información de relación entre entidades por su GUID.

GET {endpoint}/datamap/api/atlas/v2/relationship/guid/{guid}
Con parámetros opcionales: 
GET {endpoint}/datamap/api/atlas/v2/relationship/guid/{guid}?extendedInfo={extendedInfo}

Parámetros de identificador URI

Nombre En Requerido Tipo Description
endpoint
 path True

string (uri)

guid
 path True

string

Identificador único global de la relación.
extendedInfo
 query

boolean

Limita si incluye información extendida.

Respuestas

Nombre Tipo Description
200 OK

AtlasRelationshipWithExtInfo

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

Relationship_Get

Solicitud de ejemplo

GET {endpoint}/datamap/api/atlas/v2/relationship/guid/5cf8a9e5-c9fd-abe0-2e8c-d40024263dcb?extendedInfo=false

Respuesta de muestra

status code:
200 
{
  "relationship": {
    "typeName": "AtlasGlossarySynonym",
    "attributes": {
      "expression": null,
      "steward": null,
      "description": null,
      "source": null,
      "status": null
    },
    "guid": "de23cd5a-021c-413d-98a5-98752a1f7a3b",
    "end1": {
      "guid": "856d31e6-e342-a1ce-6273-22ddb77029c6",
      "typeName": "AtlasGlossaryTerm"
    },
    "end2": {
      "guid": "b0942506-2d7d-1f45-d286-c29ca9e7f2ef",
      "typeName": "AtlasGlossaryTerm"
    },
    "label": "r:AtlasGlossarySynonym",
    "status": "ACTIVE",
    "createdBy": "ExampleCreator",
    "updatedBy": "ExampleUpdator",
    "createTime": 1553838993803,
    "updateTime": 1553838993803,
    "version": 0
  }
}

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
AtlasObjectId

Referencia a una instancia de objeto de un tipo, como la entidad .
AtlasRelationship

Instancia de relación atlas.
AtlasRelationshipWithExtInfo

Relación con la información extendida.
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.
StatusAtlasRelationship

Estado de la relación atlas
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.

AtlasObjectId

Object

Referencia a una instancia de objeto de un tipo, como la entidad .

Nombre Tipo Description
guid

string

GUID del objeto.
typeName

string

Nombre del tipo.
uniqueAttributes

Atributos únicos del objeto .

AtlasRelationship

Object

Instancia de relación atlas.

Nombre Tipo Description
attributes

Atributos de la estructura.
createTime

integer (int64)

Hora de creación del registro.
createdBy

string

Usuario que creó el registro.
end1

AtlasObjectId

Referencia a una instancia de objeto de un tipo, como la entidad .
end2

AtlasObjectId

Referencia a una instancia de objeto de un tipo, como la entidad .
guid

string

GUID de la relación.
homeId

string

Identificador de inicio de la relación.
label

string

Etiqueta de la relación.
lastModifiedTS

string

ETag para el control de simultaneidad.
provenanceType

integer (int32)

Se usa para registrar la procedencia de una instancia de una entidad o relación
status

StatusAtlasRelationship

Enumeración del estado de la relación.
typeName

string

Nombre del tipo.
updateTime

integer (int64)

Hora de actualización del registro.
updatedBy

string

Usuario que actualizó el registro.
version

integer (int64)

Versión de la relación.

AtlasRelationshipWithExtInfo

Object

Relación con la información extendida.

Nombre Tipo Description
referredEntities

<string,  AtlasEntityHeader>

Encabezado de entidad al que se hace referencia.
relationship

AtlasRelationship

Instancia de relación atlas.

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
DISCOVERED

El estado se detecta.
PROPOSED

Se propone el estado.
IMPORTED

El estado se importa.
VALIDATED

El estado se valida.
DEPRECATED

El estado está en desuso.
OBSOLETE

El estado está obsoleto.
OTHER

Otro estado.

EntityStatus

Enumeración

Estado: se puede activar o eliminar.

Valor Description
ACTIVE

El estado está activo.
DELETED

El estado se elimina.

StatusAtlasRelationship

Enumeración

Estado de la relación atlas

Valor Description
ACTIVE

activo
DELETED

borrado

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.