Relationship - Get

Riferimento

Servizio:: Purview

Versione API:: 2023-09-01

Ottenere informazioni sulla relazione tra entità dal GUID.

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

Con parametri facoltativi:

GET {endpoint}/datamap/api/atlas/v2/relationship/guid/{guid}?extendedInfo={extendedInfo}

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string
guid	path	True	string	Identificatore univoco globale della relazione.
extendedInfo	query		boolean	Limita se sono incluse informazioni estese.

Risposte

Nome	Tipo	Descrizione
200 OK	AtlasRelationshipWithExtInfo	La richiesta ha avuto esito positivo.
Other Status Codes	AtlasErrorResponse	Risposta di errore imprevista.

Sicurezza

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

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

Esempio

Relationship_Get

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 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
  }
}

Definizioni

Nome	Descrizione
AtlasClassification	Istanza di una classificazione; non ha un'identità, questo oggetto esiste solo quando associato a un'entità.
AtlasEntityHeader	Istanza di un'entità, ad esempio hive_table, hive_database.
AtlasErrorResponse	Risposta di errore dal servizio
AtlasObjectId	Riferimento a un'istanza oggetto di un tipo, ad esempio un'entità.
AtlasRelationship	Istanza di relazione Atlas.
AtlasRelationshipWithExtInfo	Relazione con informazioni estese.
AtlasTermAssignmentHeader	Intestazione per l'assegnazione di termini.
AtlasTermAssignmentStatus	Stato per l'assegnazione di termini
EntityStatus	Stato : può essere attivo o eliminato
StatusAtlasRelationship	Stato per la relazione atlas
TimeBoundary	Acquisisce i dettagli del limite temporale

AtlasClassification

Istanza di una classificazione; non ha un'identità, questo oggetto esiste solo quando associato a un'entità.

Nome	Tipo	Descrizione
attributes		Attributi dello struct.
entityGuid	string	GUID dell'entità.
entityStatus	EntityStatus	Stato dell'entità: può essere attivo o eliminato. Le entità eliminate non vengono rimosse.
lastModifiedTS	string	ETag per il controllo di concorrenza.
removePropagationsOnEntityDelete	boolean	Determina se le propagazioni verranno rimosse per l'eliminazione dell'entità.
typeName	string	Nome del tipo.
validityPeriods	TimeBoundary[]	Matrice di limiti temporali che indicano periodi di validità.

AtlasEntityHeader

Istanza di un'entità, ad esempio hive_table, hive_database.

Nome	Tipo	Descrizione
attributes		Attributi dello struct.
classificationNames	string[]	Matrice di nomi di classificazione.
classifications	AtlasClassification[]	Matrice di classificazioni.
displayText	string	Testo visualizzato.
guid	string	GUID del record.
isIncomplete	boolean	Se si tratta di un'entità shell
labels	string[]	Etichette
lastModifiedTS	string	ETag per il controllo di concorrenza.
meaningNames	string[]	Matrice di significati.
meanings	AtlasTermAssignmentHeader[]	Matrice di intestazioni di assegnazione di termini.
status	EntityStatus	Stato dell'entità: può essere attivo o eliminato. Le entità eliminate non vengono rimosse.
typeName	string	Nome del tipo.

AtlasErrorResponse

Risposta di errore dal servizio

Nome	Tipo	Descrizione
errorCode	string	Codice di errore.
errorMessage	string	Messaggio di errore.
requestId	string	ID richiesta.

AtlasObjectId

Riferimento a un'istanza oggetto di un tipo, ad esempio un'entità.

Nome	Tipo	Descrizione
guid	string	GUID dell'oggetto .
typeName	string	Nome del tipo.
uniqueAttributes		Attributi univoci dell'oggetto.

AtlasRelationship

Istanza di relazione Atlas.

Nome	Tipo	Descrizione
attributes		Attributi dello struct.
createTime	integer	Ora creata del record.
createdBy	string	Utente che ha creato il record.
end1	AtlasObjectId	Riferimento a un'istanza oggetto di un tipo, ad esempio un'entità.
end2	AtlasObjectId	Riferimento a un'istanza oggetto di un tipo, ad esempio un'entità.
guid	string	GUID della relazione.
homeId	string	ID home della relazione.
label	string	Etichetta della relazione.
lastModifiedTS	string	ETag per il controllo di concorrenza.
provenanceType	integer	Usato per registrare la provenienza di un'istanza di un'entità o di una relazione
status	StatusAtlasRelationship	Enumerazione dello stato della relazione.
typeName	string	Nome del tipo.
updateTime	integer	Ora di aggiornamento del record.
updatedBy	string	Utente che ha aggiornato il record.
version	integer	Versione della relazione.

AtlasRelationshipWithExtInfo

Relazione con informazioni estese.

Nome	Tipo	Descrizione
referredEntities	<string, AtlasEntityHeader>	Intestazione di entità definita.
relationship	AtlasRelationship	Istanza di relazione Atlas.

AtlasTermAssignmentHeader

Intestazione per l'assegnazione di termini.

Nome	Tipo	Descrizione
confidence	integer	Attendibilità dell'assegnazione del termine.
createdBy	string	Utente che ha creato il record.
description	string	Descrizione dell'assegnazione del termine.
displayText	string	Testo visualizzato.
expression	string	Espressione dell'assegnazione del termine.
relationGuid	string	GUID della relazione.
status	AtlasTermAssignmentStatus	Stato dell'assegnazione dei termini.
steward	string	Il responsabile del termine.
termGuid	string	GUID del termine.

AtlasTermAssignmentStatus

Stato per l'assegnazione di termini

Nome	Tipo	Descrizione
DEPRECATED	string	Lo stato è deprecato.
DISCOVERED	string	Lo stato viene individuato.
IMPORTED	string	Lo stato viene importato.
OBSOLETE	string	Lo stato è obsoleto.
OTHER	string	Altro stato.
PROPOSED	string	Lo stato viene proposto.
VALIDATED	string	Lo stato viene convalidato.

EntityStatus

Stato : può essere attivo o eliminato

Nome	Tipo	Descrizione
ACTIVE	string	Lo stato è attivo.
DELETED	string	Lo stato viene eliminato.

StatusAtlasRelationship

Stato per la relazione atlas

Nome	Tipo	Descrizione
ACTIVE	string	active
DELETED	string	deleted

TimeBoundary

Acquisisce i dettagli del limite temporale

Nome	Tipo	Descrizione
endTime	string	Fine del limite di tempo.
startTime	string	Inizio del limite di tempo.
timeZone	string	Fuso orario del limite di tempo.

Condividi tramite