Catalog - Search

Tjänst:: Core

API-version:: v1

API:et för katalogsökning möjliggör programmatisk identifiering av OneLake-katalogposter mellan arbetsytor. Den stöder sökning mellan arbetsytor över katalogmetadata och returnerar resultat filtrerade till poster som anropande huvudnamn har behörighet att komma åt. Sökresultaten innehåller stabila identifierare som är avsedda att användas med kompletterande Infrastruktur-API:er för att hämta ytterligare information eller utföra åtgärder som stöds.

Anmärkning

Katalogsökning är för närvarande i förhandsversion (läs mer).

En CatalogEntry är en identifierbar metadatarepresentation av en Microsoft Fabric-entitet som för närvarande är begränsad till arbetsyteobjekt. Katalogposter är endast avsedda för metadataidentifiering och beviljar inte åtkomst till underliggande data eller objektinnehåll.

Permissions

Anroparen kan bara identifiera katalogposter för arbetsytor och objekt som anroparen har behörighet att komma åt.

Obligatoriska delegerade omfång

Catalog.Read.All

Begränsningar

continuationToken får inte kombineras med search eller filter. Token bär redan dessa värden från den ursprungliga begäran.
pageSize måste vara mellan 1 och 1000.

Identiteter som stöds av Microsoft Entra

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identitet	Support
User	Ja
Tjänsthuvudnamn och hanterade identiteter	Ja

Gränssnitt

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

Begärandetext

Name	Typ	Description
continuationToken	string	Fortsättningstoken för nästa sida. En fortsättningstoken vidarebefordrar `search`, `filter`och `pageSize` för den ursprungliga begäran, så den kan skickas på egen hand. Det får inte kombineras med `search` eller `filter` i samma begäran. Om du gör det returneras ett fel.
filter	string	Filtret för sökningen. Ytterligare filteralternativ kan läggas till över tid. Filterparametern stöder följande egenskaper: Typ: Matchar `type` egenskapen för en katalogpost, till exempel `Report`, `Lakehouse`eller `Workspace`. Ett enda filter kan ange högst 500 typvärden, var och en upp till 50 tecken lång. WorkspaceId: ID för arbetsytan som innehåller katalogposten. Ett enda filter kan ange högst 12 WorkspaceId-värden, som var och en måste vara ett giltigt GUID. Filterparametern stöder följande operatorer för att förfina resultaten: eq: Lika med; matchar det exakta värdet. ne: Inte lika med; exkluderar det angivna värdet. och: Logisk AND; matchar endast om alla villkor är sanna. eller: Logisk ELLER; matchar om något av villkoren är sant. ( ): Parenteser; grupperar uttryck för att definiera logisk hierarki.
pageSize	integer	Sidstorleken som måste returneras. Sidstorleken måste vara mellan 1 och 1 000. Standardinställningen är 50.
search	string	Textfrågan för sökningen. Det här fältet stöder sökning i visningsnamnet, arbetsytans visningsnamn och beskrivningen av CatalogEntry. Sökfältet stöder följande operatorer: " " : Dubbla citattecken; matcha de omslutna orden som en exakt fras. * : Asterisk; jokertecken som matchar noll eller fler tecken. ? : Frågetecken; jokertecken som matchar ett enskilt tecken. &&: Dubbelgångare; kräver varje sökord. Understreck behandlas som en del av en sökterm. ingen undflyende krävs. Andra specialtecken ignoreras och behandlas som avgränsare.

Svar

Name Typ Description

200 OK

