URL API Action parameter

Use the Action parameter to specify the type of action to perform on an IBM® Cognos® TM1® Web object.

Format

#Action=Type_Of_Action

Values

Value	Description
`Close`	Closes an existing object.
`Logout`	Ends the session for any other URL API instances under the same session.
`Open`	Opens a Cognos TM1 Web object.
`Rebuild`	Recalculates all values and rebuilds all subsets for a Cognos TM1 Active Form contained in a Websheet. This action performs the same action as when you click the Rebuild button on the Cognos TM1 Web toolbar.
`Recalc`	Recalculates an existing Websheet or CubeViewer object.
`Reload`	Reloads the CubeViewer object only.
`Save`	Saves the layout of a cube view. Applies only to CubeViewer objects. Note: The `Save` action does not save any changes to the data in the view. Use the `Recalc` action to save changed data.

URL Example

The following URL examples show some actions to perform on a CubeViewer or Websheet object that is already displayed in a web page.

http://localhost:9510/tm1web/UrlApi.jsp#Action=Save

http://localhost:9510/tm1web/UrlApi.jsp#Action=Reset

http://localhost:9510/tm1web/UrlApi.jsp#Action=Close

JavaScript Example

The following example shows a collection of JavaScript functions that each perform a different action on a CubeViewer or Websheet object.

<script type="text/javascript">

   function loadWebsheet() {
      webSheet = document.getElementById("websheetId");

      webSheet.src = baseUrl + "#Action=Open&Type=WebSheet
      &Workbook=Applications/Planning Sample/Management Reporting/Actual v Budget
      &AdminHost=localhost&TM1Server=Planning Sample";
   };

   function loadCubeview() {
      cubeView = document.getElementById("cubeviewId");

      cubeView.src = baseUrl + "#Action=Open&Type=CubeViewer&Cube=plan_BudgetPlan
      &View=Budget Input Detailed&AccessType=Public
      &AdminHost=localhost&TM1Server=Planning Sample";
   };

   function rebuildActiveForms() {
      webSheet.src = baseUrl + "#Action=Rebuild";
   };

   function recalculate() {
      getActiveIFrame().src = baseUrl + "#Action=Recalc";
   };

   function resetView() {
      cubeView.src = baseUrl + "#Action=Reset";
   };

   function saveView() {
      cubeView.src = baseUrl + "#Action=Save";
   };

   function close() {
      getActiveIFrame().src = baseUrl + "#Action=Close";
   };

</script>