SSRS REST API GetReportParameterDefinitions fails to populate ValidValues for dependent parameters

Leandro Manzanal 0 Reputation points
2025-09-25T12:58:23.8533333+00:00

Product: SQL Server Reporting Services (SSRS) REST API v2.0

API Endpoint: /reports({id})/ParameterDefinitions

Swagger Documentation: https://app.swaggerhub.com/apis/microsoft-rs/SSRS/2.0#/Reports/GetReportParameterDefinitions

Issue Summary

The SSRS REST API GetReportParameterDefinitions endpoint does not properly resolve dependent parameters when parent parameter values are provided via query string, resulting in empty ValidValues arrays for dependent parameters.

Expected Behavior

When calling the ParameterDefinitions endpoint with parent parameter values as query parameters, dependent parameters should have their ValidValues populated and ParameterState should change from "HasOutstandingDependencies" to "MissingValidValue".

Actual Behavior

Dependent parameters maintain "HasOutstandingDependencies" state with empty ValidValues array, regardless of parent parameter values being provided.

Steps to Reproduce

  1. Create an SSRS report with cascading parameters where Parameter B depends on Parameter A
  2. Call GET /reports({reportId})/ParameterDefinitions without parameters
  3. Observe Parameter A has populated ValidValues, Parameter B shows "HasOutstandingDependencies" with empty ValidValues
  4. Call GET /reports({reportId})/ParameterDefinitions?ParameterA=ValidValue using a valid value from Parameter A
  5. Observe Parameter B still shows "HasOutstandingDependencies" with empty ValidValues

Sample Request

GET http://server/reports/api/v2.0/reports(73a696a4-f89c-4013-811a-d049d75a0b8d)/ParameterDefinitions?DESCCLIDESP=71876610

Sample Response (Problem)

{
  "Name": "DESCMAT",
  "ParameterState": "HasOutstandingDependencies",
  "ValidValuesIsNull": true,
  "ValidValues": [],
  "Dependencies": ["DESCCLIDESP"]
}

Expected Response

{
  "Name": "DESCMAT", 
  "ParameterState": "MissingValidValue",
  "ValidValuesIsNull": false,
  "ValidValues": [
    {"Label": "Product 1", "Value": "P001"},
    {"Label": "Product 2", "Value": "P002"}
  ],
  "Dependencies": ["DESCCLIDESP"]
}

Impact

This limitation forces developers to:

  • Fall back to legacy SOAP web services (ReportService2010.asmx)
  • Implement workarounds that bypass the REST API
  • Unable to build modern applications that rely solely on REST API for report parameter handling

Attempted Workarounds

  • Tried POST method with parameter values in request body - not documented or supported
  • Query string parameter passing (current approach) - fails as described above
  • Multiple API calls with different parameter combinations - same result

Request

Please implement proper dependency resolution in the REST API GetReportParameterDefinitions endpoint to match the functionality available in the SOAP web service, allowing dependent parameters to populate their ValidValues when parent parameters are provided.

Environment

  • SSRS Version: 2022
  • API Version: 2.0
  • Report with cascading parameters configured with query-based valid values

Additional Technical Details

Initial API Response (Working - Parent Parameter)

{
  "Name": "DESCCLIDESP",
  "ParameterType": "String",
  "ParameterState": "MissingValidValue",
  "ValidValuesIsNull": false,
  "ValidValues": [
    {"Label": "ACME CORPORATION", "Value": "71809510"},
    {"Label": "GLOBAL INDUSTRIES LTD.", "Value": "71876610"}
  ],
  "Dependencies": []
}

Current API Response (Broken - Dependent Parameter)

{
  "Name": "DESCMAT",
  "ParameterType": "String", 
  "ParameterState": "HasOutstandingDependencies",
  "ValidValuesIsNull": true,
  "ValidValues": [],
  "Dependencies": ["DESCCLIDESP"]
}

The dependent parameter remains in "HasOutstandingDependencies" state even when parent parameter value is provided via query string, preventing proper cascading parameter functionality through the REST API.

SQL Server Reporting Services
SQL Server Reporting Services
A SQL Server technology that supports the creation, management, and delivery of both traditional, paper-oriented reports and interactive, web-based reports.
0 comments No comments
{count} votes

1 answer

Sort by: Most helpful
  1. Shruti Dhruv 100 Reputation points Microsoft External Staff Moderator
    2025-10-17T09:29:26.0333333+00:00

    Hi Leandro,

    Thank you for explaining in detail about the issue and reporting in the SQL forum.
    The GetReportParameterDefinitions endpoint does not currently resolve cascading parameter dependencies the way the SOAP API does. Even when you pass parent parameter values in the query string, the REST API does not refresh the dependent parameter’s ValidValues—it only returns the static definition.

    You can Use the SOAP API for Parameter Resolution-

    Call GetItemParameters from ReportService2010.asmx with ForRendering=true and pass parent parameter values. This will return the correct ValidValues for dependent parameters.

    Alternatively, you can file a feature request on Microsoft Feedback Portal for SSRS REST API enhancements here- https://free.blessedness.top/en-us/ssms/feedback-and-troubleshooting/suggest-feature

    Hope this helps!
    Regards, Shruti


Your answer

Answers can be marked as 'Accepted' by the question author and 'Recommended' by moderators, which helps users know the answer solved the author's problem.