Name	Typ	Description
200 OK	CatalogQueryResponse	OK
429 Too Many Requests	ErrorResponse	Gränsen för tjänstfrekvens överskreds. Servern returnerar ett `Retry-After` huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas. Sidhuvuden Retry-After: integer
Other Status Codes	ErrorResponse	Vanliga felkoder: InvalidRequest – begärandetexten angavs inte eller är på annat sätt ogiltig. InvalidSearch – Det `search` gick inte att parsa värdet. InvalidFilter – Det `filter` gick inte att parsa, eller så är ett filtervärde felaktigt eller överskrider dess maximala längd. InvalidFilterProperty – `filter` refererar till en egenskap som inte stöds. FilterTooManyValues – `filter` anger fler värden för en egenskap än vad egenskapen tillåter. FilterNotSupported – Filtrering stöds inte. ConflictingFilterParameters – `continuationToken` kombinerades med `search` eller `filter`. InvalidPageSize – `pageSize` ligger utanför intervallet 1 till 1 000. InvalidContinuationToken – är `continuationToken` ogiltigt. ContinuationTokenTooLong – överskrider `continuationToken` den maximala längden. TypeNotFound – `filter` refererar till en objekttyp som inte finns. Obehörig – autentisering saknas eller är ogiltig Internt serverfel – Oväntat tjänstfel.

CatalogQueryResponse

429 Too Many Requests

ErrorResponse

Gränsen för tjänstfrekvens överskreds. Servern returnerar ett Retry-After huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas.

Sidhuvuden

Retry-After: integer

Other Status Codes

ErrorResponse

Vanliga felkoder:

InvalidRequest – begärandetexten angavs inte eller är på annat sätt ogiltig.
InvalidSearch – Det search gick inte att parsa värdet.
InvalidFilter – Det filter gick inte att parsa, eller så är ett filtervärde felaktigt eller överskrider dess maximala längd.
InvalidFilterProperty – filter refererar till en egenskap som inte stöds.
FilterTooManyValues – filter anger fler värden för en egenskap än vad egenskapen tillåter.
FilterNotSupported – Filtrering stöds inte.
ConflictingFilterParameters – continuationToken kombinerades med search eller filter.
InvalidPageSize – pageSize ligger utanför intervallet 1 till 1 000.
InvalidContinuationToken – är continuationToken ogiltigt.
ContinuationTokenTooLong – överskrider continuationToken den maximala längden.
TypeNotFound – filter refererar till en objekttyp som inte finns.
Obehörig – autentisering saknas eller är ogiltig
Internt serverfel – Oväntat tjänstfel.

Exempel

Search example

Search within a workspace example

Search example

Exempelbegäran

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

Exempelsvar

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

Exempelbegäran

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
}

Exempelsvar

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

Definitioner

Name	Description
CatalogEntryType	Posttypen katalog. Ytterligare `CatalogEntryType` typer kan läggas till över tid.
CatalogQueryRequest	Frågan för sökningen.
CatalogQueryResponse	Resultatet av sökningen.
CatalogWorkspace	Arbetsytan för katalogposten.
ErrorParameter	En strukturerad parameter som ger ytterligare datorläsbar kontext om ett fel.
ErrorRelatedResource	Det felrelaterade resursinformationsobjektet.
ErrorResponse	Felsvaret.
ErrorResponseDetails	Detaljer om felsvaret.
ItemCatalogEntry	Katalogmetadatarepresentationen av ett Fabric objekt.
ItemCatalogEntryHierarchy	Objektets omedelbara överordnade objekt i Fabric dataarkitektur. Endast tillämpliga nivåer returneras.
ItemType	Typ av objekt. Ytterligare objekttyper kan läggas till över tid.
WorkspaceCatalogEntry	Katalogmetadatarepresentationen av en Fabric arbetsyta.
WorkspaceCatalogEntryType	Den typ som rapporterats för en arbetsytekatalogpost. Ytterligare `WorkspaceCatalogEntryType` typer kan läggas till över tid.

CatalogEntryType

Uppräkning

Posttypen katalog. Ytterligare CatalogEntryType typer kan läggas till över tid.

Värde	Description
FabricItem	En posttyp för katalog för infrastrukturobjekt.
Workspace	En posttyp för arbetsytans katalog.

CatalogQueryRequest

Objekt

Frågan för sökningen.

