Catalog - Search

Service:: Core

Version d’API:: v1

L’API Recherche de catalogue permet la découverte programmatique des entrées de catalogue OneLake dans les espaces de travail. Il prend en charge la recherche inter-espaces de travail sur les métadonnées du catalogue et retourne les résultats filtrés sur les entrées que le principal appelant est autorisé à accéder. Les résultats de la recherche incluent des identificateurs stables destinés à être utilisés avec des API Fabric complémentaires pour récupérer des détails supplémentaires ou effectuer des actions prises en charge.

Note

La recherche de catalogue est actuellement en préversion (en savoir plus).

Un CatalogEntry est une représentation de métadonnées détectable d’une entité Microsoft Fabric, actuellement étendue aux éléments de l’espace de travail. Les entrées de catalogue sont destinées uniquement à la découverte de métadonnées et n’accordent pas l’accès aux données sous-jacentes ou au contenu d’élément.

Permissions

L’appelant ne peut découvrir que les entrées de catalogue pour les espaces de travail et les éléments auxquels l’appelant est autorisé à accéder.

Étendues déléguées requises

Catalog.Read.All

Limites

continuationToken ne doit pas être combiné avec search ou filter. Le jeton contient déjà ces valeurs à partir de la requête d’origine.
pageSize doit être compris entre 1 et 1 000.

Identités prises en charge par Microsoft Entra

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identité	Support
Utilisateur	Oui
Service principal et identités gérées	Oui

Interface

POST https://api.fabric.microsoft.com/v1/catalog/search

Corps de la demande

Nom	Type	Description
continuationToken	string	Jeton de continuation pour la page suivante. Un jeton de continuation transfère le `search`, `filter`et `pageSize` de la requête d’origine, de sorte qu’il peut être envoyé seul. Elle ne doit pas être combinée avec `search` ou `filter` dans la même requête ; cette opération retourne une erreur.
filter	string	Filtre de la recherche. Des options de filtre supplémentaires peuvent être ajoutées au fil du temps. Le paramètre de filtre prend en charge les propriétés suivantes : Type : correspond à la `type` propriété d’une entrée de catalogue, par exemple `Report`, `Lakehouse`ou `Workspace`. Un seul filtre peut spécifier au maximum 500 valeurs de type, chacune pouvant atteindre 50 caractères. WorkspaceId : ID de l’espace de travail qui contient l’entrée de catalogue. Un seul filtre peut spécifier au maximum 12 valeurs WorkspaceId, chacune d’elles devant être un GUID valide. Le paramètre de filtre prend en charge les opérateurs suivants pour affiner les résultats : eq : Equals ; correspond à la valeur exacte. ne : Non égal ; exclut la valeur spécifiée. et : AND logique ; correspond uniquement si toutes les conditions sont remplies. ou : OR logique ; correspond si l’une des conditions est vraie. () : parenthèses ; regroupe des expressions pour définir une hiérarchie logique.
pageSize	integer	Taille de page à renvoyer. La taille de page doit être comprise entre 1 et 1 000. La valeur par défaut est 50.
search	string	Requête de texte pour la recherche. Ce champ prend en charge la recherche dans le nom d’affichage, le nom d’affichage de l’espace de travail et la description de CatalogEntry. Le champ de recherche prend en charge les opérateurs suivants : « " : Guillemets doubles ; mettre en correspondance les mots placés sous forme d’une expression exacte. * : Astérisque ; caractères génériques correspondant à zéro ou plusieurs caractères. ? : Point d’interrogation ; caractère générique correspondant à un caractère unique. &> : Double ampersands ; nécessite chaque terme de recherche. Les traits de soulignement sont traités dans le cadre d’un terme de recherche ; aucune échappement n’est requise. D’autres caractères spéciaux sont ignorés et traités comme séparateurs.

Réponses

Nom Type Description

200 OK

