URL access parameter reference
You can use parameters as part of a URL to configure the look and feel of your SQL Server 2016 (13.x) Reporting Services or later (SSRS) reports. This article describes the most commonly used parameters.
Parameters aren't case sensitive. They require a prefix:
rs:: Targets the report server.rc:: Targets an HTML Viewer.rv:: Targets the Report Viewer web part.
You can also specify parameters that are specific to devices or rendering extensions. For more information about device-specific parameters, see Specify device information settings in a URL.
Important
For a SharePoint mode report server, it's important that the URL includes the _vti_bin proxy syntax to route the request through SharePoint and the Reporting Services HTTP proxy. The proxy adds context to the HTTP request that's required to ensure proper execution of the report for SharePoint mode report servers. For examples, see Access report server items by using URL access.
Reporting Services integration with SharePoint is no longer available after SQL Server 2016.
HTML Viewer commands (rc:)
Target the HTML Viewer by using the prefix rc:.
| Command | Parameter | Description |
|---|---|---|
Toolbar |
True |
Displays the toolbar. The default value is true. Note: If you omit this parameter, the toolbar is automatically displayed for rendering formats that support it. |
Toolbar |
False |
Hides the toolbar. If this parameter is false, all remaining options are ignored. |
Toolbar |
Navigation |
Displays only pagination in the toolbar. |
Parameters |
True |
Displays the parameters area of the toolbar. The default value is true. Examples: Native Mode: https://myrshost/reportserver?/Sales&rc:Parameters=CollapsedSharePoint mode: https://myspsite/subsite/_vti_bin/reportserver?https://myspsite/subsite/Sales&rc:Parameters=Collapsed |
Parameters |
False |
Hides the parameters area, and the user can't display it. |
Parameters |
Collapsed |
Hides the parameters area, but the user can toggle to see it. Examples: Native Mode: https://myrshost/reportserver?/Sales&rc:Parameters=CollapsedSharePoint mode: https://myspsite/subsite/_vti_bin/reportserver?https://myspsite/subsite/Sales&rc:Parameters=Collapsed |
Zoom |
Page Width |
Set the report zoom to fit the page width. Examples: Native Mode: https://myrshost/reportserver?/Sales&rc:Zoom=Page%20WidthSharePoint mode: https://myspsite/subsite/_vti_bin/reportserver?https://myspsite/subsite/Sales&rc:Zoom=Page%20Width |
Zoom |
Whole Page |
Set the report zoom to fit the whole page. |
Zoom |
<integer percentage> |
Set the report zoom to a specific percentage. The default value is 100. |
Section |
<page number> |
Set which page in the report to display. Any value greater than the number of pages in the report displays the last page. Any value less than 0 displays page 1 of the report. The default value is 1. Examples: Native Mode: https://myrshost/reportserver?/Sales&rc:Section=2SharePoint mode: https://myspsite/subsite/_vti_bin/reportserver?https://myspsite/subsite/Sales&rc:Section=2 |
FindString |
<text> |
Search a report for a specific set of text and highlight the text. Note: rc:FindString doesn't work unless you include rc:Toolbar=false in the URL access string.Examples: Native Mode: https://myrshost/reportserver?/Sales&rc:Toolbar=false&rc:FindString=Mountain-400SharePoint mode: https://myspsite/subsite/_vti_bin/reportserver?https://myspsite/subsite/Sales&rc:Toolbar=false&rc:FindString=Mountain-400 |
StartFind |
<start page> |
Specify the first section to search. The default value is the first page of the report. Example: Native Mode: https://server/Reportserver?/SampleReports/Product Catalog&rs:Command=Render&rc:StartFind=1&rc:EndFind=5&rc:FindString=Mountain-400 |
EndFind |
<end page> |
Set the number of the last page you want to use in the search. The default value is the number of the current page. Use this parameter with the StartFind parameter.Example: See the StartFind example. |
FallbackPage |
<page number> |
Set the number of the page to display if a search or a document map selection fails. The default value is the number of the current page. |
GetImage |
<icon name> |
Get a particular image for the HTML Viewer user interface. |
Icon |
<icon name> |
Get the icon of a particular rendering extension. |
Stylesheet |
<stylesheet file name> |
Specify a style sheet you want to apply to the HTML Viewer. |
| Device Information Setting | Specify a device information setting in the form of rc:tag=value, where tag is the name of a device information setting specific to the rendering extension. For more information, see the Format command description.You can use the OutputFormat device information setting for the IMAGE rendering extension to render the report to a JPEG image by using the following parameters in the URL access string: ...&rs:Format=IMAGE&rc:OutputFormat=JPEG. For more information on all extension-specific device information settings, see Device information settings for rendering extensions (Reporting Services). |
Report server commands (rs:)
Target the report server by using the prefix rs:.
| Command | Parameter | Description |
|---|---|---|
Command |
ListChildren and GetChildren |
Display the contents of a folder. The folder items display within a generic item-navigation page. Examples: Native mode: https://myrshost/reportserver?/Sales&rs:Command=GetChildrenA named instance in native mode: https://myssrshost/Reportserver_THESQLINSTANCE?/reportfolder&rs:Command=listChildrenSharePoint mode: https://myspsite/subsite/_vti_bin/reportserver?https://myspsite/subsite/Sales&rs:Command=GetChildren |
Command |
Render |
The report renders in the browser so that you can view it. Examples: Native mode: https://myrshost/reportserver?/Sales/YearlySalesByCategory&rs:Command=RenderSharePoint mode: https://myspsite/subsite/_vti_bin/reportserver?https://myspsite/subsite/Sales/YearlySalesByCategory&rs:Command=Render |
Command |
GetSharedDatasetDefinition |
Display the XML definition associated with a shared dataset. Shared dataset properties are saved in the definition. These properties include the query, dataset parameters, default values, dataset filters, and data options such as collation and case sensitivity. You must have Read Report Definition permission on a shared dataset to use this value. Example: Native mode: https://localhost/reportserver/?/DataSet1&rs:command=GetShareddatasetDefinition |
Command |
GetDataSourceContents |
Display the properties of a given shared data source as XML. If your browser supports XML and if you're an authenticated user with Read Contents permission on the data source, the data source definition displays. Examples: Native mode: https://myrshost/reportserver?/Sales/AdventureWorks2022&rs:Command=GetDataSourceContentsSharePoint mode: https://myspsite/subsite/_vti_bin/reportserver?https://myspsite/subsite/Sales/AdventureWorks2022&rs:Command=GetDataSourceContents |
Command |
GetResourceContents |
Render a resource and display it in an HTML page if the resource is compatible with the browser. Otherwise, you can choose to open or save the file or resource to disk. Examples: Native mode: https://myrshost/reportserver?/Sales/StorePicture&rs:Command=GetResourceContentsSharePoint mode: https://myspsite/subsite/_vti_bin/reportserver?https://myspsite/subsite/Sales/StorePicture.jpg&rs:Command=GetResourceContents |
Command |
GetComponentDefinition |
Display the XML definition associated with a published report item. You must have Read Contents permission on a published report item to use this value. |
Format |
HTML5PPTXATOMHTML4.0MHTMLIMAGEEXCEL (for .xls)EXCELOPENXML (for .xlsx)WORD (for .doc)WORDOPENXML (for .docx)CSVPDFXML |
Specify the format in which to render and view a report. The default value is HTML5. For more information, see Export a report by using URL access. For a complete list, see the \<Render> extension section of the report server rsreportserver.config file. For more information, see RsReportServer.config configuration file. Examples: Native Mode: https://myrshost/ReportServer?/myreport&rs:Format=PDF SharePoint Mode: https://myspsite/subsite/_vti_bin/reportserver?https://myspsite/subsite/myrereport.rdl&rs:Format=PDF |
ParameterLanguage |
en-us, de-DE, etc. |
Provide a language for parameters passed in a URL that's independent of the browser language. The default value is the browser language. Example: Native Mode: https://myrshost/Reportserver?/SampleReports/Product+Line+Sales&rs:Command=Render&StartDate=4/10/2008&EndDate=11/10/2008&rs:ParameterLanguage=de-DE |
Snapshot |
Render a report based on a report history snapshot. For more information, see Render a report history snapshot using URL access. Example: Native Mode: https://myrshost/reportserver?/SampleReports/Company Sales&rs:Snapshot=2003-04-07T13:40:02 |
|
PersistStreams |
truefalse |
Render a report in a single persisted stream. The Image renderer uses this parameter to transmit the rendered report one chunk at a time. After using this parameter in a URL access string, use the same URL access string with the GetNextStream parameter instead of the PersistStreams parameter to get the next chunk in the persisted stream. This URL command eventually returns a 0-byte stream to indicate the end of the persisted stream. The default value is false. |
GetNextStream |
truefalse |
Get the next data chunk in a persisted stream that's accessed by using the PersistStreams parameter. For more information, see the PersistStreams command description. The default value is false. |
SessionID |
Specify an established active report session between the client application and the report server. The value of this parameter is set to the session identifier. You can specify the session ID as a cookie or as part of the URL. When you configure the report server to not use session cookies, the first request without a specified session ID results in a redirection with a session ID. For more information about report server sessions, see Identify execution state. |
|
ClearSession |
truefalse |
Remove all report instances associated with an authenticated user from the report session. A report instance is defined as the same report run multiple times with different report parameter values. The default value is false. Valid values are true and false. |
ResetSession |
truefalse |
Reset the report session by removing the report session's association with all report snapshots. The default value is false. Valid values are true and false. |
ShowHideToggle |
<positive integer> |
Toggle the show and hide state of a section of the report. Specify a positive integer to represent the section to toggle. |
Report Viewer web part commands (rv:)
Target the Report Viewer web part that integrates with SharePoint by using the prefix rv:. The Report Viewer web part also accepts the rs:ParameterLanguage parameter.
| Command | Parameter | Description |
|---|---|---|
Toolbar |
Full |
Displays the complete toolbar. The default value is Full. |
Toolbar |
Navigation |
Displays only pagination in the toolbar. Example: SharePoint mode: https://myspsite/_vti_bin/reportserver?https://myspsite002%fShared+Documents%2fmyreport.rdl&rv:DocMapMode=Displayed&rv:Toolbar=Navigation |
Toolbar |
None |
Doesn't display the toolbar. |
HeaderArea |
Full |
Displays the complete header. The default value is Full. |
HeaderArea |
BreadCrumbsOnly |
Displays only the breadcrumb navigation in the header to inform the user where they are in the application. Example: SharePoint mode: https://myspsite/_vti_bin/reportserver?https://myspsite002%fShared+Documents%2fmyreport.rdl&rv:DocMapMode=Displayed&rv:HeaderArea=BreadCrumbsOnly |
HeaderArea |
None |
Hides the header. |
DocMapAreaWidth |
Control the display width, in pixels, of the parameter area in the Report Viewer web part. The default value is the same as the Report Viewer web part default. The value must be a non-negative integer. | |
AsyncRender |
truefalse |
Control whether a report is rendered asynchronously. The default value is true, which specifies that a report be rendered asynchronously. The value must be a Boolean value of true or false. |
ParamMode |
Full |
Displays the parameter prompt area. The default value is Full. |
Collapsed |
Collapses the parameter prompt area. Example: SharePoint mode: https://myspsite/_vti_bin/reportserver?https://myspsite002%fShared+Documents%2fmyreport.rdl&rv:DocMapMode=Displayed&rv:ParamMode=Collapsed |
|
ParamMode |
Hidden |
Hides the parameter prompt area. |
DocMapMode |
Full |
Displays the document map area. The default value is Full. |
DocMapMode |
Collapsed |
Collapses the document map area. |
DocMapMode |
Hidden |
Hides the document map area. |
DockToolBar |
Top |
Docks the toolbar at the top. The default value is Top. |
DockToolBar |
Bottom |
Docks the toolbar at the bottom. Example: SharePoint mode: https://myspsite/_vti_bin/reportserver?https://myspsite002%fShared+Documents%2fmyreport.rdl&rv:DocMapMode=Displayed&rv:DockToolBar=Bottom |
ToolBarItemsDisplayMode |
1 (0x1) |
Back button |
ToolBarItemsDisplayMode |
2 (0x2) |
Text search controls |
ToolBarItemsDisplayMode |
4 (0x4) |
Page navigation controls |
ToolBarItemsDisplayMode |
8 (0x8) |
Refresh button |
ToolBarItemsDisplayMode |
16 (0x10) |
Zoom list box |
ToolBarItemsDisplayMode |
32 (0x20) |
Atom Feed button |
ToolBarItemsDisplayMode |
64 (0x40) |
Print menu option in Actions |
ToolBarItemsDisplayMode |
128 (0x80) |
Export submenu in Actions |
ToolBarItemsDisplayMode |
256 (0x100) |
Open with Report Builder menu option in Actions |
ToolBarItemsDisplayMode |
512 (0x200) |
Subscribe menu option in Actions |
ToolBarItemsDisplayMode |
1024 (0x400) |
New Data Alert menu option in Actions |
ToolBarItemsDisplayMode |
Multiple Values | Control which toolbar items to display. This value is a bitwise enumeration value. To include a toolbar item, add the item's value to the total value. For example, for no Actions menu, use rv:ToolBarItemsDisplayMode=63 (or 0x3F), which is 1+2+4+8+16+32. For Actions menu items only, use rv:ToolBarItemsDisplayMode=960 (or 0x3C0). The default value is -1, which includes all toolbar items. Valid values are:Example: SharePoint mode: https://myspsite/_vti_bin/reportserver?https://myspsite002%fShared+Documents%2fmyreport.rdl&rv:DocMapMode=Displayed&rv:ToolBarItemsDisplayMode=15 |