Catalog - Search

Palvelu:
Core
Ohjelmointirajapinnan versio:
v1

Hakemistohaun ohjelmointirajapinta mahdollistaa OneLake-luettelomerkintöjen ohjelmallisen etsimisen eri työtiloissa. Se tukee työtilojen välistä hakua hakemiston metatiedoista ja palauttaa tulokset, jotka on suodatettu merkinnöiin, joihin kutsuvalla päänimellä on käyttöoikeus. Hakutulokset sisältävät vakaita tunnisteita, jotka on tarkoitettu käytettäviksi täydentävien Fabric-ohjelmointirajapintojen kanssa lisätietojen hakemiseksi tai tuettujen toimintojen suorittamiseksi.

Muistio

Luettelohaku on tällä hetkellä esikatseluvaiheessa (lisätietoja).

CatalogEntry on Microsoft Fabric -entiteetin löydettävissä oleva metatietoesitys, joka on tällä hetkellä rajoitettu työtilan kohteisiin. Luettelomerkinnät on tarkoitettu vain metatietojen etsimiseen, eivätkä ne anna käyttöoikeutta pohjana oleviin tietoihin tai kohteen sisältöön.

Oikeudet

Soittaja voi hakea luettelomerkintöjä vain niille työtiloille ja kohteille, joihin soittajalla on käyttöoikeus.

Vaaditut delegoidut vaikutusalueet

Catalog.Read.All

Rajoitukset

  • continuationToken ei saa yhdistää :n kanssa search tai filter. Tunnus sisältää jo nämä arvot alkuperäpyynnöstä.

  • pageSize on oltava välillä 1–1 000.

Rajoitinrajoitukset

Rajoitustyyppi Arvo
Käyttöympäristön ohjelmointirajapintojen yhdistetty kiintiö 500 puhelua/min
Ohjelmointirajapinnan raja 50 puhelua/min

Microsoft Entran tukemat käyttäjätiedot

Tämä ohjelmointirajapinta tukee tässä osiossa lueteltuja Microsoft -käyttäjätietoja.

Identiteetti Tuki
Käyttäjä Kyllä
Palvelun päänimi ja hallitut käyttäjätiedot Kyllä

Käyttöliittymä

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

Pyynnön leipäteksti

Nimi Tyyppi Kuvaus
continuationToken

string

Jatkumistunnus seuraavalle sivulle.

Jatkumistunnus siirtää eteenpäin searchfilteralkuperäisen -, - ja pageSize -pyynnön, joten se voidaan lähettää yksin. Sitä ei saa yhdistää search samaan pyyntöön tai filter samassa pyynnössä. Tämä palauttaa virheen.
filter

string

Haun suodatin. Lisää suodatusasetuksia saatetaan lisätä ajan mittaan.

Suodatinparametri tukee seuraavia ominaisuuksia:

  • Tyyppi: Vastaa type luettelomerkinnän ominaisuutta, kuten Report, Lakehousetai Workspace. Yksittäinen suodatin voi määrittää enintään 500 tyyppiarvoa, joista jokainen on enintään 50 merkkiä pitkä.

  • WorkspaceId: Luettelomerkinnän sisältävän työtilan tunnus. Yksittäinen suodatin voi määrittää enintään 12 WorkspaceId-arvoa, joista jokaisen on oltava kelvollinen GUID-tunnus.

Suodatinparametri tukee seuraavia operaattoreita tulosten hienosäätämiseksi:

  • eq: On yhtä suuri kuin; vastaa tarkkaa arvoa.

  • ne: Eri suuri kuin; jättää pois määritetyn arvon.

  • and: Looginen JA; vastaavuus vain, jos kaikki ehdot täyttyvät.

  • or: Looginen TAI; vastaa, jos jokin ehdoista täyttyy.

  • ( ): Sulkeet; ryhmittelee lausekkeet loogisen hierarkian määrittämiseksi.
pageSize

integer

Tämä on palautettavan sivun koko. Sivun koon on oltava välillä 1–1 000. Oletusarvo on 50.
search

string

Haun tekstikysely. Tämä kenttä tukee hakua CatalogEntry-kohteen näyttönimestä, työtilan näyttönimestä ja kuvauksesta.