Nom	Type	Description
200 OK	CatalogQueryResponse	Ok
429 Too Many Requests	ErrorResponse	La limite de débit de service a été dépassée. Le serveur retourne un `Retry-After` en-tête indiquant, en secondes, combien de temps le client doit attendre avant d’envoyer des demandes supplémentaires. En-têtes Retry-After: integer
Other Status Codes	ErrorResponse	Codes d’erreur courants : InvalidRequest : le corps de la demande n’a pas été fourni ou n’est pas valide. InvalidSearch : la `search` valeur n’a pas pu être analysée. InvalidFilter : impossible `filter` d’analyser, ou une valeur de filtre est incorrecte ou dépasse sa longueur maximale. InvalidFilterProperty : fait `filter` référence à une propriété qui n’est pas prise en charge. FilterTooManyValues : `filter` spécifie plus de valeurs pour une propriété que cette propriété autorise. FilterNotSupported : le filtrage n’est pas pris en charge. ConflictingFilterParameters - `continuationToken` a été combiné avec `search` ou `filter`. InvalidPageSize : `pageSize` se trouve en dehors de la plage 1 à 1 000. InvalidContinuationToken : `continuationToken` non valide. ContinuationTokenTooLong : `continuationToken` dépasse la longueur maximale. TypeNotFound : `filter` fait référence à un type d’élément qui n’existe pas. Non autorisé - Authentification manquante ou non valide Erreur interne du serveur : échec inattendu du service.

CatalogQueryResponse

429 Too Many Requests

ErrorResponse

La limite de débit de service a été dépassée. Le serveur retourne un Retry-After en-tête indiquant, en secondes, combien de temps le client doit attendre avant d’envoyer des demandes supplémentaires.

En-têtes

Retry-After: integer

Other Status Codes

ErrorResponse

Codes d’erreur courants :

InvalidRequest : le corps de la demande n’a pas été fourni ou n’est pas valide.
InvalidSearch : la search valeur n’a pas pu être analysée.
InvalidFilter : impossible filter d’analyser, ou une valeur de filtre est incorrecte ou dépasse sa longueur maximale.
InvalidFilterProperty : fait filter référence à une propriété qui n’est pas prise en charge.
FilterTooManyValues : filter spécifie plus de valeurs pour une propriété que cette propriété autorise.
FilterNotSupported : le filtrage n’est pas pris en charge.
ConflictingFilterParameters - continuationToken a été combiné avec search ou filter.
InvalidPageSize : pageSize se trouve en dehors de la plage 1 à 1 000.
InvalidContinuationToken : continuationToken non valide.
ContinuationTokenTooLong : continuationToken dépasse la longueur maximale.
TypeNotFound : filter fait référence à un type d’élément qui n’existe pas.
Non autorisé - Authentification manquante ou non valide
Erreur interne du serveur : échec inattendu du service.

Exemples

Search example

Search within a workspace example

Search example

Exemple de requête

HTTP

POST https://api.fabric.microsoft.com/v1/catalog/search

{
  "search": "sales",
  "pageSize": 3,
  "filter": "Type eq 'Report' or Type eq 'Lakehouse' or Type eq 'Workspace'"
}

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "id": "0acd697c-1550-43cd-b998-91bfb12347c6",
      "type": "Report",
      "catalogEntryType": "FabricItem",
      "displayName": "Monthly Sales Revenue",
      "description": "Consolidated revenue report for the current fiscal year.",
      "hierarchy": {
        "workspace": {
          "id": "7f2c8a91-3b4d-4e5f-a6b7-c8d9e0f1a2b3",
          "displayName": "Sales Analytics"
        }
      }
    },
    {
      "id": "5e8f2a1b-9c3d-4e7f-b6a5-d4c3b2a1e0f9",
      "type": "Lakehouse",
      "catalogEntryType": "FabricItem",
      "displayName": "Sales Revenue Lakehouse",
      "description": "Central lakehouse for sales transaction data.",
      "hierarchy": {
        "workspace": {
          "id": "a2b3c4d5-e6f7-4a8b-9c0d-1e2f3a4b5c6d",
          "displayName": "Finance Platform"
        }
      }
    },
    {
      "id": "7f2c8a91-3b4d-4e5f-a6b7-c8d9e0f1a2b3",
      "type": "Workspace",
      "catalogEntryType": "Workspace",
      "displayName": "Sales Analytics",
      "description": "Workspace for the sales analytics team."
    }
  ],
  "continuationToken": "eyJza2lwIjozLCJ0YWtl..."
}

