Catalog - Search

Servicio:: Core

Versión de la API:: v1

Catalog Search API habilita la detección mediante programación de entradas de catálogo de OneLake entre áreas de trabajo. Admite la búsqueda entre áreas de trabajo en los metadatos del catálogo y devuelve los resultados filtrados a las entradas a las que la entidad de llamada está autorizada para acceder. Los resultados de la búsqueda incluyen identificadores estables que están diseñados para usarse con API complementarias de Fabric para recuperar detalles adicionales o realizar acciones admitidas.

Nota:

La búsqueda de catálogos se encuentra actualmente en versión preliminar (más información).

CatalogEntry es una representación de metadatos reconocible de una entidad de Microsoft Fabric, que está actualmente en el ámbito de los elementos del área de trabajo. Las entradas de catálogo están pensadas solo para la detección de metadatos y no conceden acceso al contenido de los datos o elementos subyacentes.

Permissions

El autor de la llamada solo puede detectar entradas de catálogo para áreas de trabajo y elementos a los que está autorizado el autor de la llamada para acceder.

Ámbitos delegados necesarios

Catalog.Read.All

Limitaciones

continuationToken no debe combinarse con search ni filter. El token ya incluye esos valores de la solicitud de origen.
pageSize debe estar entre 1 y 1000.

Identidades admitidas de Microsoft Entra

Esta API admite las identidades de Microsoft enumeradas en esta sección.

Identidad	Apoyo
Usuario	Sí
Entidad de servicio e Identidades administradas	Sí

Interfaz

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

Cuerpo de la solicitud

Nombre	Tipo	Description
continuationToken	string	Token de continuación de la página siguiente. Un token de continuación lleva adelante , `searchfilter`y `pageSize` de la solicitud original, por lo que se puede enviar por sí mismo. No debe combinarse con `search` o `filter` en la misma solicitud; al hacerlo, se devuelve un error.
filter	string	Filtro para la búsqueda. Se pueden agregar opciones de filtro adicionales a lo largo del tiempo. El parámetro filter admite las siguientes propiedades: Tipo: coincide con la `type` propiedad de una entrada de catálogo, por ejemplo `Report`, `Lakehouse`o `Workspace`. Un solo filtro puede especificar como máximo 500 valores de tipo, cada uno de ellos hasta 50 caracteres de longitud. WorkspaceId: el identificador del área de trabajo que contiene la entrada de catálogo. Un único filtro puede especificar como máximo 12 valores WorkspaceId, cada uno de los cuales debe ser un GUID válido. El parámetro filter admite los siguientes operadores para refinar los resultados: eq: Equals; coincide con el valor exacto. ne: No es igual a; excluye el valor especificado. y: AND lógico; coincide solo si todas las condiciones son verdaderas. o: OR lógico; coincide si alguna de las condiciones es true. ( ): paréntesis; agrupa expresiones para definir la jerarquía lógica.
pageSize	integer	Tamaño de página que debe devolverse. El tamaño de página debe estar comprendido entre 1 y 1000. El valor predeterminado es 50.
search	string	Consulta de texto de la búsqueda. Este campo admite la búsqueda en el nombre para mostrar, el nombre para mostrar del área de trabajo y la descripción de CatalogEntry. El campo de búsqueda admite los operadores siguientes: " " : comillas dobles; coincide con las palabras encerradas como una frase exacta. * : Asterisco; comodín que coincide con cero o más caracteres. ? : signo de interrogación; comodín que coincide con un solo carácter. &&: dobles yandillas; requiere cada término de búsqueda. Los caracteres de subrayado se tratan como parte de un término de búsqueda; no se requiere ningún escape. Otros caracteres especiales se omiten y se tratan como separadores.

Respuestas

Nombre Tipo Description

200 OK

