Trouble Viewing Images? Right-click on any image and select "Open in new tab" to view a larger version. You can also zoom in using Ctrl + Mouse Wheel for easier readability.

WebReports API Overview

The WebReports API allows developers and users to call WebReports directly from their native applications or bookmark favorite reports with predefined parameters. There are two execution options when sending API commands:

• Standard – Runs and opens the report directly in the browser.

• Queue – Runs the report in the background and emails the user when it is completed.

This flexibility makes it easy to automate reporting, integrate reports into other systems, or streamline workflows by reducing manual steps.

WebReports API Call Syntax

Standard Call

ServerURL/api/APIController/ReportName/ConnectionProfile/ReportType/Parameters

Queue Call

• Runs the report in the background and emails the user when it is completed.

ServerURL/api/APIController/ReportName/ConnectionProfile/ReportType/Parameters/UseSavedData/SaveFile/ExportType

Example:

https://webreports.bridgeworksllc.com/api/FinishedReport?report=SampleWRAPIReport.vdm&Connection=ABCLocal&Type=Finished Report&Parameters=Parameter?CallType=('IN'|,|'MA'|,|'UM')Parameter?CallDate=2016-09-07&UseSavedData=True&SaveFile=true&ExportType=PDF

WebReports API Components

ServerURL/api/

• Example Syntax: https://webreports.bridgeworksllc.com/api/

The web address of the WebReports application hosted on the IIS Server.

APIController

• Example Syntax: FinishedReport?

Specifies the controller used to display the report output:

• FinishedReport – Calls the Finished Report Controller.

• Visualize – Calls the Data Visualization Controller.

ReportName

• Example Syntax: report=SampleWRAPIReport.vdm&

The name of the VDM Report to be executed.

ConnectionProfile

• Example Syntax: Connection=ABCLocal&

The database connection profile used to execute the report.

ReportType

• Example Syntax: Type=Finished Report&

Specifies which type of report will be displayed in the browser:

• Finished Report – Displays a Finished Report in the browser.

• Visualize – Displays a Visualize report in the browser (not available with the Download option).

UseSavedData

• Example Syntax: UseSavedData=True&

UseSavedData=True& is required when queuing or downloading completed reports.

SaveFile

• Example Syntax: SaveFile=true&

When set to True, the report is queued and executed in the background rather than opening in the browser.

ExportType

• Example Syntax: ExportType=PDF

Determines the file format when using the Queue option. Supported formats: PDF, XLSX, XLS, DOCX, PRNX, CSV.

Parameters

• Example Syntax: Parameters=Parameter?CallType=('IN'|,|'MA'|,|'UM')Parameter?CallDate=2016-09-07&
• Parameter?ParameterName=ParameterValue

Allows passing variables to the report at runtime. If omitted, and the report has parameters, the user will be prompted for input.

The report’s parameter configuration (Datatype & Object Identifier) determines if values must be wrapped in single quotes ('value').

Parameter Examples

Single Value Examples

Date Parameters:

• Datatype = DateTime, Object Identifier = '

  • Expected: Parameter?CallDate=2016-09-07

• Datatype = None

  • Expected: Parameter?CallDate='2016-09-07'

String Parameters:

• Datatype = String, Object Identifier = '

  • Expected: Parameter?CallType=IN

• Datatype = None

  • Expected: Parameter?CallType='IN'

Numeric Parameters:

• Datatype = Integer/Decimal – Ignores Object Identifier.

  • Expected: Parameter?CallType=10

⚠️ Important Notes

• When using IN / IN No Parenthesis, older views/calls may still use commas (,), but this can cause issues if the data itself contains commas.

• Valid Example (Comma in Data): ('IN'|,|'MA'|,|'BridgeWorks, VDM')

• Invalid Example: ('IN','MA','BridgeWorks, VDM')

Multi-Value Examples (Type = IN)

Strings:
Parameter?CallType=('IN'|,|'MA'|,|'UM')
(Without commas in data: ('IN','MA','UM'))

Dates:
Parameter?CallDate=('2016-09-01'|,|'2016-09-02'|,|'2016-09-03')
(Without commas in data: ('2016-09-01','2016-09-02','2016-09-03'))

Numerics:
Parameter?CallType=(10|,|20|,|30)
(Without commas in data: (10,20,30))

Multi-Value Examples (Type = IN No Parenthesis)

