Catalog - Search

Service:
Core
API-versie:
v1

De Cataloguszoekopdrachten-API maakt programmatische detectie mogelijk van OneLake-catalogusvermeldingen in werkruimten. Het ondersteunt zoeken tussen werkruimten via catalogusmetagegevens en retourneert resultaten die zijn gefilterd op vermeldingen die de aanroepende principal is gemachtigd voor toegang. Zoekresultaten bevatten stabiele id's die zijn bedoeld om te worden gebruikt met aanvullende Fabric-API's om aanvullende details op te halen of ondersteunde acties uit te voeren.

Opmerking

Cataloguszoekopdrachten zijn momenteel beschikbaar in preview (meer informatie).

Een CatalogEntry is een detecteerbare metagegevensweergave van een Microsoft Fabric-entiteit, die momenteel is gericht op werkruimte-items. Catalogusvermeldingen zijn alleen bedoeld voor detectie van metagegevens en verlenen geen toegang tot onderliggende gegevens of iteminhoud.

Permissions

De aanroeper kan alleen catalogusvermeldingen detecteren voor werkruimten en items waartoe de beller toegang heeft.

Vereiste gedelegeerde bevoegdheden

Catalog.Read.All

Beperkingen

  • continuationToken mag niet worden gecombineerd met search of filter. Het token draagt deze waarden al van de oorspronkelijke aanvraag.

  • pageSize moet tussen 1 en 1000 zijn.

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft-identiteiten die in deze sectie worden vermeld.

Identiteit Support
Gebruiker Ja
serviceprincipal en beheerde identiteiten Ja

Interface

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

Aanvraagbody

Naam Type Description
continuationToken

string

Het vervolgtoken voor de volgende pagina.

Een vervolgtoken voert de search, filteren pageSize van het oorspronkelijke verzoek door, zodat het op zichzelf kan worden verzonden. Deze mag niet worden gecombineerd met search of filter in dezelfde aanvraag. Als u dit doet, wordt er een fout geretourneerd.
filter

string

Het filter voor de zoekopdracht. Er kunnen in de loop van de tijd extra filteropties worden toegevoegd.

De filterparameter ondersteunt de volgende eigenschappen:

  • Type: Komt overeen met de type eigenschap van een catalogusvermelding, bijvoorbeeld Report, Lakehouseof Workspace. Eén filter kan maximaal 500 typewaarden opgeven, elk tot 50 tekens lang.

  • WorkspaceId: de id van de werkruimte die de catalogusvermelding bevat. Eén filter kan maximaal 12 WorkspaceId-waarden opgeven, die elk een geldige GUID moeten zijn.

De filterparameter ondersteunt de volgende operators om resultaten te verfijnen:

  • eq: is gelijk aan; komt overeen met de exacte waarde.

  • ne: Niet gelijk aan; sluit de opgegeven waarde uit.

  • en: logische EN; komt alleen overeen als aan alle voorwaarden wordt voldaan.

  • of: logische OR; komt overeen als aan een van de voorwaarden wordt voldaan.

  • ( ): haakjes; groepen expressies om logische hiërarchie te definiëren.
pageSize

integer

Het paginaformaat dat moet worden geretourneerd. Het paginaformaat moet tussen 1 en 1000 zijn. De standaardwaarde is 50.
search

string

De tekstquery voor de zoekopdracht. Dit veld ondersteunt zoeken in de weergavenaam, de weergavenaam van de werkruimte en de beschrijving van CatalogEntry.

Het zoekveld ondersteunt de volgende operators:

  • " " : dubbele aanhalingstekens; komen overeen met de ingesloten woorden als een exacte woordgroep.

  • * : sterretje; jokertekens die overeenkomen met nul of meer tekens.

  • ? : Vraagteken; jokertekens die overeenkomen met één teken.

  • && : Dubbele ampersanden; elke zoekterm vereisen.

  • Onderstrepingstekens worden behandeld als onderdeel van een zoekterm; geen escape is vereist.

  • Andere speciale tekens worden genegeerd en behandeld als scheidingstekens.

