Entity - Delete By Unique Attribute

Référence

Service:: Purview

Version d'API:: 2023-09-01

Supprimer une entité identifiée par son type et ses attributs uniques. En plus du paramètre typeName path, les paires clé-valeur d’attribut peuvent être fournies au format suivant : attr :<attrName>=<attrValue>. REMARQUE : attrName et attrValue doivent être uniques entre les entités, par exemple. qualifiedName.

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

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

Avec des paramètres facultatifs:

DELETE {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/{typeName}?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)

Réponses

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

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

{
  "mutatedEntities": {
    "DELETE": [
      {
        "classificationNames": [],
        "displayText": "Example Name",
        "guid": "e0ba3f20-f3b5-4d52-b769-ed35a02df60a",
        "meaningNames": [],
        "meanings": [],
        "status": "ACTIVE",
        "lastModifiedTS": "1",
        "attributes": {
          "owner": "ExampleOwner",
          "createTime": 0,
          "qualifiedName": "https://exampleaccount.core.windows.net",
          "name": "ExampleName"
        },
        "typeName": "azure_storage_account"
      }
    ]
  }
}

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
AtlasTermAssignmentHeader	En-tête de l’affectation de terme.
AtlasTermAssignmentStatus	État de l’affectation de terme
EntityMutationResult	Résultat de la réponse de mutation de l’entité.
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 de l’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.

AtlasTermAssignmentHeader

En-tête de l’affectation 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’affectation de terme

Nom	Type	Description
DEPRECATED	string	La status est déconseillée.
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é.

EntityMutationResult

Résultat de la réponse de mutation de l’entité.

Nom	Type	Description
guidAssignments	object	Carte des affectations DE GUID avec des entités.
mutatedEntities	object	En-têtes d’entités mutées.
partialUpdatedEntities	AtlasEntityHeader[]	Tableau d’en-têtes d’entité partiellement mis à jour.

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.