Desarrollo con las API REST para Power BI Report Server

Power BI Report Server admite api de transferencia de estado representacional (REST). Las API REST son puntos de conexión de servicio que admiten un conjunto de operaciones HTTP (métodos), que proporcionan acceso de creación, recuperación, actualización o eliminación de recursos dentro de un servidor de informes.

La API REST proporciona acceso mediante programación a los objetos de un catálogo de Power BI Report Server. Algunos ejemplos de objetos son carpetas, informes, KPI, orígenes de datos, conjuntos de datos, planes de actualización, suscripciones, etc. Con la API REST, puede, por ejemplo, navegar por la jerarquía de carpetas, detectar el contenido de una carpeta o descargar una definición de informe. También puede crear, actualizar y eliminar objetos. Algunos ejemplos de cómo trabajar con objetos están cargando un informe, ejecutando un plan de actualización, eliminando una carpeta, etc.

Nota:

Si está interesado en ver o eliminar datos personales, revise las instrucciones de Microsoft en el sitio Solicitudes del titular de los datos de Windows para el RGPD. Si busca información general sobre el RGPD, consulte la sección RGPD del portal de confianza de servicios.

Componentes de una solicitud o respuesta de la API REST

Un par de solicitudes y respuestas de la API REST se puede separar en cinco componentes:

• El URI de solicitud, que consta de: {URI-scheme} :// {URI-host} / {resource-path} ? {query-string}. Aunque el URI de solicitud se incluye en el encabezado del mensaje de solicitud, lo llamamos por separado aquí porque la mayoría de los lenguajes o marcos requieren que lo pase por separado del mensaje de solicitud.

  • Esquema de URI: indica el protocolo utilizado para transmitir la solicitud. Por ejemplo, http o https.
  • Host de URI: especifica el nombre de dominio o la dirección IP del servidor donde se hospeda el punto de conexión del servicio REST, como myserver.contoso.com.
  • Ruta de acceso del recurso: especifica el recurso o la colección de recursos, que puede incluir varios segmentos utilizados por el servicio para determinar la selección de esos recursos. Por ejemplo: CatalogItems(01234567-89ab-cdef-0123-456789abcdef)/Properties se puede usar para obtener las propiedades especificadas para catalogItem.
  • Cadena de consulta (opcional): proporciona otros parámetros simples, como la versión de la API o los criterios de selección de recursos.

• Campos de encabezado del mensaje de solicitud HTTP:

  • Un método HTTP necesario (también conocido como una operación o verbo), que indica al servicio qué tipo de operación solicita. Las API REST de Reporting Services admiten métodos DELETE, GET, HEAD, PUT, POST y PATCH.
  • Otros campos de encabezado opcionales, según sea necesario para el URI y el método HTTP especificados.

• Campos opcionales del cuerpo del mensaje de solicitud HTTP para soportar URI y operaciones HTTP. Por ejemplo, las operaciones POST contienen objetos codificados con MIME que se pasan como parámetros complejos. Para las operaciones POST o PUT, también se debe especificar el tipo de codificación MIME para el cuerpo en el encabezado de Content-type solicitud. Algunos servicios requieren que use un tipo MIME específico, como application/json.

• Campos de encabezado del mensaje de respuesta HTTP:

  • Un código de estado HTTP, que va desde códigos de éxito 2xx a códigos de error 4xx o 5xx. Como alternativa, se puede devolver un código de estado definido por el servicio, como se indica en la documentación de la API.
  • Otros campos de encabezado opcionales, según sea necesario para admitir la respuesta de la solicitud, como un Content-type encabezado de respuesta.

• Campos opcionales del cuerpo del mensaje de respuesta HTTP:

  • Los objetos de respuesta codificados en MIME se devuelven en el cuerpo de la respuesta HTTP, como una respuesta de un método GET que devuelve datos. Normalmente, estos objetos se devuelven en un formato estructurado como JSON o XML, como se indica en el encabezado de Content-type respuesta.

Documentación de la API

Una API REST moderna requiere documentación de API moderna. La API REST se basa en la especificación openAPI (también conocida como especificación swagger) y la documentación está disponible en Microsoft Learn.

Pruebas de llamadas API

Una herramienta para probar mensajes de solicitud/respuesta HTTP es Fiddler. Fiddler es un proxy de depuración web gratuito que puede interceptar las solicitudes REST, lo que facilita el diagnóstico de los mensajes de solicitud y respuesta HTTP.

Contenido relacionado

Revise las API disponibles en Microsoft Learn.

Hay ejemplos disponibles en GitHub. El ejemplo incluye una aplicación HTML5 basada en TypeScript, React y webpack junto con un ejemplo de PowerShell.

¿Más preguntas? Pruebe a preguntar a la comunidad de Power BI