Antwoorden

Naam Type Description
200 OK

CatalogQueryResponse

OK
429 Too Many Requests

ErrorResponse

De servicesnelheidslimiet is overschreden. De server retourneert een Retry-After header die in seconden aangeeft hoe lang de client moet wachten voordat extra aanvragen worden verzonden.

Kopteksten

Retry-After: integer
Other Status Codes

ErrorResponse

Veelvoorkomende foutcodes:

  • InvalidRequest: de aanvraagbody is niet opgegeven of is anderszins ongeldig.

  • InvalidSearch: de search waarde kan niet worden geparseerd.

  • InvalidFilter: de filter waarde kan niet worden geparseerd of een filterwaarde is ongeldig of overschrijdt de maximale lengte.

  • InvalidFilterProperty : de filter verwijzingen naar een eigenschap die niet wordt ondersteund.

  • FilterTooManyValues : de filter geeft meer waarden op voor een eigenschap dan die eigenschap toestaat.

  • FilterNotSupported - Filteren wordt niet ondersteund.

  • ConflictingFilterParameters - continuationToken is gecombineerd met search of filter.

  • InvalidPageSize - pageSize ligt buiten het bereik 1 tot 1000.

  • InvalidContinuationToken : het continuationToken is ongeldig.

  • ContinuationTokenTooLong - De continuationToken overschrijdt de maximale lengte.

  • TypeNotFound - De filter verwijzingen naar een itemtype dat niet bestaat.

  • Niet geautoriseerd - Ontbrekende of ongeldige verificatie

  • Interne serverfout: onverwachte servicefout.

Voorbeelden

Search example
Search within a workspace example

Search example

Voorbeeldaanvraag

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'"
}

Voorbeeldrespons

Statuscode:
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

Voorbeeldaanvraag

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
}

Voorbeeldrespons

Statuscode:
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..."
}

Definities

Naam Description
CatalogEntryType

Het catalogusitemtype. Er kunnen in de loop van de tijd extra CatalogEntryType typen worden toegevoegd.
CatalogQueryRequest

De query voor de zoekopdracht.
CatalogQueryResponse

De resultaten van de zoekopdracht.
CatalogWorkspace

De werkruimte voor de catalogusvermelding.
ErrorParameter

Een gestructureerde parameter die extra machineleesbare context biedt over een fout.
ErrorRelatedResource

Het foutgerelateerde resourcedetailsobject.
ErrorResponse

De foutreactie.
ErrorResponseDetails

De details van het foutbericht.
ItemCatalogEntry

De catalogusmetagegevensweergave van een Fabric item.
ItemCatalogEntryHierarchy

De directe voorouders van het item in de gegevensarchitectuur van Fabric. Alleen toepasselijke niveaus worden geretourneerd.
ItemType

Het type item. Er kunnen in de loop van de tijd extra itemtypen worden toegevoegd.
WorkspaceCatalogEntry

De catalogusmetagegevensweergave van een Fabric werkruimte.
WorkspaceCatalogEntryType

Het type dat is gerapporteerd in een werkruimtecatalogusvermelding. Er kunnen in de loop van de tijd extra WorkspaceCatalogEntryType typen worden toegevoegd.

CatalogEntryType

Opsomming

Het catalogusitemtype. Er kunnen in de loop van de tijd extra CatalogEntryType typen worden toegevoegd.

Waarde Description
FabricItem

Een itemcatalogustype voor fabricitems.
Workspace

Een invoertype voor de werkruimtecatalogus.

CatalogQueryRequest

Object

De query voor de zoekopdracht.

Naam Type Description
continuationToken

string

Het vervolgtoken voor de volgende pagina.

Een vervolgtoken voert de search, filteren pageSize van het oorspronkelijke verzoek door, zodat het op zichzelf kan worden verzonden. Deze mag niet worden gecombineerd met search of filter in dezelfde aanvraag. Als u dit doet, wordt er een fout geretourneerd.
filter

string

Het filter voor de zoekopdracht. Er kunnen in de loop van de tijd extra filteropties worden toegevoegd.