Search within a workspace example

Exemple de requête

HTTP

POST https://api.fabric.microsoft.com/v1/catalog/search

{
  "search": "revenue",
  "filter": "(Type eq 'Report' or Type eq 'SemanticModel') and WorkspaceId eq '7f2c8a91-3b4d-4e5f-a6b7-c8d9e0f1a2b3'",
  "pageSize": 2
}

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "id": "0acd697c-1550-43cd-b998-91bfb12347c6",
      "type": "Report",
      "catalogEntryType": "FabricItem",
      "displayName": "Monthly Sales Revenue",
      "description": "Consolidated revenue report for the current fiscal year.",
      "hierarchy": {
        "workspace": {
          "id": "7f2c8a91-3b4d-4e5f-a6b7-c8d9e0f1a2b3",
          "displayName": "Sales Analytics"
        }
      }
    },
    {
      "id": "c41d9f2e-7b60-4a15-8d3c-2f6e9a0b7c48",
      "type": "SemanticModel",
      "catalogEntryType": "FabricItem",
      "displayName": "Revenue Semantic Model",
      "description": "Shared revenue model backing the sales reports.",
      "hierarchy": {
        "workspace": {
          "id": "7f2c8a91-3b4d-4e5f-a6b7-c8d9e0f1a2b3",
          "displayName": "Sales Analytics"
        }
      }
    }
  ],
  "continuationToken": "eyJza2lwIjoyLCJ0YWtl..."
}

Définitions

Nom	Description
CatalogEntryType	Type d’entrée de catalogue. Des types `CatalogEntryType` supplémentaires peuvent être ajoutés au fil du temps.
CatalogQueryRequest	Requête pour la recherche.
CatalogQueryResponse	Résultats de la recherche.
CatalogWorkspace	Espace de travail pour l’entrée de catalogue.
ErrorParameter	Paramètre structuré fournissant un contexte lisible par l’ordinateur supplémentaire à propos d’une erreur.
ErrorRelatedResource	Objet de détails de ressource associé à l’erreur.
ErrorResponse	Réponse d’erreur.
ErrorResponseDetails	Détails de la réponse d’erreur.
ItemCatalogEntry	Représentation des métadonnées de catalogue d’un élément Fabric.
ItemCatalogEntryHierarchy	Ancêtres immédiats de l'élément dans l'architecture de données de Fabric. Seuls les niveaux applicables sont retournés.
ItemType	Type de l’élément. Des types d’éléments supplémentaires peuvent être ajoutés au fil du temps.
WorkspaceCatalogEntry	Représentation des métadonnées de catalogue d’un espace de travail Fabric.
WorkspaceCatalogEntryType	Type signalé sur une entrée de catalogue d’espace de travail. Des types `WorkspaceCatalogEntryType` supplémentaires peuvent être ajoutés au fil du temps.

CatalogEntryType

Énumération

Type d’entrée de catalogue. Des types CatalogEntryType supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
FabricItem	Type d’entrée de catalogue d’éléments de structure.
Workspace	Type d’entrée de catalogue d’espace de travail.

CatalogQueryRequest

Objet

Requête pour la recherche.

