Running a Report Within an Application

This RESTful web service can be used to run a report stored in an application.

HTTP Method: POST

REST URL Format: 

http://host:port/ibi_apps/rs/ibfs/EDA/NodeName/Appname/FexName

where:

host

Is the name of the system where WebFOCUS is installed.

port

Is the port number used by WebFOCUS.

NodeName

Is the name of the WebFOCUS Reporting Server Node. For more information, see Listing ibi WebFOCUS Reporting Server Nodes.

Appname

Is the name of the application containing the files to be listed. For more information, see Listing Applications.

FexName

Is the name of the WebFOCUS report as defined in the name attribute when listing files within an application. For more information, see Listing Files Within an Application.

Body Format: 

IBIRS_action=run&IBIRS_proxyURL=clientPath&IBIRS_userName=Userid&
IBIRS_password=Password&parmNameN=parmValueN&IBIRS_args=Object

where:

clientPath

Is the path to the client application making the RESTful web service calls to WebFOCUS. For example:

http://myapplication.maj.com/Sales/Monthly.aspx

The parameter is used when the initial WebFOCUS report contains drill-down links, links to images, On-Demand Paging reports, or Active Cache reports.

When you click on a drill-down link or pages in an On-Demand Paging report, the request will be routed to the client application, as defined by the clientPath value, instead of WebFOCUS. All of the parameter names and values are sent with the request. The client application will then have to redirect the request to the following URL, which is the WebFOCUS environment:

http://host:port/ibi_apps/rs/ibfs
Userid

Is the WebFOCUS Reporting Server user ID. If the WebFOCUS Reporting Server is running with Security Off or the WebFOCUS Reporting Server sign-in credentials are configured in the WebFOCUS Reporting Server Client settings, then this parameter does not have to be sent in the REST request.

Password

Is the WebFOCUS Reporting Server password. If the WebFOCUS Reporting Server is running with Security Off or the WebFOCUS Reporting Server sign-in credentials are configured in the WebFOCUS Reporting Server Client settings, then this parameter does not have to be sent in the REST request.

parmNameN

Is the name of the defined parameter that will be passed to the WebFOCUS Reporting Server.

Note: The number of defined parameters can vary and depend on the number of parameters within the WebFOCUS report. For example, a WebFOCUS report that requires two parameters will also require these parameters and corresponding values to be set in the body of this RESTful web service (&parmName1=parmValue1&parmName2=parmValue2). In a different WebFOCUS report, there could be as many parameters as required (three, four, five, and so on).
parmValueN

Is the value of the defined parameter that will be passed to the WebFOCUS Reporting Server.

Object (Optional)

Is the XML object that is used to turn off redirection when retrieving report output for MIME types like EXCEL and PDF using the following format:

<rootObject _jt="HashMap">
 <entry>
  <key _jt="string" value="IBFS_contextVars"/>
   <value _jt="HashMap">
    <entry>
     <key _jt="string" value="IBIWF_redirect"/>
     <value _jt="string" value="NEVER"/>
    </entry>
  </value>
 </entry>
</rootObject>

Example:

In the following example, the Sales_for_a_Specific_Country report is being executed only for Japan.

Request: 

http://localhost:8080/ibi_apps/rs/ibfs/EDA/EDASERVE/ibisamp/carinst.fex

Body: 

IBIRS_action=run&COUNTRY=JAPAN

Response:

The response is a report in either HTML, Excel, PDF, active report, or a graph.