Name	Typ	Description
continuationToken	string	Fortsättningstoken för nästa sida. En fortsättningstoken vidarebefordrar `search`, `filter`och `pageSize` för den ursprungliga begäran, så den kan skickas på egen hand. Det får inte kombineras med `search` eller `filter` i samma begäran. Om du gör det returneras ett fel.
filter	string	Filtret för sökningen. Ytterligare filteralternativ kan läggas till över tid. Filterparametern stöder följande egenskaper: Typ: Matchar `type` egenskapen för en katalogpost, till exempel `Report`, `Lakehouse`eller `Workspace`. Ett enda filter kan ange högst 500 typvärden, var och en upp till 50 tecken lång. WorkspaceId: ID för arbetsytan som innehåller katalogposten. Ett enda filter kan ange högst 12 WorkspaceId-värden, som var och en måste vara ett giltigt GUID. Filterparametern stöder följande operatorer för att förfina resultaten: eq: Lika med; matchar det exakta värdet. ne: Inte lika med; exkluderar det angivna värdet. och: Logisk AND; matchar endast om alla villkor är sanna. eller: Logisk ELLER; matchar om något av villkoren är sant. ( ): Parenteser; grupperar uttryck för att definiera logisk hierarki.
pageSize	integer	Sidstorleken som måste returneras. Sidstorleken måste vara mellan 1 och 1 000. Standardinställningen är 50.
search	string	Textfrågan för sökningen. Det här fältet stöder sökning i visningsnamnet, arbetsytans visningsnamn och beskrivningen av CatalogEntry. Sökfältet stöder följande operatorer: " " : Dubbla citattecken; matcha de omslutna orden som en exakt fras. * : Asterisk; jokertecken som matchar noll eller fler tecken. ? : Frågetecken; jokertecken som matchar ett enskilt tecken. &&: Dubbelgångare; kräver varje sökord. Understreck behandlas som en del av en sökterm. ingen undflyende krävs. Andra specialtecken ignoreras och behandlas som avgränsare.

CatalogQueryResponse

Objekt

Resultatet av sökningen.

Name	Typ	Description
continuationToken	string	continuationToken för nästa sida.
value	CatalogEntry[]: ItemCatalogEntry[] WorkspaceCatalogEntry[]	En lista över katalogposter

CatalogWorkspace

Objekt

Arbetsytan för katalogposten.

Name	Typ	Description
displayName	string	Arbetsytans visningsnamn.
id	string (uuid)	Arbetsområdets ID.

ErrorParameter

Objekt

En strukturerad parameter som ger ytterligare datorläsbar kontext om ett fel.

Name	Typ	Description
message	string	En beskrivning av parameterns betydelse som kan läsas av människor.
name	string	Parameteridentifieraren.
value	string	Parametervärdet.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Name	Typ	Description
resourceId	string	Resurs-ID:t som är inblandat i felet.
resourceType	string	Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
isRetriable	boolean	När det är sant kan begäran göras på nytt. Använd svarshuvudet `Retry-After` för att fastställa fördröjningen, om den är tillgänglig.
message	string	En mänsklig läsbar representation av felet.
moreDetails	ErrorResponseDetails[]	Lista över ytterligare felinformation.
parameters	ErrorParameter[]	Strukturerade parametrar som ger ytterligare datorläsbar kontext om felet.
relatedResource	ErrorRelatedResource	Detaljer om resursen relaterad till felet.
requestId	string (uuid)	ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Detaljer om felsvaret.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
parameters	ErrorParameter[]	Strukturerade parametrar som ger ytterligare datorläsbar kontext om felet.
relatedResource	ErrorRelatedResource	Detaljer om resursen relaterad till felet.

ItemCatalogEntry

Objekt

Katalogmetadatarepresentationen av ett Fabric objekt.

Name	Typ	Description
catalogEntryType	string: FabricItem	Posttypen katalog.
description	string	Beskrivningen av katalogposten.
displayName	string	Visningsnamnet för katalogposten.
hierarchy	ItemCatalogEntryHierarchy	Hierarkin för katalogposten.
id	string (uuid)	ObjectId för katalogposten.
type	ItemType	Typ av infrastrukturobjekt.