Nom	Type	Description
continuationToken	string	Jeton de continuation pour la page suivante. Un jeton de continuation transfère le `search`, `filter`et `pageSize` de la requête d’origine, de sorte qu’il peut être envoyé seul. Elle ne doit pas être combinée avec `search` ou `filter` dans la même requête ; cette opération retourne une erreur.
filter	string	Filtre de la recherche. Des options de filtre supplémentaires peuvent être ajoutées au fil du temps. Le paramètre de filtre prend en charge les propriétés suivantes : Type : correspond à la `type` propriété d’une entrée de catalogue, par exemple `Report`, `Lakehouse`ou `Workspace`. Un seul filtre peut spécifier au maximum 500 valeurs de type, chacune pouvant atteindre 50 caractères. WorkspaceId : ID de l’espace de travail qui contient l’entrée de catalogue. Un seul filtre peut spécifier au maximum 12 valeurs WorkspaceId, chacune d’elles devant être un GUID valide. Le paramètre de filtre prend en charge les opérateurs suivants pour affiner les résultats : eq : Equals ; correspond à la valeur exacte. ne : Non égal ; exclut la valeur spécifiée. et : AND logique ; correspond uniquement si toutes les conditions sont remplies. ou : OR logique ; correspond si l’une des conditions est vraie. () : parenthèses ; regroupe des expressions pour définir une hiérarchie logique.
pageSize	integer	Taille de page à renvoyer. La taille de page doit être comprise entre 1 et 1 000. La valeur par défaut est 50.
search	string	Requête de texte pour la recherche. Ce champ prend en charge la recherche dans le nom d’affichage, le nom d’affichage de l’espace de travail et la description de CatalogEntry. Le champ de recherche prend en charge les opérateurs suivants : « " : Guillemets doubles ; mettre en correspondance les mots placés sous forme d’une expression exacte. * : Astérisque ; caractères génériques correspondant à zéro ou plusieurs caractères. ? : Point d’interrogation ; caractère générique correspondant à un caractère unique. &> : Double ampersands ; nécessite chaque terme de recherche. Les traits de soulignement sont traités dans le cadre d’un terme de recherche ; aucune échappement n’est requise. D’autres caractères spéciaux sont ignorés et traités comme séparateurs.

CatalogQueryResponse

Objet

Résultats de la recherche.

Nom	Type	Description
continuationToken	string	ContinuationToken pour la page suivante.
value	CatalogEntry[]: ItemCatalogEntry[] WorkspaceCatalogEntry[]	Liste des entrées de catalogue

CatalogWorkspace

Objet

Espace de travail pour l’entrée de catalogue.

Nom	Type	Description
displayName	string	Nom d'affichage de l’espace de travail.
id	string (uuid)	L'identifiant de l’espace de travail.

ErrorParameter

Objet

Paramètre structuré fournissant un contexte lisible par l’ordinateur supplémentaire à propos d’une erreur.

Nom	Type	Description
message	string	Description lisible par l’homme de la signification du paramètre.
name	string	L’identifiant de paramètre.
value	string	Représente la valeur du paramètre.

ErrorRelatedResource

Objet

Objet de détails de ressource associé à l’erreur.

Nom	Type	Description
resourceId	string	ID de ressource impliqué dans l’erreur.
resourceType	string	Type de la ressource impliquée dans l’erreur.

ErrorResponse

Objet

Réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
isRetriable	boolean	Lorsque la valeur est true, la requête peut être retentée. Utilisez l’en-tête `Retry-After` de réponse pour déterminer le délai, le cas échéant.
message	string	Représentation lisible humaine de l’erreur.
moreDetails	ErrorResponseDetails[]	Liste des détails d’erreur supplémentaires.
parameters	ErrorParameter[]	Paramètres structurés fournissant un contexte lisible par l’ordinateur supplémentaire sur l’erreur.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.
requestId	string (uuid)	ID de la demande associée à l’erreur.

ErrorResponseDetails

Objet

Détails de la réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message	string	Représentation lisible humaine de l’erreur.
parameters	ErrorParameter[]	Paramètres structurés fournissant un contexte lisible par l’ordinateur supplémentaire sur l’erreur.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.

ItemCatalogEntry

Objet

Représentation des métadonnées de catalogue d’un élément Fabric.

