Entity - Add Labels By Unique Attribute

Service:

Purview

Version d'API:

2023-09-01

Ajoutez des étiquettes données à une entité donnée identifiée par son type et ses attributs uniques.

Si les étiquettes ont la valeur null/vide, aucune étiquette n’est ajoutée.

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 :=.

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

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

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

Avec des paramètres facultatifs:

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

Corps de la demande

Nom	Type	Description
body	string[]	jeu d’étiquettes à ajouter

Réponses

Nom	Type	Description
204 No Content		Il n’y a pas de contenu à envoyer pour cette demande, mais les en-têtes peuvent être utiles.
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_AddLabelsByUniqueAttribute

Exemple de requête

HTTP

PUT {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/Asset/labels?attr:qualifiedName=https://asset1

[
  "label3"
]

Exemple de réponse

Code d’état:

204

Définitions

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.