De filterparameter ondersteunt de volgende eigenschappen:

  • Type: Komt overeen met de type eigenschap van een catalogusvermelding, bijvoorbeeld Report, Lakehouseof Workspace. Eén filter kan maximaal 500 typewaarden opgeven, elk tot 50 tekens lang.

  • WorkspaceId: de id van de werkruimte die de catalogusvermelding bevat. Eén filter kan maximaal 12 WorkspaceId-waarden opgeven, die elk een geldige GUID moeten zijn.

De filterparameter ondersteunt de volgende operators om resultaten te verfijnen:

  • eq: is gelijk aan; komt overeen met de exacte waarde.

  • ne: Niet gelijk aan; sluit de opgegeven waarde uit.

  • en: logische EN; komt alleen overeen als aan alle voorwaarden wordt voldaan.

  • of: logische OR; komt overeen als aan een van de voorwaarden wordt voldaan.

  • ( ): haakjes; groepen expressies om logische hiërarchie te definiëren.
pageSize

integer

Het paginaformaat dat moet worden geretourneerd. Het paginaformaat moet tussen 1 en 1000 zijn. De standaardwaarde is 50.
search

string

De tekstquery voor de zoekopdracht. Dit veld ondersteunt zoeken in de weergavenaam, de weergavenaam van de werkruimte en de beschrijving van CatalogEntry.

Het zoekveld ondersteunt de volgende operators:

  • " " : dubbele aanhalingstekens; komen overeen met de ingesloten woorden als een exacte woordgroep.

  • * : sterretje; jokertekens die overeenkomen met nul of meer tekens.

  • ? : Vraagteken; jokertekens die overeenkomen met één teken.

  • && : Dubbele ampersanden; elke zoekterm vereisen.

  • Onderstrepingstekens worden behandeld als onderdeel van een zoekterm; geen escape is vereist.

  • Andere speciale tekens worden genegeerd en behandeld als scheidingstekens.

CatalogQueryResponse

Object

De resultaten van de zoekopdracht.

Naam Type Description
continuationToken

string

Het vervolgtoken voor de volgende pagina.
value CatalogEntry[]:

Een lijst met catalogusvermeldingen

CatalogWorkspace

Object

De werkruimte voor de catalogusvermelding.

Naam Type Description
displayName

string

De weergavenaam van de werkruimte.
id

string (uuid)

De ID van de werkruimte.

ErrorParameter

Object

Een gestructureerde parameter die extra machineleesbare context biedt over een fout.

Naam Type Description
message

string

Een door mensen leesbare beschrijving van de betekenis van de parameter.
name

string

De parameter-id.
value

string

De waarde van de parameter.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Naam Type Description
resourceId

string

De resource-ID die betrokken is bij het probleem.
resourceType

string

Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

De foutreactie.

Naam Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
isRetriable

boolean

Wanneer waar, kan de aanvraag opnieuw worden geprobeerd. Gebruik de Retry-After antwoordheader om de vertraging te bepalen, indien beschikbaar.
message

string

Een leesbare weergave van de fout.
moreDetails

ErrorResponseDetails[]

Lijst met aanvullende foutdetails.
parameters

ErrorParameter[]

Gestructureerde parameters die extra machineleesbare context bieden over de fout.
relatedResource

ErrorRelatedResource

Details van de foutgerelateerde resource.
requestId

string (uuid)

Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Naam Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message

string

Een leesbare weergave van de fout.
parameters

ErrorParameter[]

Gestructureerde parameters die extra machineleesbare context bieden over de fout.
relatedResource

ErrorRelatedResource

Details van de foutgerelateerde resource.

ItemCatalogEntry

Object

De catalogusmetagegevensweergave van een Fabric item.

Naam Type Description
catalogEntryType string:

FabricItem

Het catalogusitemtype.
description

string

De beschrijving van de catalogusvermelding.
displayName

string

De weergavenaam van de catalogusvermelding.
hierarchy

ItemCatalogEntryHierarchy

De hiërarchie van de catalogusvermelding.
id

string (uuid)

De object-id van de catalogusvermelding.
type