Nom	Type	Description
catalogEntryType	string: FabricItem	Type d’entrée de catalogue.
description	string	Description de l’entrée de catalogue.
displayName	string	Nom complet de l’entrée de catalogue.
hierarchy	ItemCatalogEntryHierarchy	Hiérarchie de l’entrée de catalogue.
id	string (uuid)	ObjectId de l’entrée de catalogue.
type	ItemType	Type d’élément Fabric.

ItemCatalogEntryHierarchy

Objet

Ancêtres immédiats de l'élément dans l'architecture de données de Fabric. Seuls les niveaux applicables sont retournés.

Nom	Type	Description
workspace	CatalogWorkspace	Espace de travail qui contient l’élément.

ItemType

Énumération

Type de l’élément. Des types d’éléments supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
Dashboard	Tableau de bord PowerBI.
Report	Rapport PowerBI.
SemanticModel	Modèle sémantique PowerBI.
PaginatedReport	Rapport paginé PowerBI.
Datamart	Datamart PowerBI.
Lakehouse	Un lac.
Eventhouse	Un eventhouse.
Environment	Environnement.
KQLDatabase	Base de données KQL.
KQLQueryset	Ensemble de requêtes KQL.
KQLDashboard	Tableau de bord KQL.
DataPipeline	Un pipeline de données.
Notebook	Un notebook.
SparkJobDefinition	Définition d’un travail Spark.
MLExperiment	Une expérience de Machine Learning.
MLModel	Modèle Machine Learning.
Warehouse	Un entrepôt.
Eventstream	Flux d’événements.
SQLEndpoint	Point de terminaison SQL.
MirroredWarehouse	Un entrepôt mis en miroir.
MirroredDatabase	Une base de données mise en miroir.
Reflex	Un réflexe.
GraphQLApi	API pour l’élément GraphQL.
MountedDataFactory	Un MountedDataFactory.
SQLDatabase	A SQLDatabase.
CopyJob	Tâche de copie.
VariableLibrary	A VariableLibrary.
Dataflow	Flux de données.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Capture instantanée de l’entrepôt.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Flux de générateur de jumeaux numériques.
MirroredAzureDatabricksCatalog	Catalogue Azure databricks mis en miroir.
Map	Carte.
AnomalyDetector	Détecteur d’anomalies.
UserDataFunction	Fonction de données utilisateur.
GraphModel	A GraphModel.
GraphQuerySet	Ensemble de requêtes Graph.
SnowflakeDatabase	Une base de données Snowflake pour stocker les tables Iceberg créées à partir du compte Snowflake.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	Base de données Cosmos DB.
Ontology	Une ontologie.
EventSchemaSet	An EventSchemaSet.
DataAgent	A DataAgent.
MirroredCatalog	A MirroredCatalog.
PolicySet	Ensemble de stratégies.
AppBackend	An AppBackend.
OrgApp	Une application d’organisation.
OrgAppAudience	Audience d’application d’organisation.
DataBuildToolJob	A DataBuildToolJob.
AzureDatabricksStorage	Élément de stockage soutenu par OneLake pour Azure Databricks.
Plan	Un plan.
Monitoring	Élément de surveillance.
DeploymentPlan	Un plan de déploiement.

WorkspaceCatalogEntry

Objet

Représentation des métadonnées de catalogue d’un espace de travail Fabric.

Nom	Type	Description
catalogEntryType	string: Workspace	Type d’entrée de catalogue.
description	string	Description de l’entrée de catalogue.
displayName	string	Nom complet de l’entrée de catalogue.
id	string (uuid)	ObjectId de l’entrée de catalogue.
type	WorkspaceCatalogEntryType	Type d’entrée de catalogue. Toujours `Workspace` pour les entrées de catalogue d’espace de travail.

WorkspaceCatalogEntryType

Énumération

Type signalé sur une entrée de catalogue d’espace de travail. Des types WorkspaceCatalogEntryType supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
Workspace	Un espace de travail.