Type - Get Enum Def By Guid

Služba:

Purview

Verze rozhraní API:

2023-09-01

Získejte definici výčtu pro daný identifikátor GUID.

GET {endpoint}/datamap/api/atlas/v2/types/enumdef/guid/{guid}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string (uri)
guid	path	True	string	Globálně jedinečný identifikátor výčtu.

Odpovědi

Name	Typ	Description
200 OK	AtlasEnumDef	Požadavek byl úspěš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

Type_GetEnumDefByGuid

Ukázkový požadavek

HTTP

GET {endpoint}/datamap/api/atlas/v2/types/enumdef/guid/644ab9c7-893a-4a4d-8e0a-591a6556d1a0

Ukázková odpověď

Stavový kód:

200

{
  "category": "ENUM",
  "guid": "644ab9c7-893a-4a4d-8e0a-591a6556d1a0",
  "createdBy": "ExampleCreator",
  "updatedBy": "ExampleUpdator",
  "createTime": 1553065968102,
  "updateTime": 1553065968102,
  "version": 1,
  "name": "hive_principal_type",
  "description": "hive_principal_type",
  "typeVersion": "1.0",
  "elementDefs": [
    {
      "value": "USER",
      "ordinal": 1
    },
    {
      "value": "ROLE",
      "ordinal": 2
    },
    {
      "value": "GROUP",
      "ordinal": 3
    }
  ]
}

Definice

Name	Description
AtlasEnumDef	třída, která zachycuje podrobnosti výčtového typu.
AtlasEnumElementDef	třída, která zachycuje podrobnosti výčtu elementu.
AtlasErrorResponse	Chybová odpověď ze služby
DateFormat	Formát data.
NumberFormat	Formát čísla.
RoundingMode	Režim zaokrouhlování
TimeZone	Informace o časovém pásmu.
TypeCategory	Kategorie typu

AtlasEnumDef

Objekt

třída, která zachycuje podrobnosti výčtového typu.

Name	Typ	Description
category	TypeCategory	Výčet kategorie typu.
createTime	integer (int64)	Čas vytvoření záznamu.
createdBy	string	Uživatel, který záznam vytvořil.
dateFormatter	DateFormat	Formát data.
defaultValue	string	Výchozí hodnota.
description	string	Popis definice typu.
elementDefs	AtlasEnumElementDef[]	Pole definic elementů výčtu.
guid	string	Identifikátor GUID definice typu.
lastModifiedTS	string	ETag pro řízení souběžnosti
name	string	Název definice typu.
options	object	Možnosti definice typu.
serviceType	string	Typ služby.
typeVersion	string	Verze typu.
updateTime	integer (int64)	Čas aktualizace záznamu.
updatedBy	string	Uživatel, který záznam aktualizoval.
version	integer (int64)	Verze záznamu.

AtlasEnumElementDef

Objekt

třída, která zachycuje podrobnosti výčtu elementu.

Name	Typ	Description
description	string	Popis definice elementu výčtu.
ordinal	integer (int32)	Pořadové číslo definice elementu výčtu.
value	string	Hodnota definice elementu výčtu.

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.

DateFormat

Objekt

Formát data.

Name	Typ	Description
availableLocales	string[]	Pole dostupných národních prostředí.
calendar	number (float)	Kalendář
dateInstance	DateFormat	Formát data.
dateTimeInstance	DateFormat	Formát data.
instance	DateFormat	Formát data.
lenient	boolean	Určuje leniency formátu data.
numberFormat	NumberFormat	Formát čísla.
timeInstance	DateFormat	Formát data.
timeZone	TimeZone	Informace o časovém pásmu.

NumberFormat

Objekt

Formát čísla.

Name	Typ	Description
availableLocales	string[]	Formát čísla.
currency	string	Měna.
currencyInstance	NumberFormat	Formát čísla.
groupingUsed	boolean	Určuje, jestli se používá seskupení.
instance	NumberFormat	Formát čísla.
integerInstance	NumberFormat	Formát čísla.
maximumFractionDigits	integer (int32)	Maximální počet desetinných míst.
maximumIntegerDigits	integer (int32)	Maximální počet celých číslic.
minimumFractionDigits	integer (int32)	Minimální počet desetinných míst.
minimumIntegerDigits	integer (int32)	Minimální celočíselná číslice.
numberInstance	NumberFormat	Formát čísla.
parseIntegerOnly	boolean	Určuje, jestli se parsuje pouze celé číslo.
percentInstance	NumberFormat	Formát čísla.
roundingMode	RoundingMode	Výčet režimu zaokrouhlování.

RoundingMode

Výčet

Režim zaokrouhlování

Hodnota	Description
UP	nahoru
DOWN	dolů
CEILING	strop
FLOOR	podlaha
HALF_UP	poloviční nahoru
HALF_DOWN	poločas dolů
HALF_EVEN	poloviční sudá
UNNECESSARY	nepotřebný

TimeZone

Objekt

Informace o časovém pásmu.

Name	Typ	Description
availableIds	string[]	Pole dostupných ID.
default	TimeZone	Informace o časovém pásmu.
displayName	string	Zobrazovaný název časového pásma.
dstSavings	integer (int32)	Hodnota letního času.
id	string	ID časového pásma.
rawOffset	integer (int32)	Nezpracovaný posun časového pásma.

TypeCategory

Výčet

Kategorie typu

Hodnota	Description
PRIMITIVE	primitivní
OBJECT_ID_TYPE	typ ID objektu
ENUM	výčet
STRUCT	struktura
CLASSIFICATION	klasifikace
ENTITY	entita
ARRAY	pole
MAP	mapa
RELATIONSHIP	relace
TERM_TEMPLATE	šablona termínu