Entity - Get Classification

Szolgáltatás:

Purview

API-verzió:

2023-09-01

A GUID által képviselt adott entitás besorolásának lekérése.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
classificationName	path	True	string	A besorolás neve.
endpoint	path	True	string (uri)
guid	path	True	string	Az entitás globálisan egyedi azonosítója.

Válaszok

Name	Típus	Description
200 OK	AtlasClassification	A kérés sikeres volt.
Other Status Codes	AtlasErrorResponse	Váratlan hibaválasz.

Biztonság

OAuth2Auth

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

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

Példák

Entity_GetClassification

Mintakérelem

HTTP

GET {endpoint}/datamap/api/atlas/v2/entity/guid/9347abc5-7b86-4b82-a1e2-ad77c7c3cac3/classification/MICROSOFT.PERSONAL.DATE_OF_BIRTH

Mintaválasz

Állapotkód:

200

{
  "typeName": "MICROSOFT.PERSONAL.DATE_OF_BIRTH",
  "lastModifiedTS": "1",
  "entityGuid": "9347abc5-7b86-4b82-a1e2-ad77c7c3cac3",
  "entityStatus": "ACTIVE"
}

Definíciók

Name	Description
AtlasClassification	Besorolás egy példánya; nem rendelkezik identitással, ez az objektum csak akkor létezik, ha egy entitáshoz van társítva.
AtlasErrorResponse	Hibaválasz a szolgáltatástól
EntityStatus	Állapot – lehet aktív vagy törölve
TimeBoundary	Időhatár részleteinek rögzítése

AtlasClassification

Objektum

Besorolás egy példánya; nem rendelkezik identitással, ez az objektum csak akkor létezik, ha egy entitáshoz van társítva.

Name	Típus	Description
attributes		A szerkezet attribútumai.
entityGuid	string	Az entitás GUID azonosítója.
entityStatus	EntityStatus	Az entitás állapota – lehet aktív vagy törölhető. A törölt entitások nem törlődnek.
lastModifiedTS	string	ETag az egyidejűség-vezérléshez.
removePropagationsOnEntityDelete	boolean	Meghatározza, hogy a propagálások törlődnek-e az entitás törlésekor.
typeName	string	A típus neve.
validityPeriods	TimeBoundary[]	Az érvényességi időtartamokat jelző időhatárok tömbje.

AtlasErrorResponse

Objektum

Hibaválasz a szolgáltatástól

Name	Típus	Description
errorCode	string	A hibakód.
errorMessage	string	A hibaüzenet.
requestId	string (uuid)	A kérelem azonosítója.

EntityStatus

Enumerálás

Állapot – lehet aktív vagy törölve

Érték	Description
ACTIVE	Az állapot aktív.
DELETED	Az állapot törlődik.

TimeBoundary

Objektum

Időhatár részleteinek rögzítése

Name	Típus	Description
endTime	string	Az időhatár vége.
startTime	string	Az időhatár kezdete.
timeZone	string	Az időhatár időzónája.