Hakukenttä tukee seuraavia operaattoreita:

  • " " : Lainausmerkit; vastaa suljettuja sanoja tarkana lauseena.

  • * : Tähti; yleismerkki, joka vastaa vähintään nollaa merkkiä.

  • ? : Kysymysmerkki; Yleismerkki, joka vastaa yksittäistä merkkiä.

  • & : Kaksinkertaiset et-merkkit; edellytä jokaista hakusanaa.

  • Alaviivoja käsitellään osana hakutermistä. ohjaus ohjausta ei vaadita.

  • Muut erikoismerkit ohitetaan ja niitä käsitellään erottimina.

Vastaukset

Nimi Tyyppi Kuvaus
200 OK

CatalogQueryResponse

OK
429 Too Many Requests

ErrorResponse

Palveluhinnan raja ylitettiin. Palvelin palauttaa otsikon, joka Retry-After ilmaisee sekunteina, kuinka kauan asiakkaan on odotettava, ennen kuin lisäpyynnöt lähetetään.

Otsikot

Retry-After: integer
Other Status Codes

ErrorResponse

Yleiset virhekoodit:

  • InvalidRequest: pyynnön leipätekstiä ei ole annettu, tai se on muuten virheellinen.

  • InvalidSearch – search arvoa ei voitu jäsentää.

  • InvalidFilter: - filter parametria ei voi jäsentää, tai suodattimen arvo on epämuodostunut tai sen enimmäispituus on ylittynyt.

  • InvalidFilterProperty – filter Viittaa ominaisuuteen, jota ei tueta.

  • FilterTooManyValues – Määrittää filter ominaisuudelle enemmän arvoja kuin ominaisuus sallii.

  • FilterNotSupported – Suodatusta ei tueta.

  • ConflictingFilterParameters – continuationToken yhdistettiin :n kanssa search tai filter.

  • InvalidPageSize – pageSize on alueen 1–1000 ulkopuolella.

  • InvalidContinuationToken – Ei continuationToken ole kelvollinen.

  • ContinuationTokenTooLong - The continuationToken ylittää enimmäispituuden.

  • TypeNotFound : filter viittaa kohdetyyppiin, jota ei ole olemassa.

  • Luvaton – todentaminen puuttuu tai ei kelpaa

  • Sisäinen palvelinvirhe – odottamaton palveluvirhe.

Esimerkit

Search example
Search within a workspace example

Search example

Mallipyyntö

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

Mallivastaus

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

Mallipyyntö

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
}

Mallivastaus

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

Määritelmät

Nimi Kuvaus
CatalogEntryType

Luettelon merkintätyyppi. Muita CatalogEntryType tyyppejä voidaan lisätä ajan kuluessa.
CatalogQueryRequest

Haun kysely.
CatalogQueryResponse

Haun tulokset.
CatalogWorkspace

Luettelomerkinnän työtila.
ErrorParameter

Jäsennetty parametri, joka antaa koneluettavaa lisäkontekstia virheestä.
ErrorRelatedResource

Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse

Virhevastaus.
ErrorResponseDetails

Virheen vastauksen tiedot.
ItemCatalogEntry

Fabric kohteen hakemiston metatietoesitys.
ItemCatalogEntryHierarchy

Kohteen välittömät esi-isät Fabric tietoarkkitehtuurissa. Vain sovellettavat tasot palautetaan.
ItemType

Kohteen tyyppi. Muita kohdetyyppejä voidaan lisätä ajan kuluessa.
WorkspaceCatalogEntry

Fabric työtilan hakemiston metatietoesitys.
WorkspaceCatalogEntryType

Työtilan luettelomerkinnässä ilmoitettu tyyppi. Muita WorkspaceCatalogEntryType tyyppejä voidaan lisätä ajan kuluessa.

CatalogEntryType

Luettelointi

Luettelon merkintätyyppi. Muita CatalogEntryType tyyppejä voidaan lisätä ajan kuluessa.

Arvo Kuvaus
FabricItem

Fabric-kohdeluettelon merkintätyyppi.
Workspace

Työtilan luettelon merkintätyyppi.

CatalogQueryRequest

Kohde

Haun kysely.

Nimi Tyyppi Kuvaus
continuationToken

string

Jatkumistunnus seuraavalle sivulle.

Jatkumistunnus siirtää eteenpäin searchfilteralkuperäisen -, - ja pageSize -pyynnön, joten se voidaan lähettää yksin. Sitä ei saa yhdistää search samaan pyyntöön tai filter samassa pyynnössä. Tämä palauttaa virheen.
filter

string

Haun suodatin. Lisää suodatusasetuksia saatetaan lisätä ajan mittaan.

