Events
Mar 31, 11 PM - Apr 2, 11 PM
The biggest SQL, Fabric and Power BI learning event. March 31 – April 2. Use code FABINSIDER to save $400.
Register todayThis browser is no longer supported.
Upgrade to Microsoft Edge to take advantage of the latest features, security updates, and technical support.
Applies to:
SQL Server Reporting Services (2017 and later) ❌ Power BI Report Server
Microsoft SQL Server 2017 Reporting Services supports Representational State Transfer (REST) APIs. REST APIs are service endpoints that support a set of HTTP operations (methods). These methods provide create, retrieve, update, or delete access for resources within a report server.
A REST API provides programmatic access to the objects in a SQL Server 2017 Reporting Services report server catalog. The following are examples of objects:
When you use a REST API, you can navigate the folder hierarchy, discover the contents of a folder, or download a report definition. You can also create, update, and delete objects.
Note
If you're interested in viewing or deleting personal data, please review Microsoft's guidance in the Windows Data Subject Requests for the GDPR site. If you're looking for general information about GDPR, see the GDPR section of the Service Trust portal.
A REST API request/response pair can be separated into five components:
The request URI:
{URI-scheme} :// {URI-host} / {resource-path} ? {query-string}
.Request URI | Description |
---|---|
URI scheme | Indicates the protocol used to transmit the request. For example, http or https . |
URI host | Specifies the domain name or IP address of the server where the REST service endpoint is hosted, such as myserver.contoso.com . |
Resource path | Specifies the resource or resource collection, which might include multiple segments used by the service in determining the selection of those resources. For example, you can use CatalogItems(01234567-89ab-cdef-0123-456789abcdef)/Properties to get the specified properties for the CatalogItem . |
Query string (optional) | Provides more simple parameters, such as the API version or resource selection criteria. |
HTTP request message header fields:
Optional HTTP request message body fields:
Content-type
request header as well. Some services require you to use a specific MIME type, such as application/json
.HTTP response message header fields:
Content-type
response header.Optional HTTP response message body fields:
Content-type
response header.A modern REST API calls for modern API documentation. A REST API is built on the OpenAPI specification, which is also called the swagger specification. Power BI Report Server REST API documentation is available on Microsoft Learn.
If you need a tool for testing HTTP request/response messages, Fiddler is a free web debugging proxy that can intercept your REST requests, making it easy to diagnose the HTTP request/response messages.
Events
Mar 31, 11 PM - Apr 2, 11 PM
The biggest SQL, Fabric and Power BI learning event. March 31 – April 2. Use code FABINSIDER to save $400.
Register todayTraining
Module
Explore reporting tools in finance and operations apps - Training
A report is a structured presentation of data. Reporting presents data in a way that lets you make informed decisions by using data visualizations, dashboards, financial reporting, and structured documents. finance and operations apps provide several reporting tools that you can use to meet different reporting needs. This module will help you become familiar with the various reporting options that are available with finance and operations apps.
Certification
Microsoft Certified: Power BI Data Analyst Associate - Certifications
Demonstrate methods and best practices that align with business and technical requirements for modeling, visualizing, and analyzing data with Microsoft Power BI.
Documentation
SQL Server Reporting Services REST API documentation - sql-server-reporting
This contains documentation for the SQL Server Reporting Services REST API with minimum versions, changes, and example usages.
Accessing the SOAP API - SQL Server Reporting Services (SSRS)
The Report Server Web service uses SOAP over HTTP and acts as a communications interface between clients and the report server. Use WSDL to call the service.
Reporting Services developer documentation - SQL Server Reporting Services (SSRS)
Use the documentation to understand Reporting Services features and capabilities to build custom reporting and management tools into Web sites and Windows applications.