Nombre	Tipo	Description
200 OK	CatalogQueryResponse	OK
429 Too Many Requests	ErrorResponse	Se superó el límite de frecuencia de servicio. El servidor devuelve un `Retry-After` encabezado que indica, en segundos, cuánto tiempo debe esperar el cliente antes de enviar solicitudes adicionales. Encabezados Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de error comunes: InvalidRequest: no se proporcionó el cuerpo de la solicitud o no es válido. InvalidSearch: no se pudo analizar el `search` valor. InvalidFilter: `filter` no se pudo analizar o un valor de filtro tiene un formato incorrecto o supera su longitud máxima. InvalidFilterProperty: `filter` hace referencia a una propiedad que no se admite. FilterTooManyValues: `filter` especifica más valores para una propiedad que esa propiedad permite. FilterNotSupported: no se admite el filtrado. ConflictingFilterParameters: `continuationToken` se combinó con `search` o `filter`. InvalidPageSize `pageSize` : está fuera del intervalo de 1 a 1000. InvalidContinuationToken: no `continuationToken` es válido. ContinuationTokenTooLong: `continuationToken` supera la longitud máxima. TypeNotFound: `filter` hace referencia a un tipo de elemento que no existe. No autorizado: falta o autenticación no válida Error interno del servidor: error de servicio inesperado.

CatalogQueryResponse

429 Too Many Requests

ErrorResponse

Se superó el límite de frecuencia de servicio. El servidor devuelve un Retry-After encabezado que indica, en segundos, cuánto tiempo debe esperar el cliente antes de enviar solicitudes adicionales.

Encabezados

Retry-After: integer

Other Status Codes

ErrorResponse

Códigos de error comunes:

InvalidRequest: no se proporcionó el cuerpo de la solicitud o no es válido.
InvalidSearch: no se pudo analizar el search valor.
InvalidFilter: filter no se pudo analizar o un valor de filtro tiene un formato incorrecto o supera su longitud máxima.
InvalidFilterProperty: filter hace referencia a una propiedad que no se admite.
FilterTooManyValues: filter especifica más valores para una propiedad que esa propiedad permite.
FilterNotSupported: no se admite el filtrado.
ConflictingFilterParameters: continuationToken se combinó con search o filter.
InvalidPageSize pageSize : está fuera del intervalo de 1 a 1000.
InvalidContinuationToken: no continuationToken es válido.
ContinuationTokenTooLong: continuationToken supera la longitud máxima.
TypeNotFound: filter hace referencia a un tipo de elemento que no existe.
No autorizado: falta o autenticación no válida
Error interno del servidor: error de servicio inesperado.

Ejemplos

Search example

Search within a workspace example

Search example

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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

Solicitud de ejemplo

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
}

Respuesta de muestra

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

Definiciones

Nombre	Description
CatalogEntryType	Tipo de entrada de catálogo. Se pueden agregar tipos de `CatalogEntryType` adicionales a lo largo del tiempo.
CatalogQueryRequest	Consulta de la búsqueda.
CatalogQueryResponse	Resultados de la búsqueda.
CatalogWorkspace	Área de trabajo de la entrada de catálogo.
ErrorParameter	Parámetro estructurado que proporciona contexto legible por máquina adicional sobre un error.
ErrorRelatedResource	Objeto de detalles del recurso relacionado con el error.
ErrorResponse	Respuesta de error.
ErrorResponseDetails	Detalles de la respuesta de error.
ItemCatalogEntry	Representación de metadatos de catálogo de un elemento de Fabric.
ItemCatalogEntryHierarchy	Los antecesores inmediatos del elemento en la arquitectura de datos de Fabric. Solo se devuelven los niveles aplicables.
ItemType	Tipo del elemento. Se pueden agregar tipos de elementos adicionales a lo largo del tiempo.
WorkspaceCatalogEntry	Representación de metadatos de catálogo de un área de trabajo de Fabric.
WorkspaceCatalogEntryType	Tipo notificado en una entrada de catálogo del área de trabajo. Se pueden agregar tipos de `WorkspaceCatalogEntryType` adicionales a lo largo del tiempo.

CatalogEntryType

Enumeración

Tipo de entrada de catálogo. Se pueden agregar tipos de CatalogEntryType adicionales a lo largo del tiempo.

Valor	Description
FabricItem	Tipo de entrada de catálogo de elementos de Fabric.
Workspace	Tipo de entrada de catálogo del área de trabajo.

CatalogQueryRequest

Objeto

Consulta de la búsqueda.

