Compartir a través de

¿Qué son las API de REST para Reporting Services?

  • Artículo

Se aplica a: SQL Server Reporting Services (2017 y versiones posteriores) ❌ Power BI Report Server

Microsoft SQL Server 2017 Reporting Services admite las API de transferencia de estado representacional (REST). Las API de transferencia de estado representacional (REST) son puntos de conexión de servicio que admiten conjuntos de operaciones (métodos) HTTP. Estos métodos proporcionan acceso de creación, recuperación, actualización o eliminación a los recursos de un servidor de informes.

Una API de REST proporciona acceso mediante programación a los objetos de un catálogo del servidor de informes de SQL Server 2017 Reporting Services. A continuación, se muestran ejemplos de objetos:

  • Carpetas
  • Informes
  • KPI
  • Orígenes de datos
  • Conjuntos de datos
  • Planes de actualización
  • Suscripciones

Cuando usa una API de REST, puede 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.

Nota:

Si le interesa 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 quiere obtener información general sobre el RGPD, vea la sección sobre RGPD del Portal de confianza del servicio.

Componentes de una solicitud/respuesta de la API de REST

Un par de solicitud/respuesta de una API de REST puede dividirse en cinco componentes:

  • La URI de la solicitud:

    • Aunque el URI de solicitud se incluye en el encabezado del mensaje de solicitud, la mayoría de los lenguajes o marcos de trabajo le exigen que lo pase por separado desde el mensaje de solicitud.
    • Consta de {URI-scheme} :// {URI-host} / {resource-path} ? {query-string}.
    URI de solicitud Descripción
    Esquema de URI indica el protocolo que se usa 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 de servicio REST, como myserver.contoso.com.
    Resource path especifica el recurso o una colección de recursos, que puede incluir varios segmentos usados por el servicio a la hora de determinar la selección de esos recursos. Por ejemplo, puede usar CatalogItems(01234567-89ab-cdef-0123-456789abcdef)/Properties para obtener las propiedades especificadas de CatalogItem.
    Cadena de consulta (opcional) Proporciona más parámetros simples, como los criterios de selección de recursos o la versión de la API.

  • Campos de encabezado del mensaje de solicitud HTTP:

    • Un método HTTP obligatorio, también conocido como una operación o un verbo.
    • Indica al servicio qué tipo de operación solicita. Las API de REST de Reporting Services admiten los métodos DELETE, GET, HEAD, PUT, POST y PATCH.
    • Campos de encabezado adicionales y opcionales, según necesite el método HTTP y el URI especificados.

  • Campos de cuerpo del mensaje de solicitud HTTP opcionales:

    • Admite el URI y la operación HTTP. Por ejemplo, las operaciones POST contienen objetos codificados con Extensiones multipropósito de correo de Internet (MIME) que se pasan como parámetros complejos.
    • Para las operaciones POST o PUT, el tipo de codificación MIME para el cuerpo también debe especificarse en el encabezado de solicitud Content-type. Algunos servicios requieren que se use un tipo MIME concreto, como application/json.

  • Campos de encabezado de mensaje de respuesta HTTP:

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

  • Campos de cuerpo del mensaje de respuesta HTTP opcionales:

    • Se devuelven objetos de respuesta codificados con MIME en el cuerpo de 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, tal y como se indica en el encabezado de respuesta Content-type.

Documentación de la API

Una API de REST moderna exige una documentación de API moderna. Una API de REST se basa en la especificación OpenAPI, que también se denomina especificación swagger. La documentación de API REST de Power BI Report Server está disponible en Microsoft Learn.

Llamadas a la API de prueba

Si necesita una herramienta para probar mensajes de respuesta o solicitud HTTP, 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 o respuesta HTTP.

Contenido relacionado

¿Tiene alguna pregunta más? Puede plantear sus dudas en el foro de Reporting Services.