KNOWLEDGE BASE

How to set workbook parameter value in view URL and in REST API call


Published: 12 May 2022
Last Modified Date: 16 May 2022

Question

How to set workbook parameter value in view URL and in REST API call

Environment

  • Tableau Server 2021.2.8

Answer

  • To pass parameter value in view url, append ?Parameters.<parametername>=parameter-value to the end of url:
http://<ServerName/#/site/<SiteName>/views/<WorkbookName>/<ViewName>?Parameters.<parametername>=parameter-value
  • To pass parameter value in REST API call, append ?vf_Parameters.<parametername>=parameter-value to the end of url:
GET /api/api-version/sites/site-id/views/view-id/data?vf_Parameters.<parametername>=parameter-value

Note: If the parameter type is Boolean, the value that is passed must be lower case (true or false). 

For example the following URL and REST API call use the correct parameter value: 
http://myserver/#/site/mysite/views/myworkbook/mysheet?Parameters.BooleanParam=true
GET /api/api-version/sites/site-id/views/view-id/data?vf_Parameters.BooleanParam=false

The following values do not work as the initial letter of the value is captial:
http://myserver/#/site/mysite/views/myworkbook/mysheet?Parameters.BooleanParam=True
GET /api/api-version/sites/site-id/views/view-id/data?vf_Parameters.BooleanParam=False
Did this article resolve the issue?