Nombre	Tipo	Description
continuationToken	string	Token de continuación de la página siguiente. Un token de continuación lleva adelante , `searchfilter`y `pageSize` de la solicitud original, por lo que se puede enviar por sí mismo. No debe combinarse con `search` o `filter` en la misma solicitud; al hacerlo, se devuelve un error.
filter	string	Filtro para la búsqueda. Se pueden agregar opciones de filtro adicionales a lo largo del tiempo. El parámetro filter admite las siguientes propiedades: Tipo: coincide con la `type` propiedad de una entrada de catálogo, por ejemplo `Report`, `Lakehouse`o `Workspace`. Un solo filtro puede especificar como máximo 500 valores de tipo, cada uno de ellos hasta 50 caracteres de longitud. WorkspaceId: el identificador del área de trabajo que contiene la entrada de catálogo. Un único filtro puede especificar como máximo 12 valores WorkspaceId, cada uno de los cuales debe ser un GUID válido. El parámetro filter admite los siguientes operadores para refinar los resultados: eq: Equals; coincide con el valor exacto. ne: No es igual a; excluye el valor especificado. y: AND lógico; coincide solo si todas las condiciones son verdaderas. o: OR lógico; coincide si alguna de las condiciones es true. ( ): paréntesis; agrupa expresiones para definir la jerarquía lógica.
pageSize	integer	Tamaño de página que debe devolverse. El tamaño de página debe estar comprendido entre 1 y 1000. El valor predeterminado es 50.
search	string	Consulta de texto de la búsqueda. Este campo admite la búsqueda en el nombre para mostrar, el nombre para mostrar del área de trabajo y la descripción de CatalogEntry. El campo de búsqueda admite los operadores siguientes: " " : comillas dobles; coincide con las palabras encerradas como una frase exacta. * : Asterisco; comodín que coincide con cero o más caracteres. ? : signo de interrogación; comodín que coincide con un solo carácter. &&: dobles yandillas; requiere cada término de búsqueda. Los caracteres de subrayado se tratan como parte de un término de búsqueda; no se requiere ningún escape. Otros caracteres especiales se omiten y se tratan como separadores.

CatalogQueryResponse

Objeto

Resultados de la búsqueda.

Nombre	Tipo	Description
continuationToken	string	ContinuationToken para la página siguiente.
value	CatalogEntry[]: ItemCatalogEntry[] WorkspaceCatalogEntry[]	Lista de entradas de catálogo

CatalogWorkspace

Objeto

Área de trabajo de la entrada de catálogo.

Nombre	Tipo	Description
displayName	string	Nombre para mostrar del área de trabajo.
id	string (uuid)	El identificador del área de trabajo.

ErrorParameter

Objeto

Parámetro estructurado que proporciona contexto legible por máquina adicional sobre un error.

Nombre	Tipo	Description
message	string	Descripción legible del significado del parámetro.
name	string	El identificador de parámetros.
value	string	Es el valor del parámetro.

ErrorRelatedResource

Objeto

Objeto de detalles del recurso relacionado con el error.

Nombre	Tipo	Description
resourceId	string	ID de recurso que está involucrado en el error.
resourceType	string	Tipo del recurso implicado en el error.

ErrorResponse

Objeto

Respuesta de error.

Nombre	Tipo	Description
errorCode	string	Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
isRetriable	boolean	Cuando es true, se puede reintentar la solicitud. Use el `Retry-After` encabezado de respuesta para determinar el retraso, si está disponible.
message	string	Representación comprensible para humanos del error.
moreDetails	ErrorResponseDetails[]	Lista de detalles de error adicionales.
parameters	ErrorParameter[]	Parámetros estructurados que proporcionan contexto legible por máquina adicional sobre el error.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.
requestId	string (uuid)	Identificador de la solicitud asociada al error.

ErrorResponseDetails

Objeto

Detalles de la respuesta de error.

Nombre	Tipo	Description
errorCode	string	Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message	string	Representación comprensible para humanos del error.
parameters	ErrorParameter[]	Parámetros estructurados que proporcionan contexto legible por máquina adicional sobre el error.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.

ItemCatalogEntry

Objeto

Representación de metadatos de catálogo de un elemento de Fabric.

