WebFOCUS Managed Reporting

In this section:

 

This section describes the format and structure of RESTful web service requests that are used for a variety of WebFOCUS Managed Reporting tasks.


Top of page

x
Creating and Updating a Folder

This RESTful web service request can be used to create and update a folder within WebFOCUS Managed Reporting.

HTTP Method: POST

REST URL Format:

http://host:port/ibi_apps/rs/ibfs/WFC/Repository/FolderName

where:

host

Is the name of the system where WebFOCUS is installed.

port

Is the port number used by WebFOCUS.

FolderName

Is the name of the folder to be created. If the folder being created is a subfolder of an existing folder, then the existing folder name is also included in the REST URL. This shows the path to the folder being created. For example, ExistingFolder/FolderName.

Body Format:

IBIRS_action=put&IBIRS_object=Object&IBIRS_private=MakeFolderPrivate&IBIRS_replace=ReplaceFolderProperties

where:

Object

Is the XML object defining the attributes for the folder using the following format:

<object _jt="IBFSMRObject"
container="true"description="FolderDescription"summary="Summary"
appName="AppList">
<properties size="numberOfProperties">
<entry key="propertyN"/>
</properties>
</object>

where:

FolderDescription

Is a description of the folder being created.

Summary

Is a brief description describing the contents of the folder.

AppList (Optional)

List of applications used in the search path. For example:

appName="ibisamp ibidemo"
properties (Optional)

numberOfProperties

Is the number of properties that are to be applied to the folder.

propertyN

The property that is applied to the folder. Each property exists with an opening and closing entry tag. For example:

<entry key="autogenmyreports"/>

Valid properties:

  • autogenmyreports. Automatically creates My Content folders.
  • hidden. Do not show in the list of folders.
MakeFolderPrivate

Determines whether to make a folder private. Specify true or false. By default, this attribute is set to true.

ReplaceFolderProperties

Determines whether the properties of the folder (for example, FolderDescription and Summary) can be updated.

Specify one of the following:

  • true. Update the properties of the folder. To update the properties of the folder, the existing properties must be retrieved. The retrieved XML object would then be modified and used as input. The following REST URL retrieves the existing properties for a folder:
    http://host:port/ibi_apps/rs/ibfs/WFC/Repository/FolderName?IBIRS_action=get
  • false. Do not update the properties of the folder.

Example 1:

In the following example, a folder called Financial_Reports is created, which has SEC Filings as the description.

POST Request URL:

http://localhost:8080/ibi_apps/rs/ibfs/WFC/Repository/Financial_Reports

Body:

IBIRS_action=put&IBIRS_object=<object _jt="IBFSMRObject" container="true"
  description="SEC Filings" summary="Quarterly and Yearly Financial Reports reported to the Securities and Exchange Commission">
  </object>&IBIRS_replace=false

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="IBFSMRObject" binary="false" container="true" createdBy="admin"
    createdOn="1345146734216" defaultLng="en_US" description="SEC Filings" dummy="false"
    effectiveRSName="EDASERVE" fullPath="IBFS:/WFC/Repository/Financial_Reports"
    handle="75d099c0_163a_46d8_ba25_ec0be965b15d" lastModified="1345146734216"
    lastaccessBy="admin" lastaccessOn="1345146734216" lastmodBy="admin" length="0"
    name="Financial_Reports" ownerId="10001" ownerName="admin"
 ownerType="U"
    policy="//v+f///////9/////////////+AAAAA" returnedLng="en_US"
    summary="Quarterly and Yearly Financial Reports reported to the Securities and Exchange Commission"
    type="MRFolder">
  <nlsValues _jt="HashMap" loadFactor="0.75" threshold="12">
   <entry>
    <key _jt="string" value="en_US"/>
    <value _jt="ArrayList" size="2">
     <item _jt="string" index="0" value="SEC Filings"/>
     <item _jt="string" index="1" value="Quarterly and Yearly Financial Reports reported to the Securities and Exchange Commission"/>
    </value>
   </entry>
  </nlsValues>
  <properties size="0"/>
 </rootObject>
</ibfsrpc>

If the value for the returncode attribute in the XML response is 10000, then the folder was successfully created.

Example 2:

In the following example, a folder called Financial_Reports is updated with Financial Quarterly-Yearly Reports set as the new description.

The following REST URL retrieves the existing properties for the Financial_Reports folder:

http://localhost:8080/ibi_apps/rs/ibfs/WFC/Repository/Financial_Reports?IBIRS_action=get

POST Request URL:

http://localhost:8080/ibi_apps/rs/ibfs/WFC/Repository/Financial_Reports

Body:

IBIRS_action=put&IBIRS_object= 
 <rootObject _jt="IBFSMRObject" binary="false" container="true"
    createdBy="admin" createdOn="1349964405620" defaultLng="en_US"
    description="Financial Quarterly-Yearly Reports" dummy="false" effectiveRSName="EDASERVE"
    fullPath="IBFS:/WFC/Repository/Financial_Reports" handle="5d81bab8_7db7_40c9_96b9_df2b00ce3278"
    lastModified="1349964405620" lastaccessBy="admin" lastaccessOn="1349969821584" lastmodBy="admin"
    length="0" name="Financial_Reports" ownerId="10001" ownerName="admin" ownerType="U"
    policy="//3/D///9+f/////f/////////8AAAA=" returnedLng="en_US"
    rsPath="/ibi_apps/rs/ibfs/WFC/Repository/Financial_Reports"
    summary="Quarterly and Yearly Financial Reports reported to the Securities and Exchange Commission"
    type="MRFolder">
  <children _jt="ArrayList" size="0"/>
  <nlsValues _jt="HashMap" loadFactor="0.75" threshold="12">
    <entry>
      <key _jt="string" value="en_US"/>
      <value _jt="ArrayList" size="2">
        <item _jt="string" index="0" value="Financial Quarterly-Yearly Reports"/>
        <item _jt="string" index="1"
           value="Quarterly and Yearly Financial Reports reported to the Securities and Exchange Commission"/>
      </value>
    </entry>
  </nlsValues>
  <properties size="0"/>
 </rootObject>&IBIRS_replace=true

Response:

If the value for the returncode attribute in the XML response is 10000, then the folder was successfully updated.


Top of page

x
Deleting a Folder

This RESTful web service request can be used to delete a folder or subfolder within WebFOCUS Managed Reporting.

HTTP Method: DELETE

REST URL Format:

http://host:port/ibi_apps/rs/ibfs/WFC/Repository/FolderName?IBIRS_action=delete

where:

host

Is the name of the system where WebFOCUS is installed.

port

Is the port number used by WebFOCUS.

FolderName

Is the name of the folder to be deleted. If the folder being deleted is a subfolder, then the folder above the subfolder is also included in the REST URL. This shows the path to the folder being deleted. For example, ParentFolderName/FolderName.

Example:

In the following example, the Manufacturing_Reports folder is deleted from the Car_Reports folder, which is within the RESTful_Web_Services folder.

Request:

http://localhost:8080/ibi_apps/rs/ibfs/WFC/Repository/RESTful_Web_Services/
Car_Reports/Manufacturing_Reports?IBIRS_action=delete

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="IBFSMRObject" binary="false" container="true" createdBy="admin" createdOn="1345149829421"
    defaultLng="en_US" description="Manufacturing Reports" dummy="false" effectiveRSName="EDASERVE"
fullPath="IBFS:/WFC/Repository/RESTful_Web_Services/Car_Reports/
  Manufacturing_Reports"
    handle="bb7ea628_2068_4d1c_b3cb_80555a30d53f" lastModified="1345149829421" lastaccessBy="admin"
    lastaccessOn="1345152035853" lastmodBy="admin" length="0" name="Manufacturing_Reports"
    returnedLng="en_US" type="MRFolder">
  <nlsValues _jt="HashMap" loadFactor="0.75" threshold="12">
   <entry>
    <key _jt="string" value="en_US"/>
    <value _jt="ArrayList" size="2">
     <item _jt="string" index="0" value="Manufacturing Reports"/>
    </value>
   </entry>
  </nlsValues>
  <properties size="0"/>
 </rootObject>
</ibfsrpc>

If the value for the returncode attribute in the XML response is 10000, then the folder was successfully deleted.


Top of page

x
Deleting a WebFOCUS Managed Reporting Report

This RESTful web service request can be used to delete a report from WebFOCUS Managed Reporting.

HTTP Method: DELETE

REST URL Format:

http://host:port/ibi_apps/rs/ibfs/WFC/Repository/FolderName/ReportName?IBIRS_action=delete

where:

host

Is the name of the system where WebFOCUS is installed.

port

Is the port number used by WebFOCUS.

FolderName

Is the name of the folder used for the stored WebFOCUS report. If the folder used for the stored WebFOCUS report exists as a subfolder, then the path to the subfolder name must be included in the REST URL. For example, TopFolderName/SubFolderName.

ReportName

Is the name of the WebFOCUS report to delete, which must have a .fex extension.

Example:

In the following example, the Income_Statement_March_2010 report is deleted from the Quarterly folder, which is within the Financial_Reports folder.

Request:

http://localhost:8080/ibi_apps/rs/ibfs/WFC/Repository/Financial_Reports
/Quarterly/Income_Statement_March_2010.fex?IBIRS_action=delete

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="IBFSMRObject" appName="ibisamp" binary="false" createdBy="admin"
    createdOn="1345218342649" defaultLng="en_US" description="Income Statement - March 2010"
    dummy="false" extension="fex"