Suodatinparametri tukee seuraavia ominaisuuksia:

  • Tyyppi: Vastaa type luettelomerkinnän ominaisuutta, kuten Report, Lakehousetai Workspace. Yksittäinen suodatin voi määrittää enintään 500 tyyppiarvoa, joista jokainen on enintään 50 merkkiä pitkä.

  • WorkspaceId: Luettelomerkinnän sisältävän työtilan tunnus. Yksittäinen suodatin voi määrittää enintään 12 WorkspaceId-arvoa, joista jokaisen on oltava kelvollinen GUID-tunnus.

Suodatinparametri tukee seuraavia operaattoreita tulosten hienosäätämiseksi:

  • eq: On yhtä suuri kuin; vastaa tarkkaa arvoa.

  • ne: Eri suuri kuin; jättää pois määritetyn arvon.

  • and: Looginen JA; vastaavuus vain, jos kaikki ehdot täyttyvät.

  • or: Looginen TAI; vastaa, jos jokin ehdoista täyttyy.

  • ( ): Sulkeet; ryhmittelee lausekkeet loogisen hierarkian määrittämiseksi.
pageSize

integer

Tämä on palautettavan sivun koko. Sivun koon on oltava välillä 1–1 000. Oletusarvo on 50.
search

string

Haun tekstikysely. Tämä kenttä tukee hakua CatalogEntry-kohteen näyttönimestä, työtilan näyttönimestä ja kuvauksesta.

Hakukenttä tukee seuraavia operaattoreita:

  • " " : Lainausmerkit; vastaa suljettuja sanoja tarkana lauseena.

  • * : Tähti; yleismerkki, joka vastaa vähintään nollaa merkkiä.

  • ? : Kysymysmerkki; Yleismerkki, joka vastaa yksittäistä merkkiä.

  • & : Kaksinkertaiset et-merkkit; edellytä jokaista hakusanaa.

  • Alaviivoja käsitellään osana hakutermistä. ohjaus ohjausta ei vaadita.

  • Muut erikoismerkit ohitetaan ja niitä käsitellään erottimina.

CatalogQueryResponse

Kohde

Haun tulokset.

Nimi Tyyppi Kuvaus
continuationToken

string

Jatkumistunnus seuraavalle sivulle.
value CatalogEntry[]:

Luettelo luettelomerkinnöistä

CatalogWorkspace

Kohde

Luettelomerkinnän työtila.

Nimi Tyyppi Kuvaus
displayName

string

Työtilan näyttönimi.
id

string (uuid)

Työtilan tunnus.

ErrorParameter

Kohde

Jäsennetty parametri, joka antaa koneluettavaa lisäkontekstia virheestä.

Nimi Tyyppi Kuvaus
message

string

Ihmisen luettavissa oleva kuvaus parametrin merkityksestä.
name

string

Parametritunniste.
value

string

Parametriarvo.

ErrorRelatedResource

Kohde

Virheeseen liittyvä resurssitieto-objekti.

Nimi Tyyppi Kuvaus
resourceId

string

Virheestä liittyvä resurssitunnus.
resourceType

string

Virheestä liittyvän resurssin tyyppi.

ErrorResponse

Kohde

Virhevastaus.

Nimi Tyyppi Kuvaus
errorCode

string

Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
isRetriable

boolean

Kun arvo on tosi, pyyntöä voidaan yrittää uudelleen. Määritä viive vastausotsikon Retry-After avulla, jos se on käytettävissä.
message

string

Ihmisen luettavissa oleva esitys virheestä.
moreDetails

ErrorResponseDetails[]

Luettelo virheiden lisätiedoista.
parameters

ErrorParameter[]

Jäsennettyjä parametreja, jotka antavat koneluettavaa lisäkontekstia virheestä.
relatedResource

ErrorRelatedResource

Virheisiin liittyvät resurssitiedot.
requestId

string (uuid)

Virheeseen liittyvän pyynnön tunnus.

ErrorResponseDetails

Kohde

Virheen vastauksen tiedot.

Nimi Tyyppi Kuvaus
errorCode

string

Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message

string

Ihmisen luettavissa oleva esitys virheestä.
parameters

ErrorParameter[]

Jäsennettyjä parametreja, jotka antavat koneluettavaa lisäkontekstia virheestä.
relatedResource

ErrorRelatedResource

Virheisiin liittyvät resurssitiedot.

ItemCatalogEntry

Kohde

Fabric kohteen hakemiston metatietoesitys.

Nimi Tyyppi Kuvaus
catalogEntryType string:

FabricItem

Luettelon merkintätyyppi.
description

string