ItemType

Het itemtype Fabric.

ItemCatalogEntryHierarchy

Object

De directe voorouders van het item in de gegevensarchitectuur van Fabric. Alleen toepasselijke niveaus worden geretourneerd.

Naam Type Description
workspace

CatalogWorkspace

De werkruimte die het item bevat.

ItemType

Opsomming

Het type item. Er kunnen in de loop van de tijd extra itemtypen worden toegevoegd.

Waarde Description
Dashboard

PowerBI-dashboard.
Report

PowerBI-rapport.
SemanticModel

Semantisch Power BI-model.
PaginatedReport

Gepagineerd Power BI-rapport.
Datamart

PowerBI-datamart.
Lakehouse

Een lakehouse.
Eventhouse

Een eventhouse.
Environment

Een omgeving.
KQLDatabase

Een KQL-database.
KQLQueryset

Een KQL-queryset.
KQLDashboard

Een KQL-dashboard.
DataPipeline

Een gegevenspijplijn.
Notebook

Een notitieblok.
SparkJobDefinition

Een Spark-taakdefinitie.
MLExperiment

Een machine learning-experiment.
MLModel

Een machine learning-model.
Warehouse

Een magazijn.
Eventstream

Een eventstream.
SQLEndpoint

Een SQL-eindpunt.
MirroredWarehouse

Een gespiegeld magazijn.
MirroredDatabase

Een gespiegelde database.
Reflex

Een reflex.
GraphQLApi

Een API voor GraphQL-item.
MountedDataFactory

Een MountedDataFactory.
SQLDatabase

Een SQLDatabase.
CopyJob

Een kopieertaak.
VariableLibrary

Een VariableLibrary.
Dataflow

Een gegevensstroom.
ApacheAirflowJob

Een ApacheAirflowJob.
WarehouseSnapshot

Een momentopname van een magazijn.
DigitalTwinBuilder

Een DigitalTwinBuilder.
DigitalTwinBuilderFlow

Een Digital Twin Builder Flow.
MirroredAzureDatabricksCatalog

Een gespiegelde Azure Databricks-catalogus.
Map

Een kaart.
AnomalyDetector

Een Anomaly Detector.
UserDataFunction

Een gebruikersgegevensfunctie.
GraphModel

Een GraphModel.
GraphQuerySet

Een Graph QuerySet.
SnowflakeDatabase

Een Snowflake-database voor het opslaan van Iceberg-tabellen die zijn gemaakt op basis van het Snowflake-account.
OperationsAgent

Een OperationsAgent.
CosmosDBDatabase

Een Cosmos DB-database.
Ontology

Een Ontologie.
EventSchemaSet

Een EventSchemaSet.
DataAgent

Een DataAgent.
MirroredCatalog

Een mirroredCatalog.
PolicySet

Een beleidsset.
AppBackend

Een AppBackend.
OrgApp

Een organisatie-app.
OrgAppAudience

Een organisatie-app-doelgroep.
DataBuildToolJob

Een DataBuildToolJob.
AzureDatabricksStorage

Een door OneLake ondersteund opslagitem voor Azure Databricks.
Plan

Een plan.
Monitoring

Een bewakingsitem.
DeploymentPlan

Een implementatieplan.

WorkspaceCatalogEntry

Object

De catalogusmetagegevensweergave van een Fabric werkruimte.

Naam Type Description
catalogEntryType string:

Workspace

Het catalogusitemtype.
description

string

De beschrijving van de catalogusvermelding.
displayName

string

De weergavenaam van de catalogusvermelding.
id

string (uuid)

De object-id van de catalogusvermelding.
type

WorkspaceCatalogEntryType

Het catalogusitemtype. Altijd Workspace voor vermeldingen in de werkruimtecatalogus.

WorkspaceCatalogEntryType

Opsomming

Het type dat is gerapporteerd in een werkruimtecatalogusvermelding. Er kunnen in de loop van de tijd extra WorkspaceCatalogEntryType typen worden toegevoegd.

Waarde Description
Workspace

Een werkruimte.