fullPath="IBFS:/WFC/Repository/Financial_Reports/Quarterly/
  Income_Statement_March_2010.fex"
    handle="7fefd079_cc95_4b8e_a99e_6d2f71e23020" inheritedPrivacy="true" lastModified="1345218342649"
    lastaccessBy="admin" lastaccessOn="1345219257305" lastmodBy="admin" length="5231"
    name="Income_Statement_March_2010.fex" ownerId="10001" ownerName="admin" ownerType="U"
    policy="//v+f//////f9/////9///////+AAAAA" returnedLng="en_US" type="FexFile">
  <content _jt="IBFSByteContent" char_set="Cp1252">LSpEbyBub3QgZGVsZXRlIG9yIG1vZGlmeSB0aGUgY2
9tbWVudHMgYmV...1NVTU1BUlkuUVVPVEVEU1RSSU5HLCAkCkVORFNUWUx
FCkVORAoKLVJVTgo=
  </content>
  <nlsValues _jt="HashMap" loadFactor="0.75" threshold="12">
   <entry>
   <key _jt="string" value="en_US"/>
   <value _jt="ArrayList" size="2">
   <item _jt="string" index="0" value="Income Statement - March 2010"/>
    </value>
   </entry>
  </nlsValues>
  <properties size="1">
   <entry key="tool" value="infoAssist,report,IAFull"/>
  </properties>
 </rootObject>
</ibfsrpc>

If the value for the returncode attribute in the XML response is 10000, then the report was successfully deleted.


Top of page

x
Listing Folders and Subfolders

This RESTful web service request can be used to retrieve a list of folders and subfolders within WebFOCUS Managed Reporting.

HTTP Method: GET

REST URL Format:

http://host:port/ibi_apps/rs/ibfs/WFC/Repository/FolderName?IBIRS_action=get

where:

host

Is the name of the system where WebFOCUS is installed.

port

Is the port number used by WebFOCUS.

FolderName

Is the name of the folder to be used in retrieving a list of its subfolders. To obtain a list of folders, FolderName should not be included in the REST URL. To obtain additional levels of subfolders for a particular subfolder, the path to the subfolder name must be included in the REST URL. For example, ParentFolderName/FolderName.

Example 1:

In the following example, a list of folders is retrieved.

Request:

http://localhost:8080/ibi_apps/rs/ibfs/WFC/Repository?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="IBFSMRObject" binary="false" container="true" createdBy="WebFOCUS"
    createdOn="1344536982043" defaultLng="en_US" description="Content" dummy="false"
    effectiveRSName="EDASERVE" expireDate="1344536982047" externalId=""
    fullPath="IBFS:/WFC/Repository" handle="000000000001" lastModified="1344536982047"
    lastaccessBy="admin" lastaccessOn="1345146849357" lastmodBy="WebFOCUS" length="0"
    name="Repository" policy="///+f///////9/////////////+AAAAA" returnedLng="en_US"
    summary="Content Root" type="MRRepository">
  <children _jt="ArrayList" size="3">
   <item _jt="IBFSMRObject" binary="false" container="true" createdBy="WebFOCUS"
      createdOn="1344536982083" defaultLng="en_US" description="Public" dummy="false"
    effectiveRSName="EDASERVE" expireDate="1344536982083" externalId=""
      fullPath="IBFS:/WFC/Repository/Public" handle="000000000004" index="0"
lastModified="1344536982083" lastaccessBy="admin" lastaccessOn="1344957209010"
      lastmodBy="WebFOCUS" length="0" name="Public" parent="Repository"
      policy="///+f///////9/////////////+AAAAA" returnedLng="en_US"
      summary="Public Folder" type="MRFolder">
    <nlsValues _jt="HashMap" loadFactor="0.75" threshold="12">
     <entry>
      <key _jt="string" value="en_US"/>
      <value _jt="ArrayList" size="2">
       <item _jt="string" index="0" value="Public"/>
       <item _jt="string" index="1" value="Public Folder"/>
      </value>
     </entry>
    </nlsValues>
    <properties size="0"/>
   </item>
   <item _jt="IBFSMRObject" binary="false" container="true" createdBy="admin"
      createdOn="1345146734216" defaultLng="en_US" description="SEC Filings" dummy="false"
      effectiveRSName="EDASERVE" fullPath="IBFS:/WFC/Repository/Financial_Reports"
      handle="75d099c0_163a_46d8_ba25_ec0be965b15d" index="1" lastModified="1345146734216"
      lastaccessBy="admin" lastaccessOn="1345146755132" lastmodBy="admin" length="0"
      name="Financial_Reports" ownerId="10001" ownerName="admin" ownerType="U"
      parent="Repository" policy="//v+f///////9/////////////+AAAAA"
      returnedLng="en_US"
      summary="Quarterly and Yearly Financial Reports reported to the Securities and Exchange Commission"
      type="MRFolder">
    <nlsValues _jt="HashMap" loadFactor="0.75" threshold="12">
     <entry>
      <key _jt="string" value="en_US"/>
      <value _jt="ArrayList" size="2">
       <item _jt="string" index="0" value="SEC Filings"/>
       <item _jt="string" index="1"
          value="Quarterly and Yearly Financial Reports reported to the Securities and Exchange Commission"/>
      </value>
     </entry>
    </nlsValues>
    <properties size="0"/>
   </item>
   <item _jt="IBFSMRObject" binary="false" container="true" createdBy="admin" createdOn="1344607303673"
      defaultLng="en_US" description="RESTful Web Services" dummy="false" effectiveRSName="EDASERVE"
      fullPath="IBFS:/WFC/Repository/RESTful_Web_Services" handle="ac08f200_d2f2_4ab6_9b60_b62d8f2ad345"
      index="2" lastModified="1344957300737" lastaccessBy="admin" lastaccessOn="1345146071751"
      lastmodBy="admin" length="0" name="RESTful_Web_Services" ownerId="10001" ownerName="admin"
      ownerType="U" parent="Repository" policy="//v+f///////9/////////////+AAAAA" returnedLng="en_US"
      summary="For documenting RESTful Web Services" type="MRFolder">
    <nlsValues _jt="HashMap" loadFactor="0.75" threshold="12">
     <entry>
      <key _jt="string" value="en_US"/>
      <value _jt="ArrayList" size="2">
       <item _jt="string" index="0" value="RESTful Web Services"/>
       <item _jt="string" index="1" value="For documenting RESTful Web Services"/>
      </value>
     </entry>
    </nlsValues>
    <properties size="0"/>
   </item>
  </children>
  <nlsValues _jt="HashMap" loadFactor="0.75" threshold="12">
   <entry>
    <key _jt="string" value="en_US"/>
    <value _jt="ArrayList" size="2">
     <item _jt="string" index="0" value="Content"/>
     <item _jt="string" index="1" value="Content Root"/>
    </value>
   </entry>
  </nlsValues>
  <properties size="0"/>
 </rootObject>
</ibfsrpc>

Each folder definition is defined within the opening and closing item tag. The type attribute for a folder is MRFolder. The name attribute defines the name of the folder. The description attribute defines the title for the folder. The summary attribute defines a brief description for the contents of the folder.

In this example, there are three folders, as listed in the following table.

Folder Name

Title

Summary

Public

Public

Public Folder.

RESTful_Web_Services

RESTful Web Services

For documenting RESTful Web Services.

Financial_Reports

SEC Filings

Quarterly and Yearly Financial Reports reported to the Securities and Exchange Commission.

Example 2:

In the following example, a list of subfolders for the SEC Filings (Financial_Reports) folder is retrieved.

Request:

http://localhost:8080/ibi_apps/rs/ibfs/WFC/Repository/Financial_Reports?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="IBFSMRObject" binary="false" container="true" createdBy="admin"
    createdOn="1345146734216" defaultLng="en_US" description="SEC Filings" dummy="false"
    effectiveRSName="EDASERVE" fullPath="IBFS:/WFC/Repository/Financial_Reports"
    handle="75d099c0_163a_46d8_ba25_ec0be965b15d" lastModified="1345146734216"
    lastaccessBy="admin" lastaccessOn="1345147040831" lastmodBy="admin" length="0"
    name="Financial_Reports" ownerId="10001" ownerName="admin"
ownerType="U"
    policy="//v+f///////9/////////////+AAAAA" returnedLng="en_US"
    summary="Quarterly and Yearly Financial Reports reported to the Securities and Exchange Commission"
    type="MRFolder">
  <children _jt="ArrayList" size="1">
   <item _jt="IBFSMRObject" binary="false" container="true" createdBy="admin" createdOn="1345147005204"
      defaultLng="en_US" description="Quarterly" dummy="false" effectiveRSName="EDASERVE"
      fullPath="IBFS:/WFC/Repository/Financial_Reports/Quarterly" handle="a0cfcde1_fb34_4b07_b20d_4144094ec5c2"
      index="0" inheritedPrivacy="true" lastModified="1345147005204" lastaccessBy="admin"
      lastaccessOn="1345147013034" lastmodBy="admin" length="0" name="Quarterly" ownerId="10001"
      ownerName="admin" ownerType="U" parent="Financial_Reports" policy="//v+f//////f9/////9///////+AAAAA"
      returnedLng="en_US"
      summary="Quarterly Financial Reports reported to the Securities and 
Exchange Commission" type="MRFolder">
    <nlsValues _jt="HashMap" loadFactor="0.75" threshold="12">
     <entry>
      <key _jt="string" value="en_US"/>
      <value _jt="ArrayList" size="2">
       <item _jt="string" index="0" value="Quarterly"/>
       <item _jt="string" index="1"
           value="Quarterly Financial Reports reported to the Securities and Exchange Commission"/>
      </value>
     </entry>
    </nlsValues>
    <properties size="0"/>
   </item>
  </children>
  <nlsValues _jt="HashMap" loadFactor="0.75" threshold="12">
   <entry>
    <key _jt="string" value="en_US"/>
    <value _jt="ArrayList" size="2">
     <item _jt="string" index="0" value="SEC Filings"/>
     <item _jt="string" index="1"
           value="Quarterly and Yearly Financial Reports reported to the Securities and Exchange Commission"/>
    </value>
   </entry>
  </nlsValues>
  <properties size="0"/>
 </rootObject>
</ibfsrpc>

Each folder definition is defined within the opening and closing item tag. The name attribute defines the name of the folder. The description attribute defines the title for the folder. The summary attribute defines a brief description for the contents of the folder.

In this example, there is one subfolder, as listed in the following table.

Subfolder Name

Title

Summary

Quarterly

Quarterly

Quarterly Financial Reports reported to the Securities and Exchange Commission.



x
Listing Reports, Schedules, and Library Content Within WebFOCUS Managed Reporting

This RESTful web service request can be used to retrieve the content list within a folder. The content can be additional subfolders, WebFOCUS reports, ReportCaster Schedules, and Library Content.

HTTP Method: GET

REST URL Format:

http://host:port/ibi_apps/rs/ibfs/WFC/Repository/FolderName?IBIRS_action=get

where:

host

Is the name of the system where WebFOCUS is installed.

port

Is the port number used by WebFOCUS.

FolderName

Is the name of the folder to be used in retrieving the content list. If the content exists in a subfolder, then the path to the subfolder name must be included in the REST URL. For example, ParentFolderName/FolderName.

Example:

In the following example, a content list for the Car_Reports folder is retrieved. The Car_Reports folder is a subfolder of the RESTful_Web_Services folder.

Request:

http://localhost:8080/ibi_apps/rs/ibfs/WFC/Repository/RESTful_
Web_Services/Car_Reports?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="IBFSMRObject" binary="false" container="true" createdBy="admin"
    createdOn="1344607319557" defaultLng="en_US" description="Car Reports" dummy="false"
    effectiveRSName="EDASERVE" fullPath="IBFS:/WFC/Repository/RESTful_Web_Services/Car_Reports"
    handle="c60b1f9a_05ef_4e72_a737_e869917607db" inheritedPrivacy="true" lastModified="1344607319557"
    lastaccessBy="admin" lastaccessOn="1345149848357" lastmodBy="admin" length="0" name="Car_Reports"
    ownerId="10001" ownerName="admin" ownerType="U" policy="//v+f//////f9/////9///////+AAAAA"
    returnedLng="en_US" type="MRFolder">
  <children _jt="ArrayList" size="6">
   <item _jt="IBFSMRObject" binary="false" container="true" createdBy="admin" createdOn="1345149829421"
      defaultLng="en_US" description="Manufacturing Reports" dummy="false" effectiveRSName="EDASERVE"
fullPath="IBFS:/WFC/Repository/RESTful_Web_Services/Car_Reports/
Manufacturing_Reports"
      handle="bb7ea628_2068_4d1c_b3cb_80555a30d53f" index="0" inheritedPrivacy="true"
      lastModified="1345149829421" lastaccessBy="admin" lastaccessOn="1345149829421" lastmodBy="admin"
      length="0" name="Manufacturing_Reports" ownerId="10001" ownerName="admin" ownerType="U"
      parent="Car_Reports" policy="//v+f//////f9/////9///////+AAAAA" returnedLng="en_US" type="MRFolder">
    <nlsValues _jt="HashMap" loadFactor="0.75" threshold="12">
     <entry>
      <key _jt="string" value="en_US"/>
      <value _jt="ArrayList" size="2">
       <item _jt="string" index="0" value="Manufacturing Reports"/>
      </value>
     </entry>
    </nlsValues>
    <properties size="0"/>
   </item>
   <item _jt="IBFSMRObject" appName="ibisamp" binary="false" createdBy="admin" createdOn="1345044807527"
      defaultLng="en_US" description="Sales Chart By Country" dummy="false" effectiveAppName="ibisamp"
      effectiveRSName="EDASERVE"
      extension="fex" fullPath="IBFS:/WFC/Repository/RESTful_Web_Services/Car_Reports/
Sales_Chart_By_Country.fex"
      handle="5f4447c8_406e_41f6_8eca_7e056a4c1f27" index="1" inheritedPrivacy="true"
      lastModified="1345044807527" lastaccessBy="admin" lastaccessOn="1345047740027" lastmodBy="admin"
      length="5623" name="Sales_Chart_By_Country.fex" ownerId="10001" ownerName="admin" ownerType="U"
      parent="Car_Reports" policy="//v+f//////f9/////9///////+AAAAA" 
returnedLng="en_US" type="FexFile">
    <nlsValues _jt="HashMap" loadFactor="0.75" threshold="12">
     <entry>
      <key _jt="string" value="en_US"/>
      <value _jt="ArrayList" size="2">
       <item _jt="string" index="0" value="Sales Chart By Country"/>
      </value>
     </entry>
    </nlsValues>
    <properties size="1">
     <entry key="tool" value="infoAssist,chart,IAFull"/>
    </properties>
   </item>
   .
   .
   .
      <item _jt="CasterLibVersion" compressFormat="O$$" compressSize="0" format="HTML"
          id="L8c1297c1l6131l4a1flaccel6fc9173c28b9" index="1" size="1284" versionNumber="3">
       <createDate _jt="calendar" time="1344779970997" timeZone="America/New_York"/>
       <expireDate _jt="calendar" time="32474876370997" timeZone="America/New_York"/>
      </item>
      <item _jt="CasterLibVersion" compressFormat="O$$" compressSize="0" format="HTML"
          id="L84a1a1bcle500l4fd4l9eb2ld05515d9f90c" index="2" size="1284" versionNumber="4">
       <createDate _jt="calendar" time="1344978446241" timeZone="America/New_York"/>
       <expireDate _jt="calendar" time="32474902046242" timeZone="America/New_York"/>
      </item>
      <item _jt="CasterLibVersion" compressFormat="O$$" compressSize="0" format="HTML"
          id="L95dd1bb0l42d0l45a9l9b0flb4ee0ce8390f" index="3" size="1284" versionNumber="5">
       <createDate _jt="calendar" time="1344978694335" timeZone="America/New_York"/>
       <expireDate _jt="calendar" time="32474902294335" timeZone="America/New_York"/>
      </item>
     </versionList>
     <category class="ibi.broker.api.data.library.Category" id="RESTful_Web_Services/"
          isCategory="true" isMre="false" name="Weekly Reports"/>
    </casterObject>
   </item>
  </children>
  <nlsValues _jt="HashMap" loadFactor="0.75" threshold="12">
   <entry>
    <key _jt="string" value="en_US"/>
    <value _jt="ArrayList" size="2">
     <item _jt="string" index="0" value="Car Reports"/>
    </value>
   </entry>
  </nlsValues>
  <properties size="0"/>
 </rootObject>
</ibfsrpc>

Each content definition is defined within the opening and closing item tag.

The type attribute defines the content type for one of the following content items:

The name attribute defines the name for the content item. The description attribute defines the title for the item. The summary attribute defines a brief description for the content item.


Top of page

x
Listing the Versions for a Stored Report in the ReportCaster Library

This RESTful web service request can be used to retrieve the versions list for a stored WebFOCUS report within the ReportCaster Library.

HTTP Method: GET

REST URL Format:

http://host:port/ibi_apps/rs/ibfs/WFC/Repository/FolderName/ContentName?IBIRS_action=get

where:

host

Is the name of the system where WebFOCUS is installed.

port

Is the port number used by WebFOCUS.

FolderName

Is the name of the folder used for the stored WebFOCUS report. If the folder used for the stored WebFOCUS report exists as a subfolder, then the path to the subfolder name must be included in the REST URL. For example, TopFolderName/SubFolderName.

ContentName

Is the name of the stored WebFOCUS report as defined in the name attribute when listing the content of a folder. For more information, see Listing Reports, Schedules, and Library Content Within WebFOCUS Managed Reporting.

Example:

In the following example, a versions list for the stored library report identified by L1748ltvgq02.lib within the Car_Reports folder is retrieved. The Car_Reports folder is a subfolder of the RESTful_Web_Services folder. L1748ltvgq02.lib is defined in the name attribute when listing the content of a folder. For more information, see Listing Reports, Schedules, and Library Content Within WebFOCUS Managed Reporting.

The description attribute in the content list defines the title for stored report content. The title for L1748ltvgq02.lib, as per the Listing Reports, Schedules, and Library Content example, is defined as Sales for a Specific Country.

Request:

http://localhost:8080/ibi_apps/rs/ibfs/WFC/Repository/RESTful_
Web_Services/Car_Reports/L1748ltvgq02.lib?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="IBFSCasterObject" binary="false" createdBy="admin" createdOn="1344616201760"
    defaultLng="en_US" description="Sales for a Specific Country" dummy="false"
    effectiveRSName="EDASERVE" extension="lib" externalId="Le218a4d048cd45e4f9174bf1edc5e5a6"
fullPath="IBFS:/WFC/Repository/RESTful_Web_Services/
Car_Reports/L1748ltvgq02.lib"
    handle="51254a92I811dI4cd1Ib9f9If456ca5f00b9" inheritedPrivacy="true"
lastModified="1344616201760"
    lastaccessBy="admin" lastaccessOn="1345147221049" lastmodBy="admin" length="0"
    name="L1748ltvgq02.lib" ownerId="10001" ownerName="admin"
    ownerType="U"
    policy="//v+f//////f9/////9///////+AAAAA" returnedLng="en_US" summary="Sales for a Specific Country"
    type="CasterLibrary">
  <nlsValues _jt="HashMap" loadFactor="0.75" threshold="12">
   <entry>
    <key _jt="string" value="en_US"/>
    <value _jt="ArrayList" size="2">
   <item _jt="string" index="0" value="Sales for a Specific Country"/>
   <item _jt="string" index="1" value="Sales for a Specific Country"/>
    </value>
   </entry>
  </nlsValues>
  <properties size="2">
   <entry key="id" value="Le218a4d048cd45e4f9174bf1edc5e5a6"/>
   <entry key="tool" value="reportlibrary"/>
  </properties> 
  <casterObject _jt="CasterContent" accessList="" accessType="OWNER" category="Weekly Reports"
    description="Sales for a Specific Country" expireInterval="1" expireMode="N"
    ibfsId="51254a92I811dI4cd1Ib9f9If456ca5f00b9"
ibfsPath="IBFS:/WFC/Repository/RESTful_Web_Services/Car_Reports" id="Le218a4d048cd45e4f9174bf1edc5e5a6"
    isWatch="false" lastExecution="1344978694335" lastVersion="5" name="L1748ltvgq02.lib" owner="admin"
policy="subscribe,|,open,delete,rename,|,security;makeRules;viewRules"
 reportgid="51254a92I811dI4cd1Ib9f9If456ca5f00b9" scheduleId="Sa48ba1f3sa760s4e57sb349s4abda6168a17"
    summary="Sales for a Specific Country" taskId="T66ca1a2btd636t4e1dtad30t6930ae58ea09">
   <lastExecTime _jt="calendar" time="1344978694335" timeZone="America/New_York"/>
   <versionList _jt="array" itemsClass="CasterLibVersion" size="4">
    <item _jt="CasterLibVersion" compressFormat="O$$" compressSize="0" format="HTML"
       id="Lf7badbf2lca1cl4dcfla05dl5a8ddb387705" index="0" size="1284" versionNumber="2">
     <createDate _jt="calendar" time="1344616201629"
 timeZone="America/New_York"/>
     <expireDate _jt="calendar" time="32474885401652"
 timeZone="America/New_York"/>
    </item>
    <item _jt="CasterLibVersion" compressFormat="O$$" compressSize="0" format="HTML"
       id="L8c1297c1l6131l4a1flaccel6fc9173c28b9" index="1" size="1284" versionNumber="3">
     <createDate _jt="calendar" time="1344779970997"
 timeZone="America/New_York"/>
timeZone="America/New_York"/>
     <expireDate _jt="calendar" time="32474902046242" timeZone="America/New_York"/>
    </item>
    <item _jt="CasterLibVersion" compressFormat="O$$" compressSize="0" format="HTML"
       id="L95dd1bb0l42d0l45a9l9b0flb4ee0ce8390f" index="3" size="1284" versionNumber="5">
     <createDate _jt="calendar" time="1344978694335" timeZone="America/New_York"/>
     <expireDate _jt="calendar" time="32474902294335" timeZone="America/New_York"/>
    </item>
   </versionList>
   <category class="ibi.broker.api.data.library.Category" id="RESTful_Web_Services/" isCategory="true"
       isMre="false" name="Weekly Reports"/>
  </casterObject>
 </rootObject>
</ibfsrpc>

Each version definition is defined within the opening and closing item tag.

The version attributes are defined in the following list:


Top of page

x
Listing the Parameters for a Report Within Managed Reporting

This RESTful web service request can be used to retrieve the current parameters for a WebFOCUS report in WebFOCUS Managed Reporting.

HTTP Method: GET

REST URL Format:

http://host:port/ibi_apps/rs/ibfs/WFC/Repository/FolderName/FexName?IBIRS_action=describeFex

where:

host

Is the name of the system where WebFOCUS is installed.

port

Is the port number used by WebFOCUS.

FolderName

Is the name of the folder used for the stored WebFOCUS report. If the folder used for the stored WebFOCUS report exists as a subfolder, then the path to the subfolder name must be included in the REST URL. For example, TopFolderName/SubFolderName.

FexName

Is the name of the WebFOCUS report as defined in the name attribute when listing the content of a folder. For more information, see Listing Reports, Schedules, and Library Content Within WebFOCUS Managed Reporting.

Example:

In the following example, the current parameters for the Sales_for_a_Specific_Country.fex, which exists in the Car_Reports folder, is retrieved. The Car_Reports folder is a subfolder of the RESTful_Web_Services folder. Sales_for_a_Specific_Country.fex is defined in the name attribute when listing the content of a folder. For more information, see Listing Reports, Schedules, and Library Content Within WebFOCUS Managed Reporting.

Request:

http://localhost:8080/ibi_apps/rs/ibfs/WFC/Repository/RESTful_Web_
Services/Car_Reports/Sales_for_a_Specific_Country.fex?IBIRS_action=describeFex

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 class="com.ibi.wfrs.IBFSWFDescribe" isSavedParam="false">
  <bindingInfo _jt="HashMap" loadFactor="0.75" threshold="24">
   <entry>
    <key _jt="string" value="SUBSYSTEM"/>
    <value class="com.ibi.wfrs.BindingVar" isReqParm="false" value="Self Service"/>
   </entry>
   <entry>
  <key _jt="string" value="IBI_WF_charset"/>
  <value class="com.ibi.wfrs.BindingVar" isReqParm="false" value="windows-1252"/>
   </entry>
   <entry>
    <key _jt="string" value="IBI_Webapp_Context_Default"/>
    <value class="com.ibi.wfrs.BindingVar" isReqParm="false" value="/ibi_apps"/>
   </entry>
   <entry>
    <key _jt="string" value="SCRIPT_NAME"/>
    <value class="com.ibi.wfrs.BindingVar" isReqParm="false" value="/ibi_apps/WFServlet"/>
   </entry>
   <entry>
    <key _jt="string" value="IBFS1_action"/>
    <value class="com.ibi.wfrs.BindingVar" isReqParm="true" value="runItem"/>
   </entry>
   .
   .
   .
   <entry>
    <key _jt="string" value="SAVE_PARMRPT"/>
    <value class="com.ibi.wfrs.BindingVar" isReqParm="false"
value="IBFS:/WFC/Repository/RESTful_Web_Services/Car_Reports/
Sales_for_a_Specific_Country.fex"/>
   </entry>
  </bindingInfo>
  <amperMap accessOrder="false" class="java.util.LinkedHashMap" loadFactor="0.75" threshold="12">
   <entry>
    <key _jt="string" value="FOCFOCEXEC"/>
    <value class="com.ibi.wfrs.AmperVar" format="" max="0.0" min="0.0" name="FOCFOCEXEC" strDef="">
     <type class="com.ibi.wfrs.IBFSAmperVarType" name="system"/>
   <displayType class="com.ibi.wfrs.IBFSAmperDisplayType" name="prompt"/>
    <values accessOrder="false" class="java.util.LinkedHashMap"
loadFactor="0.75" threshold="12"/>
    </value>
   </entry>
   <entry>
    <key _jt="string" value="FOCEXURL"/>
    <value class="com.ibi.wfrs.AmperVar" format="" max="0.0" min="0.0" name="FOCEXURL" strDef="">
   <type class="com.ibi.wfrs.IBFSAmperVarType" name="set"/>
  <displayType class="com.ibi.wfrs.IBFSAmperDisplayType" name="prompt"/>
   <values accessOrder="false" class="java.util.LinkedHashMap" loadFactor="0.75" threshold="12"/>
    </value>
   </entry>
   <entry>
    <key _jt="string" value="FOCHTMLURL"/>
    <value class="com.ibi.wfrs.AmperVar" format="" max="0.0" min="0.0" name="FOCHTMLURL" strDef="">
     <type class="com.ibi.wfrs.IBFSAmperVarType" name="set"/>
   <displayType class="com.ibi.wfrs.IBFSAmperDisplayType" name="prompt"/>
     <values accessOrder="false" class="java.util.LinkedHashMap" loadFactor="0.75" threshold="12"/>
    </value>
   </entry>
   <entry>
    <key _jt="string" value="GOOGLEMAPSAPIKEY"/>
    <value class="com.ibi.wfrs.AmperVar" format="" max="0.0" min="0.0" name="GOOGLEMAPSAPIKEY" strDef="">
     <type class="com.ibi.wfrs.IBFSAmperVarType" name="set"/>
   <displayType class="com.ibi.wfrs.IBFSAmperDisplayType" name="prompt"/>
     <values accessOrder="false" class="java.util.LinkedHashMap" loadFactor="0.75" threshold="12"/>
    </value>
   </entry>
   <entry>
    <key _jt="string" value="FOCREL"/>
    <value class="com.ibi.wfrs.AmperVar" format="" max="0.0" min="0.0" name="FOCREL" strDef="">
     <type class="com.ibi.wfrs.IBFSAmperVarType" name="system"/>
   <displayType class="com.ibi.wfrs.IBFSAmperDisplayType" name="prompt"/>
    <values accessOrder="false" class="java.util.LinkedHashMap" loadFactor="0.75" threshold="12"/>
    </value>
   </entry>
   <entry>
    <key _jt="string" value="EXCELSERVURL"/>
    <value class="com.ibi.wfrs.AmperVar" format="" max="0.0" min="0.0" name="EXCELSERVURL" strDef="">
     <type class="com.ibi.wfrs.IBFSAmperVarType" name="set"/>
   <displayType class="com.ibi.wfrs.IBFSAmperDisplayType" name="prompt"/>
     <values accessOrder="false" class="java.util.LinkedHashMap" loadFactor="0.75" threshold="12"/>
    </value>
   </entry>
   <entry>
    <key _jt="string" value="COUNTRY"/>
    <value class="com.ibi.wfrs.AmperVar" description="Select Country:" format="" max="0.0" min="0.0"
        name="COUNTRY" operation="" strDef="">
     <type class="com.ibi.wfrs.IBFSAmperVarType" name="unresolved"/>
     <displayType class="com.ibi.wfrs.IBFSAmperDisplayType" name="staticType"/>
     <values accessOrder="false" class="java.util.LinkedHashMap" loadFactor="0.75" threshold="12">
      <entry>
       <key _jt="string" value="ENGLAND"/>
       <value _jt="string" value="ENGLAND"/>
      </entry>
      <entry>
       <key _jt="string" value="JAPAN"/>
       <value _jt="string" value="JAPAN"/>
      </entry>
      <entry>
       <key _jt="string" value="FRANCE"/>
       <value _jt="string" value="FRANCE"/>
      </entry>
     </values>
    </value>
   </entry>
  </amperMap>
 </rootObject>
</ibfsrpc>

Each parameter definition is defined within the opening and closing entry tag.

The XML response that is returned includes many system parameters along with the parameters defined in the WebFOCUS report. Entries that have a name attribute for the type element of either unresolved or defaultType are the WebFOCUS report parameters, as shown in the following example:

<type class="com.ibi.wfrs.IBFSAmperVarType" name="unresolved"/>

The name attribute within the value element defines the parameter that is being used in the selection, as shown in the following example:

<value class="com.ibi.wfrs.AmperVar" description="Select Country:" format=""
    max="0.0" min="0.0" name="COUNTRY" operation="" strDef="">

The description attribute within the value element defines the prompt title for the parameter.

If a parameter definition within a WebFOCUS report has a list of valid values for the selection, additional entry elements will exist in the XML within the parameter definition. The value attribute within the key element would contain each valid value.

<entry><key _jt="string" value="ENGLAND"/><value _jt="string" value="ENGLAND"/></entry>
<entry><key _jt="string" value="JAPAN"/><value _jt="string" value="JAPAN"/></entry>
<entry><key _jt="string" value="FRANCE"/><value _jt="string" value="FRANCE"/></entry>

In this example, ENGLAND, JAPAN, and FRANCE are the valid values that can be passed to this parameter.


Top of page

x
Running a Report From WebFOCUS Managed Reporting

This RESTful web service request can be used to run a report stored in the WebFOCUS Managed Reporting repository.

HTTP Method: POST

REST URL Format:

http://host:port/ibi_apps/rs/ibfs/WFC/Repository/FolderName/ReportName

where:

host

Is the name of the system where WebFOCUS is installed.

port

Is the port number used by WebFOCUS.

FolderName

Is the name of the folder used for the stored WebFOCUS report. If the folder used for the stored WebFOCUS report exists as a subfolder, then the path to the subfolder name must be included in the REST URL. For example, TopFolderName/SubFolderName.

ReportName

Is the name of the WebFOCUS report to run. It must include a .fex extension.

Body Format:

IBIRS_action=run&IBIRS_clientPath=clientPath&IBIRS_htmlPath=htmlPath&
userName=Userid&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
htmlPath

Is the path to the WebFOCUS ibi_html directory structure. For example:

http://localhost:8080/ibi_apps/ibi_html

The ibi_html directory can be copied from the WebFOCUS directory structure to another location and then have the IBIRS_htmlPath parameter point to that new location.

This parameter is optional and is mainly used when running reports that need to access images and JavaScript that are packaged with WebFOCUS (for example, On-Demand Paging reports). For an example of its usage, see Visual Basic .NET and Java Code Examples.

Userid

Is the Reporting Server user ID. If the Reporting Server is running with Security Off or the 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 Reporting Server password. If the Reporting Server is running with Security Off or the 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 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 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/WFC/Repository/RESTful_Web_Services/
Car_Reports/Sales_for_a_Specific_Country.fex

Body:

IBIRS_action=run&COUNTRY=JAPAN

Response:

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


Top of page

x
Change Management Export

This RESTful web service request can be used to export directories, files, and groups to be used by Change Management Import.

Note: This RESTful web service is common to functionality in WebFOCUS Managed Reporting and the Reporting Server.

HTTP Method: POST

REST URL Format:

http://host:port/ibi_apps/rs/impex

where:

host

Is the name of the system where WebFOCUS is installed.

port

Is the port number used by WebFOCUS.

Body Format:

IBIRS_action=cmExport&IBIRS_fileName=fileName

where:

fileName

Is the name of the scenario for the Change Management Export. The scenario must exist in the /WebFOCUSxx/cm/export folder.

Example:

In the following example, the Change Management scenario called RESTWS is exported.

Request:

http://localhost:8080/ibi_apps/rs/impex

Body:

IBIRS_action=cmExport&IBIRS_fileName=RESTWS

Response:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<ibfsrpc _jt="IBFSResponseObject" language="EN" name="cmExport" returncode="10000" returndesc="SUCCESS" subreturncode="0" subsystem="SSYS" type="simple">
	<ibfsparams size="1">
		<entry key="IBIRS_fileName" value="RESTWS"/>
	</ibfsparams>
	<rootObject _jt="string"/>
</ibfsrpc>

If the value for the returncode attribute in the XML response is 10000, then the scenario was exported successfully.


Top of page

x
Change Management Import

This RESTful web service request can be used to import directories, files, and groups that were created using Change Management Export.

Note: This RESTful web service is common to functionality in WebFOCUS Managed Reporting and the Reporting Server.

HTTP Method: POST

REST URL Format:

http://host:port/ibi_apps/rs/impex

where:

host

Is the name of the system where WebFOCUS is installed.

port

Is the port number used by WebFOCUS.

Body Format:

IBIRS_action=cmImport&IBIRS_fileName=fileName&IBIRS_resOverwrite=Overwrite 
&IBIRS_importUsers=UserOpt&IBIRS_importRoles=RoleOpt 
&IBIRS_importRules=RuleOpt&IBIRS_importGroups=GroupOpt

where:

fileName

Is the name of the scenario in the Change Management Export. The scenario must exist in the /WebFOCUSxx/cm/import folder.

Overwrite

Can be set as follows:

  • true. Overwrites existing files and groups.
  • false. Does not overwrite existing files and groups.
UserOpt

Can be set as follows:

  • 0. Do not import users.
  • 1. Import users but do not overwrite.
  • 2. Import users and overwrite.
RoleOpt

Can be set as follows:

  • 0. Do not import roles.
  • 1. Import roles but do not overwrite.
  • 2. Import roles and overwrite.
RuleOpt

Can be set as follows:

  • true. Import rules.
  • false. Do not import rules.
GroupOpt

Can be set as follows:

  • 0. Do not import groups.
  • 1. Import groups but do not overwrite.
  • 2. Import groups and overwrite.

Example:

In the following example, the Change Management scenario called ImportMR is imported. Existing files will not be overwritten. Users, groups, roles, and rules will not be imported.

Request:

http://localhost:8080/ibi_apps/rs/impex

Body:

IBIRS_action=cmImport&IBIRS_fileName=ImportMR&IBIRS_resOverwrite=false
&IBIRS_importUsers=0&IBIRS_importRoles=0&IBIRS_importRules=false&IBIRS_importGroups=0

Response:

<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
<ibfsrpc _jt="IBFSResponseObject" language="EN" name="cmImport" returncode="10000"
  returndesc="SUCCESS" subreturncode="0" subsystem="SSYS" type="simple">
 <ibfsparams size="7">
  <entry key="IBIRS_resOverwrite" value="false"/>
  <entry key="IBIRS_fileName" value="ImportMR"/>
  <entry key="IBIRS_runOptions" value="0"/>
  <entry key="IBIRS_importUsers" value="0"/>
  <entry key="IBIRS_importRoles" value="0"/>
  <entry key="IBIRS_importRules" value="false"/>
  <entry key="IBIRS_importGroups" value="0"/>
 </ibfsparams>
 <rootObject _jt="string"/>
</ibfsrpc>

If the value for the returncode attribute in the XML response is 10000, then the scenario was imported successfully.


Top of page

x
Publishing an Item

This RESTful web service request can be used to publish an item.

HTTP Method: POST

REST URL Format:

http://host:port/ibi_apps/rs/ibfs/WFC/Repository/FolderName/ItemName

where:

host

Is the name of the system where WebFOCUS is installed.

port

Is the port number used by WebFOCUS.

FolderName

Is the name of the folder that will either contain the item (ItemName) to publish or be the folder that is published when ItemName is omitted. If the folder is a subfolder, then the path to the subfolder must be included in the REST URL. For example, TopFolderName/SubFolderName.

ItemName

Is the name of the item to publish, which can include WebFOCUS reports, schedules, library access lists, and library content.

Body Format:

IBIRS_action=publish

Example:

In the following example, a folder called Financial_Reports is published.

Request:

http://localhost:8080/ibi_apps/rs/ibfs/WFC/Repository/Financial_Reports

Body:

IBIRS_action=publish

Response:

<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
<ibfsrpc _jt="IBFSResponseObject" language="EN" name="publish" returncode="10000"
             returndesc="SUCCESS" subreturncode="0" subsystem="SSYS" type="simple">
   <ibfsparams size="1">
      <entry key="IBIRS_" value="/WFC/Repository/Financial_Reports"/>
   </ibfsparams>
   <rootObject _jt="string"/>
</ibfsrpc>

Top of page

x
Unpublishing an Item

This RESTful web service request can be used to unpublish an item.

HTTP Method: POST

REST URL Format:

http://host:port/ibi_apps/rs/ibfs/WFC/Repository/FolderName/ItemName

where:

host

Is the name of the system where WebFOCUS is installed.

port

Is the port number used by WebFOCUS.

FolderName

Is the name of the folder that will either contain the item (ItemName) to unpublish or be the folder that is unpublished when ItemName is omitted. If the folder is a subfolder, then the path to the subfolder must be included in the REST URL. For example, TopFolderName/SubFolderName.

ItemName

Is the name of the item to unpublish, which can include WebFOCUS reports, schedules, library access lists, and library content.

Body Format:

IBIRS_action=unpublish&IBIRS_ownerPath=OwnerPath&IBIRS_clearShares=OwnerPath

where:

OwnerPath

If the item is private, then the full path to the owner of the item. For example, /SSYS/USERS/admin.

OwnerPath

If the item is private, specify one of the following:

  • true. Unshares the item.
  • false. Does not unshare the item.

Example:

In the following example, a folder called Financial_Reports is unpublished.

Request:

http://localhost:8080/ibi_apps/rs/ibfs/WFC/Repository/Financial_Reports

Body:

IBIRS_action=unpublish&IBIRS_ownerPath=&IBIRS_clearShares=false

Response:

<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
<ibfsrpc _jt="IBFSResponseObject" language="EN" name="unpublish" returncode="10000"
         returndesc="SUCCESS" subreturncode="0" subsystem="SSYS" type="simple">
   <ibfsparams size="3">
      <entry key="IBIRS_clearShares" value="false"/>
      <entry key="IBIRS_ownerPath"/>
      <entry key="IBIRS_" value="/WFC/Repository/Financial_Reports"/>
   </ibfsparams>
   <rootObject _jt="IBFSUserObject" description="Administrator" dummy="false" email="restadmin@informationbuilders.com"
               fullPath="IBFS:/SSYS/USERS/admin" handle="10001" name="admin"
password="$faa2f1da92f72a7d$0901495f1d42962aa242af8aad5c7958a9f86013
a190482974970e81ee0259ba82cbd3856f01c6f29a
               14abaf602143b5e79b3f18a4244b9018d9115892d363f4" rsPath="/ibi_apps/rs/ibfs/SSYS/USERS/admin" type="User">
      <status _jt="IBSSUserStatus" name="ACTIVE"/>
      <groups _jt="ArrayList" size="0"/>
      <pSetList _jt="ArrayList" size="0"/>
   </rootObject>
</ibfsrpc>

Top of page

x
Copying an Item

This RESTful web service request can be used to copy an item from one folder to another.

HTTP Method: POST

REST URL Format:

http://host:port/ibi_apps/rs/ibfs/WFC/Repository/FolderName/ItemName

where:

host

Is the name of the system where WebFOCUS is installed.

port

Is the port number used by WebFOCUS.

FolderName

Is the name of the folder that will either contain the item (ItemName) to copy or be the folder that is copied when ItemName is omitted. If the folder is a subfolder, then the path to the subfolder must be included in the REST URL. For example, TopFolderName/SubFolderName.

ItemName

Is the name of the item to copy, which can include WebFOCUS reports, schedules, library access lists, and library content.

Body Format:

IBIRS_action=copy&IBIRS_destination=destLocation&IBIRS_replace=destLocation

where:

destLocation

Is the destination location (specified as FolderName/ItemName) of the copied item.

destLocation

Specify one of the following:

  • true. Replaces the contents of the item.
  • false. Does not replace the contents of the item.

Example:

In the following example, the Drilldown_Report.fex WebFOCUS report is copied from the Car_Reports folder within the RESTful_Web_Services folder to the Financial_Reports folder. The contents are replaced.

Request:

http://localhost:8080/ibi_apps/rs/ibfs/WFC/Repository/RESTful_Web_Services/
Car_Reports/Drilldown_Report.fex

Body:

IBIRS_action=copy&IBIRS_destination=/WFC/Repository/Financial_Reports/
Drilldown_Report.fex&IBIRS_replace=true

Response:

<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
<ibfsrpc _jt="IBFSResponseObject" language="EN" name="copy" returncode="10000"
        returndesc="SUCCESS" subreturncode="0" subsystem="SSYS" type="simple">
   <ibfsparams size="4">
      <entry key="IBIRS_destination" value="/WFC/Repository/Financial_Reports/Drilldown_Report.fex"/>
      <entry key="IBIRS_replace" value="true"/>
      <entry key="IBIRS_args" value="__null"/>
      <entry key="IBIRS_" value="/WFC/Repository/RESTful_Web_Services/Car_Reports/
Drilldown_Report.fex"/>
   </ibfsparams>
   <rootObject _jt="IBFSMRObject" binary="false" createdBy="admin" createdOn="1350346978647"defaultLng="en_US"
              description="Drilldown Report" dummy="false" extension="fex" fullPath="IBFS:/WFC/Repository/Financial_Reports/Drilldown_Report.fex"
              handle="afba56f3_3e71_4ecf_9682_c88bb913634a" inheritedPrivacy="true" lastModified="1350348325118" lastaccessBy="admin"
              lastaccessOn="1350348325118" lastmodBy="admin" length="5302" name="Drilldown_Report.fex" ownerId="10001"
              ownerName="admin" ownerType="U" policy="//3/D///9+f7////f7////////8AAAA=" returnedLng="en_US"
rsPath="/ibi_apps/rs/ibfs/WFC/Repository/Financial_Reports/Drilldown_Report.fex" type="FexFile">
      <content _jt="IBFSByteContent" char_set="Cp1252">LSpEbyBub3QgZGVsZXRlIG9yIG1vZGlmeSB0aGUgY29tbWVudHMgYmV
sb3cKLSogVXNlZCB0byBUZXN0IFJFU1QgQ29weSBmdW5jdGlvbmFsaXR5CiotSU5URVJOQUxf
Q09NTUVOVCBMSU5FIzAkUEQ5NGJXd2dkbVZ5YzJsdmJqMGlNUzR3SWlCbGJtTnZaR2x1Wnowa
                   .
                   .
                   .
UQUJMRSBTRVQgSFRNTEVOQ09ERSBPTgpPTiBUQUJMRSBTRVQgU1RZTEUgKgp
JTkNMVURFPUlCRlM6L0ZJTEUvSUJJX0hUTUxfRElSL2phdmFhc3Npc3QvaW
50bC9FTi9FTklBRGVmYXVsdF9jb21iaW5lLnN0eSwkClRZUEU9UkVQT1JULC
BUSVRMRVRFWFQ9JldGX1RJVExFLlFVT1RFRFNUUklORywgU1VNTUFSWT0mV
0ZfU1VNTUFSWS5RVU9URURTVFJJTkcsICQKRU5EU1RZTEUKRU5ECgotUlVOCg==
      </content>
      <nlsValues _jt="HashMap" loadFactor="0.75" threshold="12">
         <entry>
            <key _jt="string" value="en_US"/>
            <value _jt="ArrayList" size="2">
               <item _jt="string" index="0" value="Drilldown Report"/>
            </value>
         </entry>
      </nlsValues>
      <properties size="1">
         <entry key="tool" value="infoAssist,report,IAFull"/>
      </properties>
   </rootObject>
</ibfsrpc>

Top of page

x
Moving an Item

This RESTful web service request can be used to move an item from one folder to another.

HTTP Method: POST

REST URL Format:

http://host:port/ibi_apps/rs/ibfs/WFC/Repository/FolderName/ItemName

where:

host

Is the name of the system where WebFOCUS is installed.

port

Is the port number used by WebFOCUS.

FolderName

Is the name of the folder that will either contain the item (ItemName) to move or be the folder that is moved when ItemName is omitted. If the folder is a subfolder, then the path to the subfolder must be included in the REST URL. For example, TopFolderName/SubFolderName.

ItemName

Is the name of the item to move, which can include WebFOCUS reports, schedules, library access lists, and library content.

Body Format:

IBIRS_action=move&IBIRS_destination=destLocation&IBIRS_replace=ReplaceFlag

where:

destLocation

Is the destination location (specified as FolderName/ItemName) of the moved item.

ReplaceFlag

Specify one of the following:

  • true. Replaces the contents of the item.
  • false. Does not replace the contents of the item.

Example:

In the following example, the Drilldown_Report.fex WebFOCUS report is moved from the Car_Reports folder within the RESTful_Web_Services folder to the Financial_Reports folder. The contents are not replaced.

Request:

http://localhost:8080/ibi_apps/rs/ibfs/WFC/Repository/RESTful_Web_Services/
Car_Reports/Drilldown_Report.fex

Body:

IBIRS_action=move&IBIRS_destination=/WFC/Repository/Financial_Reports/
Drilldown_Report.fex&IBIRS_replace=false

Response:

<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
<ibfsrpc _jt="IBFSResponseObject" language="EN" name="move" returncode="10000"
         returndesc="SUCCESS" subreturncode="0" subsystem="SSYS" type="simple">
  <ibfsparams size="4">
     <entry key="IBIRS_destination" value="/WFC/Repository/Financial_Reports/Drilldown_Report.fex"/>
     <entry key="IBIRS_replace" value="false"/>
     <entry key="IBIRS_args" value="__null"/>
     <entry key="IBIRS_" value="/WFC/Repository/RESTful_Web_Services/Car_Reports/Drilldown_Report.fex"/>
  </ibfsparams>
   <rootObject _jt="IBFSMRObject" binary="false" createdBy="admin" createdOn="1348824882927" defaultLng="en_US"
            description="Drilldown Report" dummy="false" extension="fex"
fullPath="IBFS:/WFC/Repository/Financial_Reports/Drilldown_Report.fex"
              handle="286ace9f_4cd0_4a78_a26d_69dff1b72e0f"
inheritedPrivacy="true" lastModified="1350349735829"
              lastaccessBy="admin" lastaccessOn="1350349735811" lastmodBy="admin" length="5302" name="Drilldown_Report.fex"
              ownerId="10001" ownerName="admin" ownerType="U" policy="//3/D///9+f7////f7////////8AAAA=" returnedLng="en_US"
rsPath="/ibi_apps/rs/ibfs/WFC/Repository/Financial_Reports/Drilldown_Report.fex" type="FexFile">
      <content _jt="IBFSByteContent"
char_set="Cp1252">LSpEbyBub3QgZGVsZXRlIG9yIG1vZGlmeSB0aGUgY
29tbWVudHMgYmVsb3cKLSogVXNlZCB0byBUZXN0IFJFU1QgQ29weSBmdW5j
dGlvbmFsaXR5CiotSU5URVJOQUxfQ09NTUVOVCBMSU5FIzAkUEQ5NGJXd2d
kbVZ5YzJsdmJqMGlNUzR3SWlCbGJtTnZaR2x1Wnowa
                      .
                      .
                      .
RlM6L0ZJTEUvSUJJX0hUTUxfRElSL2phdmFhc3Npc3QvaW50bC9FTi9FTkl
BRGVmYXVsdF9jb21iaW5lLnN0eSwkClRZUEU9UkVQT1JULCBUSVRMRVRFWF
Q9JldGX1RJVExFLlFVT1RFRFNUUklORywgU1VNTUFSWT0mV0ZfU1VNTUFSW
S5RVU9URURTVFJJTkcsICQKRU5EU1RZTEUKRU5ECgotUlVOCg==
      </content>
      <nlsValues _jt="HashMap" loadFactor="0.75" threshold="12">
         <entry>
            <key _jt="string" value="en_US"/>
            <value _jt="ArrayList" size="2">
               <item _jt="string" index="0" value="Drilldown Report"/>
            </value>
         </entry>
      </nlsValues>
      <properties size="1">
         <entry key="tool" value="infoAssist,report,IAFull"/>
      </properties>
   </rootObject>
</ibfsrpc>

Top of page

x
Renaming an Item

This RESTful web service request can be used to rename an item.

HTTP Method: POST

REST URL Format:

http://host:port/ibi_apps/rs/ibfs/WFC/Repository/FolderName/ItemName

where:

host

Is the name of the system where WebFOCUS is installed.

port

Is the port number used by WebFOCUS.

FolderName

Is the name of the folder that will either contain the item (ItemName) to rename or be the folder that is renamed when ItemName is omitted. If the folder is a subfolder, then the path to the subfolder must be included in the REST URL. For example, TopFolderName/SubFolderName.

ItemName

Is the name of the item to rename, which can include WebFOCUS reports, schedules, library access lists, and library content.

Body Format:

IBIRS_action=rename&IBIRS_newName=renamedItem

where:

renamedItem

Is the name of the renamed item.

Example:

In the following example, the Financial_Reports folder is renamed to Financial_Reports_Renamed.

Request:

http://localhost:8080/ibi_apps/rs/ibfs/WFC/Repository/Financial_Reports

Body:

IBIRS_action=rename&IBIRS_newName=Financial_Reports_Renamed

Response:

<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
<ibfsrpc _jt="IBFSResponseObject" language="EN" name="rename" returncode="10000" returndesc="SUCCESS"
         subreturncode="0" subsystem="SSYS" type="simple">
   <ibfsparams size="3">
      <entry key="IBIRS_newName" value="Financial_Reports_Renamed"/>
      <entry key="IBIRS_args" value="__null"/>
      <entry key="IBIRS_" value="/WFC/Repository/Financial_Reports"/>
   </ibfsparams>
  <rootObject _jt="IBFSMRObject" binary="false" container="true" createdBy="admin"
              createdOn="1349964405620" defaultLng="en_US" description="Financial Quarterly-Yearly Reports"
            dummy="false" fullPath="IBFS:/WFC/Repository/Financial_Reports_Renamed"
              handle="5d81bab8_7db7_40c9_96b9_df2b00ce3278" lastModified="1350351652269" lastaccessBy="admin"
              lastaccessOn="1350351652269" lastmodBy="admin" length="0" name="Financial_Reports_Renamed"
              ownerId="10001" ownerName="admin" ownerType="U" policy="//3/D///9+f/////f/////////8AAAA="
              returnedLng="en_US" rsPath="/ibi_apps/rs/ibfs/WFC/Repository/Financial_Reports_Renamed"
              summary="Quarterly and Yearly Financial Reports reported to the Securities and Exchange Commission"
              type="MRFolder">
      <nlsValues _jt="HashMap" loadFactor="0.75" threshold="12">
         <entry>
            <key _jt="string" value="en_US"/>
            <value _jt="ArrayList" size="2">
               <item _jt="string" index="0" value="Financial Quarterly-Yearly Reports"/>
               <item _jt="string" index="1" value="Quarterly and Yearly Financial Reports reported to the Securities and Exchange Commission"/>
            </value>
         </entry>
      </nlsValues>
      <properties size="0"/>
   </rootObject>
</ibfsrpc>

Top of page

x
Uploading a WebFOCUS Report

This RESTful web service request can be used to upload a WebFOCUS report to the WebFOCUS environment.

HTTP Method: POST

REST URL Format:

http://host:port/ibi_apps/rs/ibfs/WFC/Repository/FolderName/FexName

where:

host

Is the name of the system where WebFOCUS is installed.

port

Is the port number used by WebFOCUS.

FolderName

Is the name of the folder that will contain the WebFOCUS report to be uploaded. If the folder is a subfolder, then the path to the subfolder must be included in the REST URL. For example, TopFolderName/SubFolderName.

FexName

Is the name of the WebFOCUS report to be uploaded, which must include a .fex extension.

Body Format:

IBIRS_action=put&IBIRS_object=Object

where:

Object

Is the XML object defining the WebFOCUS report, which uses the following format:

<rootObject _jt="IBFSMRObject" description="ReportTitle" type="FexFile">
 <content _jt="IBFSByteContent" char_set="Cp1252">ContentBase64 </content>
</rootObject>

where:

ContentBase64

Is the base64 encoded text of the WebFOCUS report to be uploaded.

ReportTitle

Is the title of the WebFOCUS report to be uploaded.

Example:

In the following example, a WebFOCUS report called Drilldown_Report.fex is created in the Financial_Reports folder.

Request:

http://localhost:8080/ibi_apps/rs/ibfs/WFC/Repository/Financial_Reports/Drilldown_Report.fex

Body:

IBIRS_action=put&IBIRS_object=<rootObject _jt="IBFSMRObject" description="Drilldown Report" type="FexFile">
  <content _jt="IBFSByteContent" char_set="Cp1252">LSpEbyBub3QgZGVsZXRlIG9yIG1vZGlmeSB0aGUgY29tbWVudHMgYmV
     sb3cKLSogVXNlZCB0byBUZXN0IFJFU1QgTW92ZSBmdW5jdGlvbmFsaXR
     5CiotSU5URVJOQUxfQ09NTUVOVCBMSU5FIzAkUEQ5NGJXd2dkbVZ5YzJ
     sdmJqMGlNUzR3SWlCbGJtTnZaR2x1WnowaVZWUkdMVGdpSUhOMFlXNWt
     ZV3h2Ym1VOUltNXZJajgrRFFvOElTMHRNUzR3TFMw
     .
     .
     .
     TgpPTiBUQUJMRSBTRVQgSFRNTEVOQ09ERSBPTgpPTiBUQUJMRSBTRVQgU1R
     ZTEUgKgpJTkNMVURFPUlCRlM6L0ZJTEUvSUJJX0hUTUxfRElSL2phdmFhc3
     Npc3QvaW50bC9FTi9FTklBRGVmYXVsdF9jb21iaW5lLnN0eSwkClRZUEU9U
     kVQT1JULCBUSVRMRVRFWFQ9JldGX1RJVExFLlFVT1RFRFNUUklORywgU1VN
     TUFSWT0mV0ZfU1VNTUFSWS5RVU9URURTVFJJTkcsICQKRU5EU1RZTEUK
     RU5ECgotUlVOCg==
  </content>
</rootObject>

Response:

<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
<ibfsrpc _jt="IBFSResponseObject" language="EN" name="put" returncode="10000" returndesc="SUCCESS"
        subreturncode="0" subsystem="SSYS" type="simple">
   <ibfsparams size="5">
      <entry key="IBIRS_replace" value="true"/>
      <entry key="IBIRS_private" value="__null"/>
      <entry key="IBIRS_object" value="&lt;rootObject _jt=&quot;IBFSMRObject&quot;
                 description=&quot;Drilldown Report&quot; type=&quot;FexFile&quot;&gt;
                 &lt;content _jt=&quot;IBFSByteContent&quot;
char_set=&quot;Cp1252&quot;&gt;LSpEbyBub3QgZGVsZXRlIG9yIG1vZ
GlmeSB0aGUgY29tbWVudHMgYmVsb3cKLSogVXNlZCB0byBUZXN0IFJFU1QgT
W92ZSBmdW5jdGlvbmFsaXR5Cio
                      .
                      .
                      .
lFVT1RFRFNUUklORywgU1VNTUFSWT0mV0ZfU1VNTUFSWS5RVU9URURTVFJJTkcsIC
QKRU5EU1RZTEUKRU5ECgotUlVOCg==&lt;/content&gt;&lt;/rootObject&gt;"/>
      <entry key="IBIRS_args" value="__null"/>
      <entry key="IBIRS_" value="/WFC/Repository/Financial_Reports/Drilldown_Report.fex"/>
   </ibfsparams>
   <rootObject _jt="IBFSMRObject" binary="false" createdBy="admin" createdOn="1350352555666" defaultLng="en_US"
           description="Drilldown Report" dummy="false" extension="fex"
fullPath="IBFS:/WFC/Repository/Financial_Reports/Drilldown_Report.fex"
               handle="ebd5f9e9_8607_439d_ac77_3089efb6184a" inheritedPrivacy="true" lastModified="1350352555666"
               lastaccessBy="admin" lastaccessOn="1350352555666" lastmodBy="admin" length="5302"
               name="Drilldown_Report.fex" ownerId="10001" ownerName="admin" ownerType="U"
               policy="//3/D///9+f7////f7////////8AAAA=" returnedLng="en_US"
rsPath="/ibi_apps/rs/ibfs/WFC/Repository/Financial_Reports/Drilldown_Report.fex" type="FexFile">
      <content _jt="IBFSByteContent" char_set="Cp1252">LSpEbyBub3QgZGVsZXRlIG9yIG1vZGlmeSB0aGUg
Y29tbWVudHMgYmVsb3cKLSogVXNlZCB0byBUZXN0IFJFU1QgTW92ZSBmdW
5jdGlvbmFsaXR5CiotSU5URVJOQUxf
                           .
                           .
                           .
lORywgU1VNTUFSWT0mV0ZfU1VNTUFSWS5RVU9URURTVFJJTkcsICQKRU5E
U1RZTEUKRU5ECgotUlVOCg==
      </content>
      <nlsValues _jt="HashMap" loadFactor="0.75" threshold="12">
         <entry>
            <key _jt="string" value="en_US"/>
            <value _jt="ArrayList" size="2">
               <item _jt="string" index="0" value="Drilldown Report"/>
            </value>
         </entry>
      </nlsValues>
      <properties size="0"/>
   </rootObject>
</ibfsrpc>

Top of page

x
Creating a URL Link

This RESTful web service request can be used to create a URL link within the WebFOCUS environment.

HTTP Method: POST

REST URL Format:

http://host:port/ibi_apps/rs/ibfs/WFC/Repository/FolderName/UrlName

where:

host

Is the name of the system where WebFOCUS is installed.

port

Is the port number used by WebFOCUS.

FolderName

Is the name of the folder that will contain the URL link. If the folder is a subfolder, then the path to the subfolder must be included in the REST URL. For example, TopFolderName/SubFolderName.

UrlName

Is the name of the URL link to be created, which must include a .url extension.

Body Format:

IBIRS_action=put&IBIRS_object=Object

where:

Object

Is the XML object defining the URL link, which uses the following format:

<rootObject _jt="IBFSMRObject" description="UrlLinkTitle" type="URLFile"> <content _jt="IBFSByteContent" char_set="Cp1252">UrlBase64</content>
<properties size="1">
<entry key="tool" value="url"/>
</properties>
</rootObject>

where:

UrlLinkTitle

Is the title of the URL link.

UrlBase64

Is the base64 encoded text of the URL.

Example:

In the following example, a URL called Yahoo.url is created in the Car_Reports folder. The URL of http://www.yahoo.com is base64 encoded.

Request:

http://localhost:8080/ibi_apps/rs/ibfs/WFC/Repository/RESTful_Web_Services/Car_Reports/Yahoo.url

Body:

IBIRS_action=put&IBIRS_object=<rootObject _jt="IBFSMRObject" description="Yahoo" type="URLFile">
<content _jt="IBFSByteContent" char_set="Cp1252">aHR0cDovL3d3dy55YWhvby5jb20=</content>
<properties size="1">
<entry key="tool" value="url"/>
</properties>
</rootObject>

Response:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<ibfsrpc _jt="IBFSResponseObject" language="EN" name="put" returncode="10000" returndesc="SUCCESS" subreturncode="0" subsystem="SSYS" type="simple">
  <ibfsparams size="5">
    <entry key="IBIRS_replace" value="true"/>
    <entry key="IBIRS_private" value="__null"/>
    <entry key="IBIRS_object" value="****"/>
    <entry key="IBIRS_args" value="__null"/>
    <entry key="IBIRS_" value="/WFC/Repository/RESTful_Web_Services/Car_Reports/Yahoo.url"/>
  </ibfsparams>
  <rootObject _jt="IBFSMRObject" binary="false" createdBy="admin"
 createdOn="1356625917312" defaultLng="en_US"
       description="Yahoo" dummy="false" extension="url"      fullPath="IBFS:/WFC/Repository/RESTful_Web_Services/Car_Reports/Yahoo.url"
       handle="1711f8b4_abbc_41c3_9c4c_7fd3288d4c62" lastModified="1356625917312" lastaccessBy="admin"
       lastaccessOn="1356625917312" lastmodBy="admin" length="20" name="Yahoo.url"
       policy="////D///9+P/////v/////////+AAAA=" returnedLng="en_US"
rsPath="/ibi_apps/rs/ibfs/WFC/Repository/RESTful_Web_Services/Car_Reports/Yahoo.url" type="URLFile">
    <content _jt="IBFSByteContent" char_set="Cp1252">aHR0cDovL3d3dy55YWhvby5jb20=</content>
  		<nlsValues _jt="HashMap" loadFactor="0.75" threshold="12">
       <entry>
          <key _jt="string" value="en_US"/>
          <value _jt="ArrayList" size="2">
             <item _jt="string" index="0" value="Yahoo"/>
          </value>
       </entry>
    </nlsValues>
    <properties size="0"/>
	 </rootObject>
</ibfsrpc>

Top of page

x
Retrieving Content for a WebFOCUS Report and URL

This RESTful web service request can be used to retrieve the textual content within a WebFOCUS report or URL link.

HTTP Method: GET

REST URL Format:

http://host:port/ibi_apps/rs/ibfs/WFC/Repository/FolderName/ContentName?IBIRS_action=get

where:

host

Is the name of the system where WebFOCUS is installed.

port

Is the port number used by WebFOCUS.

FolderName

Is the name of the folder where the content exists. If the content exists in a subfolder, then the path to the subfolder name must be included in the REST URL. For example, ParentFolderName/FolderName.

ContentName

Is the name of the content, which must have a .fex extension for WebFOCUS reports and a .url extension for URL links.

Example 1:

In the following example, the content for the WebFOCUS report called Drilldown_Report.fex, from the Financial_Reports folder, is retrieved. The content is base64 encoded.

Request:

http://localhost:8080/ibi_apps/rs/ibfs/WFC/Repository/Financial_Reports/
Drilldown_Report.fex?IBIRS_action=get

Response:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<ibfsrpc _jt="IBFSResponseObject" language="EN" name="get" returncode="10000" returndesc="SUCCESS"
      subreturncode="0" subsystem="SSYS" type="simple">
   <ibfsparams size="2">
      <entry key="IBIRS_args" value="__null"/>
      <entry key="IBIRS_" value="/WFC/Repository/Financial_Reports/Drilldown_Report.fex"/>
   </ibfsparams>
   <rootObject _jt="IBFSMRObject" binary="false" createdBy="admin" createdOn="1350353513897" defaultLng="en_US"
          description="Drilldown Report" dummy="false" effectiveRSName="EDASERVE" extension="fex"
fullPath="IBFS:/WFC/Repository/Financial_Reports/Drilldown_Report.fex" handle="3a2f1c8a_3573_4047_ac46_5793f50d66cd"
          inheritedPrivacy="true" lastModified="1350353513897" lastaccessBy="admin" lastaccessOn="1356627630437"
          lastmodBy="admin" length="5302" name="Drilldown_Report.fex" ownerId="10001" ownerName="admin" ownerType="U"
          policy="//3/D///9+P9////v9////////+AAAA=" returnedLng="en_US"
rsPath="/ibi_apps/rs/ibfs/WFC/Repository/Financial_Reports/Drilldown_Report.fex" signedOn="true" type="FexFile">
      <content _jt="IBFSByteContent" char_set="Cp1252">LSpEbyBub3QgZGVsZXRlIG9yIG1vZGlmeSB0aGUgY29
tbWVudHMgYmVsb3cKLSogVXNlZCB0byBUZXN0IFJFU1QgTW92ZSBmdW5jdGlv
bmFsaXR5CiotSU5URVJOQUxf
              .
              .
              .
lORywgU1VNTUFSWT0mV0ZfU1VNTUFSWS5RVU9URURTVFJJTkcsIC
QKRU5EU1RZTEUKRU5ECgotUlVOCg==</content>
      <nlsValues _jt="HashMap" loadFactor="0.75" threshold="12">
         <entry>
            <key _jt="string" value="en_US"/>
            <value _jt="ArrayList" size="2">
               <item _jt="string" index="0" value="Drilldown Report"/>
            </value>
         </entry>
      </nlsValues>
      <properties size="0"/>
   </rootObject>
</ibfsrpc>

Example 2:

In the following example, the content for a URL called Yahoo.url, from the Car_Reports folder, is retrieved. The content is base64 encoded.

Request:

http://localhost:8080/ibi_apps/rs/ibfs/WFC/Repository/RESTful_Web_Services/
Car_Reports/Yahoo.url?IBIRS_action=get

Response:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<ibfsrpc _jt="IBFSResponseObject" language="EN" name="get" returncode="10000" returndesc="SUCCESS" subreturncode="0" subsystem="SSYS"
             type="simple">
   <ibfsparams size="2">
      <entry key="IBIRS_args" value="__null"/>
      <entry key="IBIRS_" value="/WFC/Repository/RESTful_Web_Services/Car_Reports/Yahoo.url"/>
   </ibfsparams>
   <rootObject _jt="IBFSMRObject" binary="false" createdBy="admin" createdOn="1356625917313" defaultLng="en_US" description="Yahoo"
           dummy="false" effectiveRSName="EDASERVE" extension="url"
fullPath="IBFS:/WFC/Repository/RESTful_Web_Services/Car_Reports/Yahoo.url" handle="1711f8b4_abbc_41c3_9c4c_7fd3288d4c62"
           lastModified="1356625917313" lastaccessBy="admin" lastaccessOn="1356627977093" lastmodBy="admin" length="20"
           name="Yahoo.url" ownerId="10001" ownerName="admin" ownerType="U" policy="//3/D///9+P/////v/////////+AAAA="
           returnedLng="en_US" rsPath="/ibi_apps/rs/ibfs/WFC/Repository/RESTful_Web_Services/Car_Reports/Yahoo.url" signedOn="true"
           type="URLFile">
      <content _jt="IBFSByteContent" char_set="Cp1252">aHR0cDovL3d3dy55YWhvby5jb20=</content>
      <nlsValues _jt="HashMap" loadFactor="0.75" threshold="12">
         <entry>
            <key _jt="string" value="en_US"/>
            <value _jt="ArrayList" size="2">
               <item _jt="string" index="0" value="Yahoo"/>
            </value>
         </entry>
      </nlsValues>
      <properties size="0"/>
   </rootObject>
</ibfsrpc>

WebFOCUS