Compartilhar via

Relationship - Get

Serviço:
Purview
Versão da API:
2023-09-01

Obtenha informações de relação entre entidades por seu GUID.

GET {endpoint}/datamap/api/atlas/v2/relationship/guid/{guid}
Com parâmetros opcionais: 
GET {endpoint}/datamap/api/atlas/v2/relationship/guid/{guid}?extendedInfo={extendedInfo}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
endpoint
 path True

string (uri)

guid
 path True

string

O identificador global exclusivo da relação.
extendedInfo
 query

boolean

Limita se inclui informações estendidas.

Respostas

Nome Tipo Description
200 OK

AtlasRelationshipWithExtInfo

A solicitação foi bem-sucedida.
Other Status Codes

AtlasErrorResponse

Uma resposta de erro inesperada.

Segurança

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

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

Exemplos

Relationship_Get

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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
  }
}

Definições

Nome Description
AtlasClassification

Uma instância de uma classificação; ele não tem uma identidade, esse objeto existe somente quando associado a uma entidade.
AtlasEntityHeader

Uma instância de uma entidade , como hive_table, hive_database.
AtlasErrorResponse

Uma resposta de erro do serviço
AtlasObjectId

Referência a uma instância de objeto de um tipo , como a entidade.
AtlasRelationship

Instância de relacionamento do Atlas.
AtlasRelationshipWithExtInfo

A relação com informações estendidas.
AtlasTermAssignmentHeader

O cabeçalho da atribuição de termo.
AtlasTermAssignmentStatus

Status da atribuição de termos
EntityStatus

Status – pode ser ativo ou excluído
StatusAtlasRelationship

Status da relação atlas
TimeBoundary

Captura detalhes de limite de tempo

AtlasClassification

Objeto

Uma instância de uma classificação; ele não tem uma identidade, esse objeto existe somente quando associado a uma entidade.

Nome Tipo Description
attributes

Os atributos do struct.
entityGuid

string

O GUID da entidade.
entityStatus

EntityStatus

Status da entidade – pode estar ativo ou excluído. Entidades excluídas não são removidas.
lastModifiedTS

string

ETag para controle de simultaneidade.
removePropagationsOnEntityDelete

boolean

Determina se as propagações serão removidas na exclusão da entidade.
typeName

string

O nome do tipo.
validityPeriods

TimeBoundary[]

Uma matriz de limites de tempo que indica períodos de validade.

AtlasEntityHeader

Objeto

Uma instância de uma entidade , como hive_table, hive_database.

Nome Tipo Description
attributes

Os atributos do struct.
classificationNames

string[]

Uma matriz de nomes de classificação.
classifications

AtlasClassification[]

Uma matriz de classificações.
displayText

string

O texto de exibição.
guid

string

O GUID do registro.
isIncomplete

boolean

Se é uma entidade de shell
labels

string[]

Rótulos
lastModifiedTS

string

ETag para controle de simultaneidade.
meaningNames

string[]

Uma matriz de significados.
meanings

AtlasTermAssignmentHeader[]

Uma matriz de cabeçalhos de atribuição de termos.
status

EntityStatus

Status da entidade – pode estar ativo ou excluído. Entidades excluídas não são removidas.
typeName

string

O nome do tipo.

AtlasErrorResponse

Objeto

Uma resposta de erro do serviço

Nome Tipo Description
errorCode

string

O código de erro.
errorMessage

string

A mensagem de erro.
requestId

string (uuid)

A ID da solicitação.

AtlasObjectId

Objeto

Referência a uma instância de objeto de um tipo , como a entidade.

Nome Tipo Description
guid

string

O GUID do objeto.
typeName

string

O nome do tipo.
uniqueAttributes

Os atributos exclusivos do objeto.

AtlasRelationship

Objeto

Instância de relacionamento do Atlas.

Nome Tipo Description
attributes

Os atributos do struct.
createTime

integer (int64)

A hora criada do registro.
createdBy

string

O usuário que criou o registro.
end1

AtlasObjectId

Referência a uma instância de objeto de um tipo , como a entidade.
end2

AtlasObjectId

Referência a uma instância de objeto de um tipo , como a entidade.
guid

string

O GUID da relação.
homeId

string

A ID da casa da relação.
label

string

O rótulo da relação.
lastModifiedTS

string

ETag para controle de simultaneidade.
provenanceType

integer (int32)

Usado para registrar a procedência de uma instância de uma entidade ou relação
status

StatusAtlasRelationship

A enumeração do status da relação.
typeName

string

O nome do tipo.
updateTime

integer (int64)

A hora de atualização do registro.
updatedBy

string

O usuário que atualizou o registro.
version

integer (int64)

A versão da relação.

AtlasRelationshipWithExtInfo

Objeto

A relação com informações estendidas.

Nome Tipo Description
referredEntities

<string,  AtlasEntityHeader>

O cabeçalho de entidade referenciado.
relationship

AtlasRelationship

Instância de relacionamento do Atlas.

AtlasTermAssignmentHeader

Objeto

O cabeçalho da atribuição de termo.

Nome Tipo Description
confidence

integer (int32)

A confiança da atribuição de termo.
createdBy

string

O usuário que criou o registro.
description

string

A descrição da atribuição de termo.
displayText

string

O texto de exibição.
expression

string

A expressão da atribuição de termo.
relationGuid

string (uuid)

O GUID da relação.
status

AtlasTermAssignmentStatus

O status da atribuição de termos.
steward

string

O administrador do termo.
termGuid

string (uuid)

O GUID do termo.

AtlasTermAssignmentStatus

Enumeração

Status da atribuição de termos

Valor Description
DISCOVERED

O status é descoberto.
PROPOSED

O status é proposto.
IMPORTED

O status é importado.
VALIDATED

O status é validado.
DEPRECATED

O status foi preterido.
OBSOLETE

O status é obsoleto.
OTHER

Outro status.

EntityStatus

Enumeração

Status – pode ser ativo ou excluído

Valor Description
ACTIVE

O status está ativo.
DELETED

O status é excluído.

StatusAtlasRelationship

Enumeração

Status da relação atlas

Valor Description
ACTIVE

ativo
DELETED

deletado

TimeBoundary

Objeto

Captura detalhes de limite de tempo

Nome Tipo Description
endTime

string

O limite de fim do tempo.
startTime

string

O início do limite de tempo.
timeZone

string

O fuso horário do limite de tempo.