Strings:
Parameter?CallType='IN'|,|'MA'|,|'UM'
(Without commas: 'IN','MA','UM')

Dates:
Parameter?CallDate='2016-09-01'|,|'2016-09-02'|,|'2016-09-03'
(Without commas: '2016-09-01','2016-09-02','2016-09-03')

Numerics:
Parameter?CallType=10|,|20|,|30
(Without commas: 10,20,30)

⚠️ Important Notes

• When using IN / IN No Parenthesis, older views/calls may still use commas (,), but this can cause issues if the data itself contains commas.

• Valid Example (Comma in Data): ('IN'|,|'MA'|,|'BridgeWorks, VDM')

• Invalid Example: ('IN','MA','BridgeWorks, VDM')

WRUseExplicitValue

Using WRUseExplicitValue bypasses all split/parsing logic and applies the exact value into the parameter for query processing.

• Intended for variable filter use

• Should not be used with parameter types IN / IN No Parenthesis

Example Without WRUseExplicitValue:

 https://webreports.bridgeworksllc.com/api/FinishedReport?report=SampleWRAPIReport.vdm&Connection=ABCLocal&Type=Finished%20Report&Parameters=Parameter?CallType=('IN'|,|'MA'|,|'UM')Parameter?CallDate=2016-09-07

Example With WRUseExplicitValue:

https://webreports.bridgeworksllc.com/api/FinishedReport?report=VariableFilterTesting.vdm&Connection=Northwind WebReports&Type=Finished%20Report&Parameters=Parameter?Parameter1=('Support')Parameter?Parameter2=WRUseExplicitValueAND dbo.Users.CompletedTickets = 0

Example WebReports API Calls

Want to try it out for yourself? The examples below demonstrate how to run WebReports API calls for different scenarios, including Finished Reports, Data Visualizations, and queued downloads.

💡 Tip:
If you’d like hands-on experience with these samples, email support@bridgeworksllc.com to request free access to the demo site.

Finished Report with Parameters:

• Server URL/api/: https://webreports.bridgeworksllc.com/api/
• APIController: FinishedReport?
• ReportName: report=SampleWRAPIReport.vdm&
• ConnectionProfile: Connection=ABCLocal&
• ReportType: Type=Finished%20Report&
• Parameters: Parameters=Parameter?CallType=('IN'|,|'MA'|,|'UM')Parameter?CallDate=2016-09-07

Click here to try the link below in your browser

https://webreports.bridgeworksllc.com/api/FinishedReport?report=SampleWRAPIReport.vdm&Connection=ABCLocal&Type=Finished%20Report&Parameters=Parameter?CallType=('IN'|,|'MA'|,|'UM')Parameter?CallDate=2016-09-07

Data Visualization with Parameters:
 

• Server URL/api/: https://webreports.bridgeworksllc.com/api/
• APIController: Visualize?
• ReportName: report=SampleWRAPIReport.vdm&
• ConnectionProfile: Connection=ABCLocal&
• ReportType: Type=Visualize&
• Parameters: Parameters=Parameter?CallType=('IN'|,|'MA'|,|'UM')Parameter?CallDate=2016-09-07

Click here to try the link below in your browser

https://webreports.bridgeworksllc.com/api/Visualize?report=SampleWRAPIReport.vdm&Connection=ABCLocal&Type=Visualize&Parameters=Parameter?CallType=('IN'|,|'MA'|,|'UM')Parameter?CallDate=2016-09-07

Finished Report without Parameters:

• Server URL/api/: https://webreports.bridgeworksllc.com/api/
• APIController: FinishedReport?
• ReportName: report=SampleWRAPIReport.vdm&
• ConnectionProfile: Connection=ABCLocal&
• ReportType: Type=Finished Report&

Click here to try the link below in your browser

https://webreports.bridgeworksllc.com/api/FinishedReport?report=SampleWRAPIReport.vdm&Connection=ABCLocal&Type=Finished Report&

Queue Finished Report (No Parameters):

• Server URL/api/: https://webreports.bridgeworksllc.com/api/
• APIController: FinishedReport?
• ReportName: report=SampleWRAPIReport.vdm&
• ConnectionProfile: Connection=ABCLocal&
• ReportType: Type=Finished Report&
• UseSavedData: UseSavedData=True&
• SaveFile: SaveFile=True&
• ExportType: ExportType=PDF

Click here to try the link below in your browser

