Type - Get Classification Def By Name

Service:

Purview

Version d'API:

2023-09-01

Obtenez la définition de classification par son nom (unique).

GET {endpoint}/datamap/api/atlas/v2/types/classificationdef/name/{name}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string (uri)
name	path	True	string	Nom de la classification.

Réponses

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

Type_GetClassificationDefByName

Exemple de requête

HTTP

GET {endpoint}/datamap/api/atlas/v2/types/classificationdef/name/MICROSOFT.GOVERNMENT.CANADA.SOCIAL_INSURANCE_NUMBER

Exemple de réponse

Code d’état:

200

{
  "category": "CLASSIFICATION",
  "guid": "e79878fa-adba-4ee5-adc5-328d8841cd49",
  "createdBy": "ExampleCreator",
  "updatedBy": "ExampleUpdator",
  "createTime": 1553065966043,
  "updateTime": 1553065966043,
  "version": 1,
  "name": "MICROSOFT.GOVERNMENT.CANADA.SOCIAL_INSURANCE_NUMBER",
  "description": "Canada Social Insurance Number",
  "typeVersion": "1.0",
  "attributeDefs": [],
  "superTypes": [],
  "entityTypes": [],
  "subTypes": []
}

Définitions

Nom	Description
AtlasAttributeDef	classe qui capture les détails d’un struct-attribute.
AtlasClassificationDef	classe qui capture les détails d’un type de classification.
AtlasConstraintDef	classe qui capture les détails d’une contrainte.
AtlasErrorResponse	Réponse d’erreur du service
CardinalityValue	Cardinalité
DateFormat	Format de date.
NumberFormat	Format numérique.
RoundingMode	Mode arrondi
TimeZone	Informations sur le fuseau horaire.
TypeCategory	Catégorie de type

AtlasAttributeDef

Object

classe qui capture les détails d’un struct-attribute.

Nom	Type	Description
cardinality	CardinalityValue	attribut à valeur unique ou attribut à valeurs multiples.
constraints	AtlasConstraintDef[]	Tableau de contraintes.
defaultValue	string	Valeur par défaut de l’attribut.
description	string	Description de l’attribut.
includeInNotification	boolean	Détermine s’il est inclus dans la notification.
isIndexable	boolean	Détermine s’il est indexable.
isOptional	boolean	Détermine s’il est facultatif.
isUnique	boolean	Détermine s’il est unique.
name	string	Nom de l’attribut.
options	object	Options de l’attribut.
typeName	string	Nom du type.
valuesMaxCount	integer (int32)	Nombre maximal de valeurs.
valuesMinCount	integer (int32)	Nombre minimal de valeurs.

AtlasClassificationDef

Object

classe qui capture les détails d’un type de classification.

Nom	Type	Description
attributeDefs	AtlasAttributeDef[]	Tableau de définitions d’attributs.
category	TypeCategory	Énumération de la catégorie de type.
createTime	integer (int64)	Heure créée de l’enregistrement.
createdBy	string	Utilisateur qui a créé l’enregistrement.
dateFormatter	DateFormat	Format de date.
description	string	Description de la définition de type.
entityTypes	string[]	La spécification d’une liste de noms entityType dans classificationDef garantit que les classifications ne peuvent être appliquées qu’à ces entityTypes. Tous les sous-types des types d’entités héritent de la restriction. Les sous-types classificationDef héritent des restrictions entityTypes parents. Les sous-types classificationDef peuvent restreindre davantage les restrictions entityTypes parents en spécifiant un sous-ensemble des entityTypes. Une liste entityTypes vide lorsqu’il n’existe aucune restriction parent signifie qu’il n’y a aucune restriction. Une liste entityTypes vide lorsqu’il existe des restrictions parentes signifie que le sous-type récupère les restrictions des parents. Si une liste d’entityTypes est fournie, où l’un hérite d’une autre, cela sera rejeté. Cela doit encourager des classifications plus propresDefs.
guid	string	GUID de la définition de type.
lastModifiedTS	string	ETag pour le contrôle d’accès concurrentiel.
name	string	Nom de la définition de type.
options	object	Options de la définition de type.
serviceType	string	Type de service.
subTypes	string[]	Tableau de sous-types.
superTypes	string[]	Tableau de super types.
typeVersion	string	Version du type.
updateTime	integer (int64)	Heure de mise à jour de l’enregistrement.
updatedBy	string	Utilisateur qui a mis à jour l’enregistrement.
version	integer (int64)	Version de l’enregistrement.

AtlasConstraintDef

Object

classe qui capture les détails d’une contrainte.

Nom	Type	Description
params		Paramètres de la définition de contrainte.
type	string	Type de la contrainte.

AtlasErrorResponse

Object

Réponse d’erreur du service

Nom	Type	Description
errorCode	string	Code d’erreur.
errorMessage	string	Message d’erreur.
requestId	string (uuid)	ID de demande.

CardinalityValue

Énumération

Cardinalité

Valeur	Description
LIST	liste
SET	poser
SINGLE	célibataire

DateFormat

Object

Format de date.

Nom	Type	Description
availableLocales	string[]	Tableau de paramètres régionaux disponibles.
calendar	number (float)	Calendrier
dateInstance	DateFormat	Format de date.
dateTimeInstance	DateFormat	Format de date.
instance	DateFormat	Format de date.
lenient	boolean	Détermine la lénience du format de date.
numberFormat	NumberFormat	Format numérique.
timeInstance	DateFormat	Format de date.
timeZone	TimeZone	Informations sur le fuseau horaire.

NumberFormat

Object

Format numérique.

Nom	Type	Description
availableLocales	string[]	Format numérique.
currency	string	La devise.
currencyInstance	NumberFormat	Format numérique.
groupingUsed	boolean	Détermine si le regroupement est utilisé.
instance	NumberFormat	Format numérique.
integerInstance	NumberFormat	Format numérique.
maximumFractionDigits	integer (int32)	Nombre maximal de chiffres de fraction.
maximumIntegerDigits	integer (int32)	Nombre maximal de chiffres entiers.
minimumFractionDigits	integer (int32)	Nombre minimal de chiffres de fraction.
minimumIntegerDigits	integer (int32)	Nombre minimal de chiffres entiers.
numberInstance	NumberFormat	Format numérique.
parseIntegerOnly	boolean	Détermine si seul un entier est analysé.
percentInstance	NumberFormat	Format numérique.
roundingMode	RoundingMode	Énumération du mode arrondi.

RoundingMode

Énumération

Mode arrondi

Valeur	Description
CEILING	plafond
DOWN	en bas
FLOOR	sol
HALF_DOWN	moitié vers le bas
HALF_EVEN	moitié même
HALF_UP	moitié vers le haut
UNNECESSARY	inutile
UP	en haut

TimeZone

Object

Informations sur le fuseau horaire.

Nom	Type	Description
availableIds	string[]	Tableau d’ID disponibles.
default	TimeZone	Informations sur le fuseau horaire.
displayName	string	Nom complet du fuseau horaire.
dstSavings	integer (int32)	Valeur de l’heure d’été.
id	string	ID du fuseau horaire.
rawOffset	integer (int32)	Décalage brut du fuseau horaire.

TypeCategory

Énumération

Catégorie de type

Valeur	Description
ARRAY	tableau
CLASSIFICATION	classification
ENTITY	entité
ENUM	énumération
MAP	carte
OBJECT_ID_TYPE	type d’ID d’objet
PRIMITIVE	primitif
RELATIONSHIP	relation
STRUCT	Struct
TERM_TEMPLATE	modèle de terme