Nombre	Tipo	Description
catalogEntryType	string: FabricItem	Tipo de entrada de catálogo.
description	string	Descripción de la entrada de catálogo.
displayName	string	Nombre para mostrar de la entrada del catálogo.
hierarchy	ItemCatalogEntryHierarchy	Jerarquía de la entrada de catálogo.
id	string (uuid)	ObjectId de la entrada de catálogo.
type	ItemType	Tipo de elemento Fabric.

ItemCatalogEntryHierarchy

Objeto

Los antecesores inmediatos del elemento en la arquitectura de datos de Fabric. Solo se devuelven los niveles aplicables.

Nombre	Tipo	Description
workspace	CatalogWorkspace	Área de trabajo que contiene el elemento.

ItemType

Enumeración

Tipo del elemento. Se pueden agregar tipos de elementos adicionales a lo largo del tiempo.

Valor	Description
Dashboard	Panel de PowerBI.
Report	Informe de PowerBI.
SemanticModel	Modelo semántico de PowerBI.
PaginatedReport	Informe paginado de PowerBI.
Datamart	Datamart de PowerBI.
Lakehouse	Una casa de lago.
Eventhouse	Un centro de eventos.
Environment	Un entorno.
KQLDatabase	Una base de datos KQL.
KQLQueryset	Un conjunto de consultas KQL.
KQLDashboard	Un panel de KQL.
DataPipeline	Una canalización de datos.
Notebook	Un cuaderno.
SparkJobDefinition	Una definición de trabajo de Spark.
MLExperiment	Un experimento de aprendizaje automático.
MLModel	Un modelo de aprendizaje automático.
Warehouse	Un almacén.
Eventstream	Una secuencia de eventos.
SQLEndpoint	Un punto de conexión de SQL.
MirroredWarehouse	Un almacén reflejado.
MirroredDatabase	Una base de datos reflejada.
Reflex	Un reflejo.
GraphQLApi	Una API para el elemento GraphQL.
MountedDataFactory	A MountedDataFactory.
SQLDatabase	A SQLDatabase.
CopyJob	Un trabajo de copia.
VariableLibrary	A VariableLibrary.
Dataflow	Flujo de datos.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Una instantánea de almacenamiento.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Un flujo de Digital Twin Builder.
MirroredAzureDatabricksCatalog	Un catálogo de Azure Databricks reflejado.
Map	Un mapa.
AnomalyDetector	An Anomaly Detector.
UserDataFunction	Una función de datos de usuario.
GraphModel	Un GraphModel.
GraphQuerySet	Un conjunto de consultas de Graph.
SnowflakeDatabase	Una base de datos de Snowflake para almacenar tablas de Cosmos creadas a partir de la cuenta de Snowflake.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	Una base de datos de Cosmos DB.
Ontology	Una ontología.
EventSchemaSet	An EventSchemaSet.
DataAgent	A DataAgent.
MirroredCatalog	A MirroredCatalog.
PolicySet	A PolicySet.
AppBackend	An AppBackend.
OrgApp	Una aplicación de organización.
OrgAppAudience	Un público de la aplicación de organización.
DataBuildToolJob	A DataBuildToolJob.
AzureDatabricksStorage	Un elemento de almacenamiento respaldado por OneLake para Azure Databricks.
Plan	Un plan.
Monitoring	Un elemento Supervisión.
DeploymentPlan	Un plan de implementación.

WorkspaceCatalogEntry

Objeto

Representación de metadatos de catálogo de un área de trabajo de Fabric.

Nombre	Tipo	Description
catalogEntryType	string: Workspace	Tipo de entrada de catálogo.
description	string	Descripción de la entrada de catálogo.
displayName	string	Nombre para mostrar de la entrada del catálogo.
id	string (uuid)	ObjectId de la entrada de catálogo.
type	WorkspaceCatalogEntryType	Tipo de entrada de catálogo. Siempre `Workspace` para las entradas del catálogo del área de trabajo.

WorkspaceCatalogEntryType

Enumeración

Tipo notificado en una entrada de catálogo del área de trabajo. Se pueden agregar tipos de WorkspaceCatalogEntryType adicionales a lo largo del tiempo.

Valor	Description
Workspace	Un área de trabajo.