https://webreports.bridgeworksllc.com/api/FinishedReport?report=SampleWRAPIReport.vdm&Connection=ABCLocal&Type=Finished Report&UseSavedData=True&SaveFile=True&ExportType=PDF

Queue Finished Report with Parameters:

• Server URL/api/: https://webreports.bridgeworksllc.com/api/
• APIController: FinishedReport?
• ReportName: report=SampleWRAPIReport.vdm&
• ConnectionProfile: Connection=ABCLocal&
• ReportType: Type=Finished Report&
• Parameters: Parameters=Parameter?CallType=('IN'|,|'MA'|,|'UM')Parameter?CallDate=2016-09-07&
• UseSavedData: UseSavedData=True&
• SaveFile: SaveFile=true&
• ExportType: ExportType=PDF

Click here to try the link below in your browser

https://webreports.bridgeworksllc.com/api/FinishedReport?report=SampleWRAPIReport.vdm&Connection=ABCLocal&Type=Finished Report&Parameters=Parameter?CallType=('IN'|,|'MA'|,|'UM')Parameter?CallDate=2016-09-07&UseSavedData=True&SaveFile=true&ExportType=PDF

Queue Visualize with Parameters:
 

• Server URL/api/: https://webreports.bridgeworksllc.com/api/
• APIController: Visualize?
• ReportName: report=SampleWRAPIReport.vdm&
• ConnectionProfile: Connection=ABCLocal&
• ReportType:Type=Visualize&
• Parameters: Parameters=Parameter?CallType=('IN'|,|'MA'|,|'UM')Parameter?CallDate=2016-09-07&
• UseSavedData: UseSavedData=True

Click here to try the link below in your browser

https://webreports.bridgeworksllc.com/api/Visualize?report=SampleWRAPIReport.vdm&Connection=ABCLocal&Type=Visualize&Parameters=Parameter?CallType=('IN'|,|'MA'|,|'UM')Parameter?CallDate=2016-09-07&UseSavedData=True

* Finished Report with Explicit Value Parameters:
 

IMPORTANT: When WRUseExplicitValue is included in a parameter's value WebReports will bypass all split/parsing logic and apply the EXACT value/syntax into the parameter for query service processing.

• Server URL/api/: https://webreports.bridgeworksllc.com/api/
• APIController: FinishedReport?
• ReportName: report=VariableFilterTesting.vdm&
• ConnectionProfile: Connection=Northwind WebReports&
• ReportType:Type= Type=Finished%20Report&
• Parameter1: Parameters=Parameter?Parameter1=('Support')Parameter?
• * Parameter2 WITH Explicit Value: Parameter2=WRUseExplicitValueAND dbo.Users.CompletedTickets = 0

Click here to try the link below in your browser

https://webreports.bridgeworksllc.com/api/FinishedReport?report=VariableFilterTesting.vdm&Connection=Northwind WebReports&Type=Finished%20Report&Parameters=Parameter?Parameter1=('Support')Parameter?Parameter2=WRUseExplicitValueAND dbo.Users.CompletedTickets = 0

Queue Finished Report for Download:
 

• Server URL/api/: https://webreports.bridgeworksllc.com/api/
• APIController: FinishedReport?
• ReportName: report=SampleWRAPIReport.vdm&
• ConnectionProfile: Connection=Northwind&
• ReportType:Type= Type=Finished%20Report&
• Parameters: Parameters=Parameter?CallType=('IN'|,|'MA'|,|'UM')Parameter?CallDate=2016-09-07&
• UseSavedData: UseSavedData=True&
• SaveFile: SaveFile=true&
• ExportType: ExportType=PDF

Click here to try the link below in your browser

https://webreports.bridgeworksllc.com/api/FinishedReport?report=SampleWRAPIReport.vdm&Connection=ABCLocal&Type=Finished%20Report&Parameters=Parameter?CallType=('IN'|,|'MA'|,|'UM')Parameter?CallDate=2016-09-07&UseSavedData=True&SaveFile=true&ExportType=PDF

Summary

The WebReports API provides a flexible way to integrate, automate, and streamline access to Finished Reports and Data Visualizations. Whether you want to run reports in a browser or queue them for background execution and email delivery, the API allows parameterized calls, explicit values, and export options for various file formats. Understanding how to format parameters—especially with IN and WRUseExplicitValue—ensures reliable and predictable report results.