Relationship - Get

Référence

Service:: Purview

Version d'API:: 2023-09-01

Obtenez des informations de relation entre les entités par son GUID.

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string
guid	path	True	string	Identificateur global unique de la relation.
extendedInfo	query		boolean	Limite si inclut des informations étendues.

Réponses

Nom	Type	Description
200 OK	AtlasRelationshipWithExtInfo	La demande a réussi.
Other Status Codes	AtlasErrorResponse	Réponse d’erreur inattendue.

Sécurité

OAuth2Auth

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

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

Exemples

Relationship_Get

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 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
  }
}

Définitions

Nom	Description
AtlasClassification	Un instance d’une classification ; il n’a pas d’identité, cet objet existe uniquement lorsqu’il est associé à une entité.
AtlasEntityHeader	Instance d’une entité, comme hive_table, hive_database.
AtlasErrorResponse	Réponse d’erreur du service
AtlasObjectId	Référence à une instance d’objet d’un type , comme une entité.
AtlasRelationship	Instance de relation Atlas.
AtlasRelationshipWithExtInfo	Relation avec les informations étendues.
AtlasTermAssignmentHeader	En-tête de l’attribution de terme.
AtlasTermAssignmentStatus	État de l’attribution de terme
EntityStatus	État : peut être actif ou supprimé
StatusAtlasRelationship	État de la relation atlas
TimeBoundary	Capture les détails de la limite de temps

AtlasClassification

Un instance d’une classification ; il n’a pas d’identité, cet objet existe uniquement lorsqu’il est associé à une entité.

Nom	Type	Description
attributes		Attributs du struct.
entityGuid	string	GUID de l’entité.
entityStatus	EntityStatus	État de l’entité : peut être actif ou supprimé. Les entités supprimées ne sont pas supprimées.
lastModifiedTS	string	ETag pour le contrôle d’accès concurrentiel.
removePropagationsOnEntityDelete	boolean	Détermine si les propagations seront supprimées lors de la suppression d’entité.
typeName	string	Nom du type.
validityPeriods	TimeBoundary[]	Tableau de limites de temps indiquant des périodes de validité.

AtlasEntityHeader

Instance d’une entité, comme hive_table, hive_database.

Nom	Type	Description
attributes		Attributs du struct.
classificationNames	string[]	Tableau de noms de classification.
classifications	AtlasClassification[]	Tableau de classifications.
displayText	string	Texte d’affichage.
guid	string	GUID de l’enregistrement.
isIncomplete	boolean	S’il s’agit d’une entité shell
labels	string[]	étiquettes
lastModifiedTS	string	ETag pour le contrôle d’accès concurrentiel.
meaningNames	string[]	Tableau de significations.
meanings	AtlasTermAssignmentHeader[]	Tableau d’en-têtes d’affectation de terme.
status	EntityStatus	État de l’entité : peut être actif ou supprimé. Les entités supprimées ne sont pas supprimées.
typeName	string	Nom du type.

AtlasErrorResponse

Réponse d’erreur du service

Nom	Type	Description
errorCode	string	Code d'erreur.
errorMessage	string	Message d’erreur.
requestId	string	ID de demande.

AtlasObjectId

Référence à une instance d’objet d’un type , comme une entité.

Nom	Type	Description
guid	string	GUID de l’objet.
typeName	string	Nom du type.
uniqueAttributes		Attributs uniques de l’objet.

AtlasRelationship

Instance de relation Atlas.

Nom	Type	Description
attributes		Attributs du struct.
createTime	integer	Heure de création de l’enregistrement.
createdBy	string	Utilisateur qui a créé l’enregistrement.
end1	AtlasObjectId	Référence à une instance d’objet d’un type , comme une entité.
end2	AtlasObjectId	Référence à une instance d’objet d’un type , comme une entité.
guid	string	GUID de la relation.
homeId	string	ID de base de la relation.
label	string	Étiquette de la relation.
lastModifiedTS	string	ETag pour le contrôle d’accès concurrentiel.
provenanceType	integer	Utilisé pour enregistrer la provenance d’un instance d’une entité ou d’une relation
status	StatusAtlasRelationship	Énumération de la relation status.
typeName	string	Nom du type.
updateTime	integer	Heure de mise à jour de l’enregistrement.
updatedBy	string	Utilisateur qui a mis à jour l’enregistrement.
version	integer	Version de la relation.

AtlasRelationshipWithExtInfo

Relation avec les informations étendues.

Nom	Type	Description
referredEntities	<string, AtlasEntityHeader>	En-tête d’entité référencée.
relationship	AtlasRelationship	Instance de relation Atlas.

AtlasTermAssignmentHeader

En-tête de l’attribution de terme.

Nom	Type	Description
confidence	integer	Confiance de l’affectation de terme.
createdBy	string	Utilisateur qui a créé l’enregistrement.
description	string	Description de l’affectation de terme.
displayText	string	Texte d’affichage.
expression	string	Expression de l’affectation de terme.
relationGuid	string	GUID de la relation.
status	AtlasTermAssignmentStatus	Status de l’attribution de termes.
steward	string	Intendant du terme.
termGuid	string	GUID du terme.

AtlasTermAssignmentStatus

État de l’attribution de terme

Nom	Type	Description
DEPRECATED	string	Le status est déconseillé.
DISCOVERED	string	Le status est découvert.
IMPORTED	string	Le status est importé.
OBSOLETE	string	Le status est obsolète.
OTHER	string	Autres status.
PROPOSED	string	Le status est proposé.
VALIDATED	string	Le status est validé.

EntityStatus

État : peut être actif ou supprimé

Nom	Type	Description
ACTIVE	string	Le status est actif.
DELETED	string	Le status est supprimé.

StatusAtlasRelationship

État de la relation atlas

Nom	Type	Description
ACTIVE	string	active
DELETED	string	deleted

TimeBoundary

Capture les détails de la limite de temps

Nom	Type	Description
endTime	string	Fin de la limite de temps.
startTime	string	Début de la limite de temps.
timeZone	string	Fuseau horaire de la limite de temps.

Partager via