Entity - Get

Référence

Service:: Purview

Version d'API:: 2023-09-01

Obtenez la définition complète d’une entité en fonction de son GUID.

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

Avec des paramètres facultatifs:

GET {endpoint}/datamap/api/atlas/v2/entity/guid/{guid}?minExtInfo={minExtInfo}&ignoreRelationships={ignoreRelationships}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string (uri)
guid	path	True	string	Identificateur global unique de l’entité.
ignoreRelationships	query		boolean	Indique s’il faut ignorer les attributs de relation.
minExtInfo	query		boolean	Indique s’il faut retourner des informations minimales pour les entités référencées.

Réponses

Nom	Type	Description
200 OK	AtlasEntityWithExtInfo	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

Entity_Get

Exemple de requête

HTTP

GET {endpoint}/datamap/api/atlas/v2/entity/guid/5cf8a9e5-c9fd-abe0-2e8c-d40024263dcb?minExtInfo=True

Exemple de réponse

Code d’état:: 200

{
  "referredEntities": {},
  "entity": {
    "typeName": "column",
    "attributes": {
      "owner": null,
      "qualifiedName": "adl://exampleaccount.azuredatalakestore.net/123/1/DP_TFS/CBT/Extensions/DTTP.targets#:xml/Project/Target/XmlPeek/@XmlInputPath",
      "name": "~XmlInputPath",
      "description": null,
      "type": "string"
    },
    "guid": "5cf8a9e5-c9fd-abe0-2e8c-d40024263dcb",
    "status": "ACTIVE",
    "createdBy": "ExampleCreator",
    "updatedBy": "ExampleUpdator",
    "createTime": 1553072455110,
    "updateTime": 1553072455110,
    "version": 0,
    "relationshipAttributes": {
      "schema": [],
      "inputToProcesses": [],
      "composeSchema": {
        "guid": "cc6652ae-dc6d-90c9-1899-252eabc0e929",
        "typeName": "tabular_schema",
        "displayText": "tabular_schema",
        "relationshipGuid": "5a4510d4-57d0-467c-888f-4b61df42702b",
        "relationshipStatus": "ACTIVE",
        "relationshipAttributes": {
          "typeName": "tabular_schema_columns"
        }
      },
      "meanings": [],
      "outputFromProcesses": [],
      "tabular_schema": null
    },
    "contacts": {
      "Expert": [
        {
          "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
          "info": "Example Expert Info"
        }
      ],
      "Owner": [
        {
          "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
          "info": "Example Owner Info"
        }
      ]
    }
  }
}

Définitions

Nom	Description
AtlasClassification	Instance d’une classification ; il n’a pas d’identité, cet objet existe uniquement lorsqu’il est associé à une entité.
AtlasEntity	Instance d’une entité, comme hive_table, hive_database.
AtlasEntityWithExtInfo	Instance d’une entité avec des informations étendues, comme hive_table, hive_database.
AtlasErrorResponse	Réponse d’erreur du service
AtlasTermAssignmentHeader	En-tête de l’affectation de terme.
AtlasTermAssignmentStatus	État de l’affectation de terme
EntityStatus	État : peut être actif ou supprimé
TimeBoundary	Capture les détails des limites temporelles

AtlasClassification

Object

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 les périodes de validité.

AtlasEntity

Object

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

Nom	Type	Description
attributes		Attributs du struct.
businessAttributes		Attributs métier
classifications	AtlasClassification[]	Tableau de classifications.
collectionId	string	ID de collection de l’entité.
contacts	object	Dictionnaire de contacts pour les entités. La clé peut être expert ou propriétaire.
createTime	integer (int64)	Heure créée de l’enregistrement.
createdBy	string	Utilisateur qui a créé l’enregistrement.
customAttributes	object	Attribut personnalisé
guid	string	GUID de l’entité.
homeId	string	ID d’accueil de l’entité.
isIncomplete	boolean	Indique s’il s’agit d’une entité shell
labels	string[]	Étiquettes
lastModifiedTS	string	ETag pour le contrôle d’accès concurrentiel.
meanings	AtlasTermAssignmentHeader[]	Tableau d’en-têtes d’affectation de termes indiquant les significations de l’entité.
provenanceType	integer (int32)	Permet d’enregistrer la provenance d’une instance d’une entité ou d’une relation.
proxy	boolean	Détermine s’il existe un proxy.
relationshipAttributes		Attributs de relation.
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.
updateTime	integer (int64)	Heure de mise à jour de l’enregistrement.
updatedBy	string	Utilisateur qui a mis à jour l’enregistrement.
version	integer (int64)	Version de l’entité.

AtlasEntityWithExtInfo

Object

Instance d’une entité avec des informations étendues, comme hive_table, hive_database.

Nom	Type	Description
entity	AtlasEntity	Instance d’une entité, comme hive_table, hive_database.
referredEntities	<string, AtlasEntity>	Entités référencées.

AtlasErrorResponse

Object

Réponse d’erreur du service

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

AtlasTermAssignmentHeader

Object

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

Nom	Type	Description
confidence	integer (int32)	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 (uuid)	GUID de la relation.
status	AtlasTermAssignmentStatus	État de l’affectation de termes.
steward	string	L’administrateur du terme.
termGuid	string (uuid)	GUID du terme.

AtlasTermAssignmentStatus

Énumération

État de l’affectation de terme

Valeur	Description
DEPRECATED	L’état est déconseillé.
DISCOVERED	L’état est découvert.
IMPORTED	L’état est importé.
OBSOLETE	L’état est obsolète.
OTHER	Autre état.
PROPOSED	Le statut est proposé.
VALIDATED	L’état est validé.

EntityStatus

Énumération

État : peut être actif ou supprimé

Valeur	Description
ACTIVE	L’état est actif.
DELETED	L’état est supprimé.

TimeBoundary

Object

Capture les détails des limites temporelles

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

Entity - Get

Paramètres URI

Réponses

Sécurité

OAuth2Auth

Étendues

Exemples

Entity_Get

Exemple de requête

Exemple de réponse

Définitions

AtlasClassification

AtlasEntity

AtlasEntityWithExtInfo

AtlasErrorResponse

AtlasTermAssignmentHeader

AtlasTermAssignmentStatus

EntityStatus

TimeBoundary

Ressources supplémentaires