Entity - Add Classifications By Unique Attribute

Služba:

Purview

Verze rozhraní API:

2023-09-01

Přidejte klasifikaci do entity identifikované podle typu a jedinečných atributů.

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

S volitelnými parametry:

POST {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications?attr:qualifiedName={attr:qualifiedName}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string (uri)
typeName	path	True	string	Název typu.
attr:qualifiedName	query		string	Kvalifikovaný název entity. (Toto je pouze příklad. název kvalifikovaný_název lze změnit na jiné jedinečné atributy.)

Text požadavku

Name	Typ	Description
body	AtlasClassification[]	Pole klasifikace, která se má přidat.

Odpovědi

Name	Typ	Description
204 No Content		Pro tento požadavek se nedá odeslat žádný obsah, ale hlavičky můžou být užitečné.
Other Status Codes	AtlasErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

OAuth2Auth

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

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

Příklady

Entity_AddClassificationsByUniqueAttribute

Ukázkový požadavek

HTTP

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

[
  {
    "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER"
  },
  {
    "typeName": "MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER"
  }
]

Ukázková odpověď

Stavový kód:

204

Definice

Name	Description
AtlasClassification	Instance klasifikace; nemá identitu, tento objekt existuje pouze v případě, že je přidružený k entitě.
AtlasErrorResponse	Chybová odpověď ze služby
EntityStatus	Stav – může být aktivní nebo odstraněný
TimeBoundary	Zaznamenává podrobnosti o hranici času.

AtlasClassification

Objekt

Instance klasifikace; nemá identitu, tento objekt existuje pouze v případě, že je přidružený k entitě.

Name	Typ	Description
attributes		Atributy struktury.
entityGuid	string	Identifikátor GUID entity.
entityStatus	EntityStatus	Stav entity – může být aktivní nebo odstraněný. Odstraněné entity se neodeberou.
lastModifiedTS	string	ETag pro řízení souběžnosti
removePropagationsOnEntityDelete	boolean	Určuje, jestli se při odstranění entity odeberou šíření.
typeName	string	Název typu.
validityPeriods	TimeBoundary[]	Pole časových hranic označující období platnosti.

AtlasErrorResponse

Objekt

Chybová odpověď ze služby

Name	Typ	Description
errorCode	string	Kód chyby.
errorMessage	string	Chybová zpráva.
requestId	string (uuid)	ID požadavku.

EntityStatus

Výčet

Stav – může být aktivní nebo odstraněný

Hodnota	Description
ACTIVE	Stav je aktivní.
DELETED	Stav se odstraní.

TimeBoundary

Objekt

Zaznamenává podrobnosti o hranici času.

Name	Typ	Description
endTime	string	Konec časové hranice.
startTime	string	Začátek časové hranice.
timeZone	string	Časové pásmo časové hranice.