Entity - Get By Unique Attributes

Référence

Service:: Purview

Version d'API:: 2023-09-01

Obtenez la définition complète d’une entité en fonction de son type et de son attribut unique.

En plus du paramètre de chemin d’accès typeName, la ou les paires clé-valeur d’attribut peuvent être fournies au format suivant : attr :<attrName>=.

REMARQUE : attrName et attrValue doivent être uniques entre les entités, par exemple. qualifiedName.

La requête REST ressemblerait à ceci : GET /v2/entity/uniqueAttribute/type/aType ?attr :aTypeAttribute=someValue.

GET {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/{typeName}

Avec des paramètres facultatifs:

GET {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/{typeName}?minExtInfo={minExtInfo}&ignoreRelationships={ignoreRelationships}&attr:qualifiedName={attr:qualifiedName}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string
typeName	path	True	string	Nom du type.
attr:qualifiedName	query		string	Nom qualifié de l’entité. (Il ne s’agit que d’un exemple. qualifiedName peut être remplacé par d’autres attributs uniques)
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_GetByUniqueAttributes

Exemple de requête

HTTP

GET {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/azure_storage_account?minExtInfo=True&attr:qualifiedName=https://exampleaccount.core.windows.net

Exemple de réponse

Code d’état:: 200

{
  "entity": {
    "createTime": 1605703532110,
    "createdBy": "8c062c84-5d25-449f-a990-9d8ab70b8ec7",
    "guid": "e0ba3f20-f3b5-4d52-b769-ed35a02df60a",
    "relationshipAttributes": {
      "services": [],
      "meanings": []
    },
    "status": "ACTIVE",
    "updateTime": 1605703532110,
    "updatedBy": "8c062c84-5d25-449f-a990-9d8ab70b8ec7",
    "lastModifiedTS": "2",
    "version": 0,
    "attributes": {
      "owner": "ExampleOwner",
      "qualifiedName": "https://exampleaccount.core.windows.net",
      "createTime": 0,
      "name": "ExampleNewName"
    },
    "typeName": "azure_storage_account"
  },
  "referredEntities": {}
}

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é.
AtlasEntity	Instance d’une entité, comme hive_table, hive_database.
AtlasEntityWithExtInfo	Une 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’attribution de terme.
AtlasTermAssignmentStatus	État de l’attribution de terme
EntityStatus	État : peut être actif ou supprimé
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é.

AtlasEntity

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 des contacts pour les entités. La clé peut être Expert ou Owner.
createTime	integer	Heure de création 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’origine de l’entité.
isIncomplete	boolean	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	Permet d’enregistrer la provenance d’un instance d’une entité ou d’une relation.
proxy	boolean	Détermine s’il existe un proxy.
relationshipAttributes		Attributs de la 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	Heure de mise à jour de l’enregistrement.
updatedBy	string	Utilisateur qui a mis à jour l’enregistrement.
version	integer	Version de l’entité.

AtlasEntityWithExtInfo

Une 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

Réponse d’erreur du service

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

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é.

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.