ItemCatalogEntryHierarchy

Objekt

Objektets omedelbara överordnade objekt i Fabric dataarkitektur. Endast tillämpliga nivåer returneras.

Name	Typ	Description
workspace	CatalogWorkspace	Arbetsytan som innehåller objektet.

ItemType

Uppräkning

Typ av objekt. Ytterligare objekttyper kan läggas till över tid.

Värde	Description
Dashboard	PowerBI-instrumentpanel.
Report	PowerBI-rapport.
SemanticModel	PowerBI-semantisk modell.
PaginatedReport	Sidnumrerad PowerBI-rapport.
Datamart	PowerBI-datamart.
Lakehouse	Ett sjöhus.
Eventhouse	Ett eventhouse.
Environment	En miljö.
KQLDatabase	En KQL-databas.
KQLQueryset	En KQL-frågeuppsättning.
KQLDashboard	En KQL-instrumentpanel.
DataPipeline	En datapipeline.
Notebook	En anteckningsbok.
SparkJobDefinition	En definition för Spark-jobb.
MLExperiment	Ett maskininlärningsexperiment.
MLModel	En maskininlärningsmodell.
Warehouse	Ett lager.
Eventstream	En händelseström.
SQLEndpoint	En SQL-slutpunkt.
MirroredWarehouse	Ett speglat lager.
MirroredDatabase	En speglad databas.
Reflex	En reflex.
GraphQLApi	Ett API för GraphQL-objekt.
MountedDataFactory	En MountedDataFactory.
SQLDatabase	En SQLDatabase.
CopyJob	Ett kopieringsjobb.
VariableLibrary	En VariableLibrary.
Dataflow	Ett dataflöde.
ApacheAirflowJob	Ett ApacheAirflowJob.
WarehouseSnapshot	En ögonblicksbild av lagret.
DigitalTwinBuilder	En DigitalTwinBuilder.
DigitalTwinBuilderFlow	Ett Digital Twin Builder Flow.
MirroredAzureDatabricksCatalog	En speglad azure databricks-katalog.
Map	En karta.
AnomalyDetector	En avvikelseidentifiering.
UserDataFunction	En användardatafunktion.
GraphModel	En GraphModel.
GraphQuerySet	En Graph QuerySet.
SnowflakeDatabase	En Snowflake-databas för att lagra isbergstabeller som skapats från Snowflake-kontot.
OperationsAgent	En OperationsAgent.
CosmosDBDatabase	En Cosmos DB-databas.
Ontology	En ontologi.
EventSchemaSet	En EventSchemaSet.
DataAgent	En DataAgent.
MirroredCatalog	En MirroredCatalog.
PolicySet	En principuppsättning.
AppBackend	En AppBackend.
OrgApp	En organisationsapp.
OrgAppAudience	En målgrupp för en organisationsapp.
DataBuildToolJob	Ett DataBuildToolJob.
AzureDatabricksStorage	Ett OneLake-säkerhetskopierat lagringsobjekt för Azure Databricks.
Plan	En plan.
Monitoring	Ett övervakningsobjekt.
DeploymentPlan	En distributionsplan.
ShareSubscription	En resursprenumeration.
Share	En resurs.

WorkspaceCatalogEntry

Objekt

Katalogmetadatarepresentationen av en Fabric arbetsyta.

Name	Typ	Description
catalogEntryType	string: Workspace	Posttypen katalog.
description	string	Beskrivningen av katalogposten.
displayName	string	Visningsnamnet för katalogposten.
id	string (uuid)	ObjectId för katalogposten.
type	WorkspaceCatalogEntryType	Posttypen katalog. Alltid `Workspace` för katalogposter för arbetsytor.

WorkspaceCatalogEntryType

Uppräkning

Den typ som rapporterats för en arbetsytekatalogpost. Ytterligare WorkspaceCatalogEntryType typer kan läggas till över tid.

Värde	Description
Workspace	En arbetsyta.