TM1 Web URL API parameters

Parameters define which TM1® Web object you want to open and the actions to apply to those objects. You build a complete URL string by adding parameters to the base URL.

The base URL and the parameters are separated by the hashtag symbol (#) and assembled in the following format:

BaseUrl#Parameters

For example:

http://localhost:9510/tm1web/UrlApi.jsp#HideDimensionBar=true

If you include more than one parameter, separate them with the ampersand symbol (&).

BaseUrl#Parameter1=value&Parameter2=value&Parameter3=value

Note: Parameters are not case-sensitive. Either Action or action work the same, however capitalization is recommended for readability.

The most common parameters include Action and Type, which are used to open Workbook and CubeViewer objects. For example, the following URL shows an example of using parameters to open a CubeViewer object.

http://localhost:9510/tm1web/UrlApi.jsp#Action=Open&Type=CubeViewer&Cube=plan_BudgetPlan&View=Budget%20Input%20Detailed&AccessType=Public&AdminHost=localhost&TM1Server=Planning%20Sample

After you open a Websheet or CubeViewer object in your web page, you can then use parameters to apply more actions to the object. For example, the following URLs use the AutoRecalc and HideDimensionBar parameters.

http://localhost:9510/tm1web/UrlApi.jsp#AutoRecalc=true

http://localhost:9510/tm1web/UrlApi.jsp#HideDimensionBar=true

For more information about working with parameters, see the following topics: