Listing Files Within an Application

This RESTful web service can be used to list all files within a particular application.

HTTP Method: GET

REST URL Format: 

http://host:port/ibi_apps/rs/ibfs/EDA/NodeName/AppName?IBIRS_action=get

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.

Example:

In the following example, all files within the ibisamp application are listed.

Request: 

http://localhost:8080/ibi_apps/rs/ibfs/EDA/EDASERVE/ibisamp?IBIRS_action=get

Response: 

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<ibfsrpc _jt="IBFSResponseObject" language="EN" name="IBIRS_action" returncode="10000"
   returndesc="SUCCESS" subreturncode="0" subsystem="SSYS" type="simple">
 <ibfsparams size="0"/>
 <rootObject _jt="IBFSFolder" container="true" description="ibisamp" dummy="false"
   fullPath="IBFS:/EDA/EDASERVE/ibisamp" lastModified="1345554266" name="ibisamp"
   policy="///+f///////9/////////////+AAAAA" type="IBFSFolder">
  <children _jt="ArrayList" size="182">
   <item _jt="IBFSFile" description="cargraph.fex" dummy="false"
      fullPath="IBFS:/EDA/EDASERVE/ibisamp/cargraph.fex" index="0" lastModified="1328583952000"
      length="1471" name="cargraph.fex" parent="ibisamp" policy="///+f///////9/////////////+AAAAA"
      type="IBFSFile"/>
   <item _jt="IBFSFile" description="carinst.fex" dummy="false"
      fullPath="IBFS:/EDA/EDASERVE/ibisamp/carinst.fex" index="1" lastModified="1328583952000"
      length="2624" name="carinst.fex" parent="ibisamp"
 policy="///+f///////9/////////////+AAAAA"
      type="IBFSFile"/>
      .
      .
      .
   <item _jt="IBFSFile" description="wfmstart.html" dummy="false"
      fullPath="IBFS:/EDA/EDASERVE/ibisamp/wfmstart.html" index="181" lastModified="1328619018000"
      length="6364" name="wfmstart.html" parent="ibisamp" policy="///+f///////9/////////////+AAAAA"
      type="IBFSFile"/>
  </children>
 </rootObject>
</ibfsrpc>

Each file definition is defined within the opening and closing item tag. The name attribute defines the name of the file.

The following list shows the WebFOCUS-specific file name extensions:

  • fex. WebFOCUS report.
  • mas. Master File Description.
  • acx. Access File.
  • foc. FOCUS database.
  • etg. Data Migrator flow.
  • mnt. Maintain procedure.
  • wfm. Maintain forms.
  • fcm. Maintain compiled.
  • ftm. Flat file usually used as a temporary file.

The description attribute defines the description that was used as input for the file.