Luettelomerkinnän kuvaus.
displayName

string

Luettelomerkinnän näyttönimi.
hierarchy

ItemCatalogEntryHierarchy

Luettelomerkinnän hierarkia.
id

string (uuid)

Luettelomerkinnän objectId-tunnus.
type

ItemType

Fabric-kohdetyyppi.

ItemCatalogEntryHierarchy

Kohde

Kohteen välittömät esi-isät Fabric tietoarkkitehtuurissa. Vain sovellettavat tasot palautetaan.

Nimi Tyyppi Kuvaus
workspace

CatalogWorkspace

Työtila, joka sisältää kohteen.

ItemType

Luettelointi

Kohteen tyyppi. Muita kohdetyyppejä voidaan lisätä ajan kuluessa.

Arvo Kuvaus
Dashboard

Power BI -koontinäyttö.
Report

PowerBI -raportti.
SemanticModel

PowerBI:n semanttinen malli.
PaginatedReport

PowerBI:n sivutettu raportti.
Datamart

PowerBI -tietomarssi.
Lakehouse

Tämä on lakehouse.
Eventhouse

Tapahtumatalo.
Environment

Ympäristö.
KQLDatabase

KQL-tietokanta.
KQLQueryset

KQL-kyselyjoukko.
KQLDashboard

KQL-koontinäyttö.
DataPipeline

Tietoputki.
Notebook

Muistikirja.
SparkJobDefinition

Spark-työn määritelmä.
MLExperiment

Koneoppimisen kokeilu.
MLModel

Koneoppimismalli.
Warehouse

Varasto.
Eventstream

Tapahtumavirta.
SQLEndpoint

SQL-päätepiste.
MirroredWarehouse

Peilattu varasto.
MirroredDatabase

Peilattu tietokanta.
Reflex

Refleksi.
GraphQLApi

Ohjelmointirajapinta GraphQL-kohteelle.
MountedDataFactory

A MountedDataFactory.
SQLDatabase

A SQLDatabase.
CopyJob

Kopiotyö.
VariableLibrary

MuuttujaLibrary.
Dataflow

Tietovuo.
ApacheAirflowJob

An ApacheAirflowJob.
WarehouseSnapshot

Varastotilannevedos.
DigitalTwinBuilder

A DigitalTwinBuilder.
DigitalTwinBuilderFlow

Digital Twin Builder -työnkulku.
MirroredAzureDatabricksCatalog

Peilattu Azure Databricks -luettelo.
Map

Kartta.
AnomalyDetector

Poikkeamien tunnistaminen.
UserDataFunction

Käyttäjätietofunktio.
GraphModel

A GraphModel.
GraphQuerySet

A Graph QuerySet.
SnowflakeDatabase

Snowflake-tietokannalla tallennetaan Snowflake-tililtä luodut Iceberg-taulukot.
OperationsAgent

A OperationsAgent.
CosmosDBDatabase

Cosmos DB -tietokanta.
Ontology

Ontologia.
EventSchemaSet

An EventSchemaSet.
DataAgent

A DataAgent.
MirroredCatalog

A MirroredCatalog.
PolicySet

Käytäntöjoukko.
AppBackend

An AppBackend.
OrgApp

Organisaatiosovellus.
OrgAppAudience

An Org App Audience.
DataBuildToolJob

A DataBuildToolJob.
AzureDatabricksStorage

OneLake-taustainen tallennuskohde Azure Databricks.
Plan

Suunnitelma.
Monitoring

Valvontakohde.
DeploymentPlan

Käyttöönottosuunnitelma.
ShareSubscription

Jaa tilaus.
Share

Jako.
MirroredOneLake

Peilattu OneLake-kohde.

WorkspaceCatalogEntry

Kohde

Fabric työtilan hakemiston metatietoesitys.

Nimi Tyyppi Kuvaus
catalogEntryType string:

Workspace

Luettelon merkintätyyppi.
description

string

Luettelomerkinnän kuvaus.
displayName

string

Luettelomerkinnän näyttönimi.
id

string (uuid)

Luettelomerkinnän objectId-tunnus.
type

WorkspaceCatalogEntryType

Luettelon merkintätyyppi. Työtilan luettelomerkintöjen kohdalla aina Workspace .

WorkspaceCatalogEntryType

Luettelointi

Työtilan luettelomerkinnässä ilmoitettu tyyppi. Muita WorkspaceCatalogEntryType tyyppejä voidaan lisätä ajan kuluessa.

Arvo Kuvaus
Workspace

Työtila.