Use SSRS 2017, 2019 REST API to render report and save as pdf programmatically

Question

Use SSRS 2017, 2019 REST API to render report and save as pdf programmatically

Spunny 366

Hi,
We need to run SSRS report by passing parameter and generate PDS as stream and attach it as PDF to the email. We need to do it in powershell script.
When searching, finding mixed articles. ReportExecutionService2005, ReportExecutionService2010.asmx etc. With 2017, I see REST API is introduced. But I am not finding any information to render report and save as pdf programatically.

Can someone please point me to right source for rendering SSRS report and save as pdf with SSRS 2017 or SSRS 2019.

Thank You

Accepted answer

0 additional answers

Your answer

Answer 1

Michael Taylor 60,161

The API is documented here. Since it is an OpenAPI you can import this URL into Postman or your favorite API testing tool to get a feel for what is available. But SSRS is divided into 2 pieces: management and execution. The API appears to only be the management side so you can create and modify reports but not execute them.

To render a report you can either use the SOAP service ASMX or the URL access approach. Personally I prefer the SOAP service as it is more flexible. You would use Connected Services to point to the ASMX endpoint. Visual Studio auto-generates a wrapper client that you can then use. We have this wrapped in a reusable library for our company so not every project needs a connected service endpoint. After that you simply need to call the Render method on the server client with the report information, optional credentials and rendering options you have.

Spunny 366 Reputation points

2022-02-24T22:14:17.09+00:00

Thank you cooldadtx. That helps me to make a decision. But I need to call report to be executed and export to PDF in Powershell scripts. Please let me know if it can be done in powershell calling ASMX.
Michael Taylor 60,161 Reputation points

2022-02-24T22:21:11.777+00:00

Can it be done? Yes. Is it easy? No. You'll have to use Invoke-WebRequest and build the SOAP message manually. The blog here discusses what it takes. You might find URL access easier than the SOAP approach but you should ensure you don't need something that URL access doesn't. The biggest restriction is going to be around credentials I believe. Parameters can be set and rendering formats can be specified so if that is all you need then you're good.
Spunny 366 Reputation points

2022-02-25T13:42:06.617+00:00

Thank you. When you say biggest restriction is around credentials means what? We are not going to send username and password. We are thinking of setting up service account that runs powershell script and report. Please elaborate about credential restrictions.
Michael Taylor 60,161 Reputation points

2022-02-25T15:44:03.51+00:00

What I meant by credentials is that I don't believe you can specify credentials via URL access. If you are going to run the script under a specific account then that account would need the necessary SSRS permissions to render the report. With the SOAP approach you can pass credentials as part of the request so the user executing the code doesn't need SSRS permissions.
Spunny 366 Reputation points

2022-03-07T11:34:55.847+00:00

Thanks cooldadtx. I am trying to mark it as accepted answer. But it is not letting me. I will try to mark.

Share via

Use SSRS 2017, 2019 REST API to render report and save as pdf programmatically

0 additional answers

Your answer