List Critical Data Element - List Critical Data Element

Service:: Purview

Version d'API:: 2025-09-15-preview

Recherche et récupère les éléments de données critiques en fonction du domaine, des mots-clés et d’autres filtres.

GET {endpoint}/datagovernance/catalog/criticalDataElements?api-version=2025-09-15-preview

Avec des paramètres facultatifs:

GET {endpoint}/datagovernance/catalog/criticalDataElements?api-version=2025-09-15-preview&domainId={domainId}&keyword={keyword}&orderBy={orderBy}&skip={skip}&top={top}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.
domainId	query		string (uuid)	S’il faut renvoyer des informations minimales pour les domaines référencés.
keyword	query		string	Mot-clé de recherche.
orderBy	query		string	Expressions qui spécifient l’ordre des résultats renvoyés.
skip	query		integer (int32)	Nombre d’éléments de résultat à ignorer.
top	query		integer (int32)	Nombre d’éléments de résultat à retourner.

Réponses

Nom	Type	Description
200 OK	PagedCriticalDataElement	La demande a réussi.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Réponse d’erreur inattendue. En-têtes x-ms-error-code: string

Nom

Type

Description

200 OK

PagedCriticalDataElement

La demande a réussi.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Réponse d’erreur inattendue.

En-têtes

x-ms-error-code: string

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

ListCriticalDataElement_MaximumSet

Exemple de requête

HTTP

GET {endpoint}/datagovernance/catalog/criticalDataElements?api-version=2025-09-15-preview&domainId=123e4567-e89b-12d3-a456-426614174000&keyword=PMA&orderBy=name&skip=0&top=17

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "status": "PUBLISHED",
      "dataType": "TEXT",
      "id": "123e4567-e89b-12d3-a456-426614174001",
      "name": "SamplePMA",
      "systemData": {
        "createdAt": "2025-01-15T10:30:00Z",
        "createdBy": "123e4567-e89b-12d3-a456-426614174002",
        "lastModifiedAt": "2025-01-16T14:45:00Z",
        "lastModifiedBy": "123e4567-e89b-12d3-a456-426614174003"
      },
      "domain": "123e4567-e89b-12d3-a456-426614174004",
      "description": "This is a sample critical data element for testing purposes",
      "contacts": {
        "owners": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174005",
            "description": "Primary owner"
          }
        ]
      },
      "managedAttributes": [
        {
          "name": "classification"
        },
        {
          "name": "sensitivity"
        }
      ]
    }
  ]
}

Définitions

Nom	Description
Azure.Core.Foundations.Error	Objet d’erreur.
Azure.Core.Foundations.ErrorResponse	Réponse contenant les détails de l’erreur.
Azure.Core.Foundations.InnerError	Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux directives de l’API REST Azure : https://aka.ms/AzureRestApiGuidelines#handling-errors.
CatalogModelCriticalDataElementDataTypeEnum	Types de données pris en charge pour les éléments de données critiques.
CatalogModelManagedAttribute	Configuration des attributs gérés pour les entités de catalogue.
CatalogModelStatus	Statut d’une entité de modèle de catalogue indiquant l’état de son cycle de vie.
CatalogModelSystemDataWithExpired	Métadonnées système avec informations d’expiration pour les entités de catalogue.
CriticalDataElement	Représente un élément de données critique dans le catalogue avec des métadonnées et des relations.
PagedCriticalDataElement	Collection paginée d’éléments CriticalDataElement

Azure.Core.Foundations.Error

Object

Objet d’erreur.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
details	Azure.Core.Foundations.Error[]	Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror	Azure.Core.Foundations.InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible par l’homme de l’erreur.
target	string	Cible de l’erreur.

Azure.Core.Foundations.ErrorResponse

Object

Réponse contenant les détails de l’erreur.

Nom	Type	Description
error	Azure.Core.Foundations.Error	Objet d’erreur.

Azure.Core.Foundations.InnerError

Object

Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux directives de l’API REST Azure : https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
innererror	Azure.Core.Foundations.InnerError	Erreur interne.

CatalogModelCriticalDataElementDataTypeEnum

Énumération

Types de données pris en charge pour les éléments de données critiques.

Valeur	Description
TEXT	Type de données texte.
NUMBER	Type de données numérique.
DATETIME	Type de données Date et heure.
BOOLEAN	Type de données booléen.

CatalogModelManagedAttribute

Object

Configuration des attributs gérés pour les entités de catalogue.

Nom	Type	Description
isRequired	boolean	Si cet attribut est obligatoire.
name	string	Nom de l’attribut managé.
value	string	Valeur de l’attribut.

CatalogModelStatus

Énumération

Statut d’une entité de modèle de catalogue indiquant l’état de son cycle de vie.

Valeur	Description
DRAFT	L’entité est à l’état de projet.
PUBLISHED	L’entité est publiée et active.
EXPIRED	L’entité a expiré et n’est plus active.

CatalogModelSystemDataWithExpired

Object

Métadonnées système avec informations d’expiration pour les entités de catalogue.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de l’enregistrement.
createdBy	string (uuid)	Identificateur unique de l’utilisateur qui a créé l’enregistrement.
expiredAt	string (date-time)	Horodatage à l’expiration de l’enregistrement.
expiredBy	string (uuid)	Identificateur unique de l’utilisateur qui a fait expirer l’enregistrement.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de l’enregistrement.
lastModifiedBy	string (uuid)	Identificateur unique de l’utilisateur qui a modifié l’enregistrement pour la dernière fois.

CriticalDataElement

Object

Représente un élément de données critique dans le catalogue avec des métadonnées et des relations.

Nom	Type	Description
contacts	object	Les contacts associés à cet élément de données critique.
dataType	CatalogModelCriticalDataElementDataTypeEnum	Type de données de l’élément de données critique.
description	string	Une description détaillée de l’élément de données critique.
domain	string (uuid)	Identificateur unique du domaine auquel cet élément appartient.
id	string (uuid)	L’identifiant unique de l’élément de données critique.
managedAttributes	CatalogModelManagedAttribute[]	Attributs gérés associés à cet élément de données critique.
name	string	Nom de l’élément de données critique.
status	CatalogModelStatus	L’état actuel de l’élément de données critique.
systemData	CatalogModelSystemDataWithExpired	Métadonnées du système, y compris les informations de création et de modification.

PagedCriticalDataElement

Object

Collection paginée d’éléments CriticalDataElement

Nom	Type	Description
nextLink	string (uri)	Lien vers la page suivante des éléments
value	CriticalDataElement[]	Les éléments CriticalDataElement sur cette page

Partager via

List Critical Data Element - List Critical Data Element

Paramètres URI

Réponses

Sécurité

OAuth2Auth

Étendues

Exemples

ListCriticalDataElement_MaximumSet

Exemple de requête

Exemple de réponse

Définitions

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

CatalogModelCriticalDataElementDataTypeEnum

CatalogModelManagedAttribute

CatalogModelStatus

CatalogModelSystemDataWithExpired

CriticalDataElement

PagedCriticalDataElement