Zenn
🌟

WebFOCUSのRESTful API仕様

2025/03/20に公開
rest
restful
webfocus
ibfs
tech

はじめに

WebFOCUSのRESTful APIの仕様書がないため、作成しました。

検証しながら対象範囲を増やしていきます。

WebFOCUSが超苦手なAI駆動開発でこういう資料を読ませることが重要です。

対象範囲

  • ibfsサービス
    • IBIRS_action=signOn
    • IBIRS_action=signOff
    • IBIRS_action=get
    • IBIRS_action=list
    • IBIRS_action=getContent
    • IBIRS_action=describeFex
    • IBIRS_action=run

基本情報

  • URL: /ibi_apps/rs
  • Service Name: ibfs

共通パラメータ

すべてのibfsサービスのリクエストに必要なパラメータです。

  • IBIRS_service: "ibfs"
  • IBIRS_random: 乱数（キャッシュ防止）
  • CSRFトークン名: CSRFトークン値（IBIRS_actionによっては不要）

XMLレスポンスについて

XMLのレスポンスはすべて<ibfsrpc>オブジェクトとして返されます。

ibfsrpcオブジェクト

子要素としてリクエストに応じた様々なレスポンスを返します。

  • name: IBIRS_actionの種類
  • returncode: リターンコード（成功時："10000"、他は失敗）
  • returndesc: メッセージ（成功時："SUCCESS"、失敗時は失敗した理由）

アプリケーションでは、returncodeが"10000"なら成功とし、失敗時はreturndescを表示します。

成功例：

<ibfsrpc _jt="IBFSResponseObject" language="EN" name="signOn" returncode="10000" returndesc="SUCCESS" subreturncode="0" type="simple">
    <!-- 中略 -->
</ibfsrpc>

失敗例:

<ibfsrpc _jt="IBFSResponseObject" language="EN" localizeddesc="Incorrect username or password" name="signOn" returncode="5003" returndesc="Incorrect username or password" subreturncode="0" type="simple">
    <ibfsparams size="0"/>
</ibfsrpc>

ibfsサービスのIBIRS_action

signOn

WebFOCUSにサインオンするためのリクエストです。

  • メソッド: GET
  • レスポンス形式: XML
  • CSRFトークン: 不要

リクエストパラメータ

  • IBIRS_action: "signOn"
  • IBIRS_userName: ユーザID
  • IBIRS_password: パスワード

レスポンス

CSRFトークン取得方法

  • トークン名: ibfsrpc > properties > entry[key="IBI_CSRF_Token_Name"]のvalue属性
  • トークン値: ibfsrpc > properties > entry[key="IBI_CSRF_Token_Value"]のvalue属性

ログインユーザ情報

ibfsrpc > rootObject の属性値からユーザ情報を取得します。

  • description: ユーザ表示名
  • email: メールアドレス
  • fullPath: ユーザのフルパス（パスワード変更等で利用）
  • name: ユーザ名（サインオンに利用したユーザ名と同じ）

レスポンスサンプル

<ibfsrpc _jt="IBFSResponseObject" language="EN" name="signOn" returncode="10000" returndesc="SUCCESS" subreturncode="0" type="simple">
    <ibfsparams size="0"/>
    <properties size="2">
        <entry key="IBI_CSRF_Token_Name" value="IBIwfXsrfToken"/>
        <entry key="IBI_CSRF_Token_Value" value="73c9d38e3fb2353306b79311b473ac04"/>
    </properties>
    <rootObject _jt="IBFSUserObject" description="" dummy="false" email="" fullPath="IBFS:/SSYS/USERS/admin" handle="10001" isFavorite="false" lastSignin="1742381273995" length="0" name="admin" password="" type="User" userStatusDisplay="アクティブ">
        <properties size="3">
            <entry key="AuthNType" value="IntAuthN"/>
            <entry key="SeatDate" value="20250106"/>
            <entry key="SeatType" value="PU,IA"/>
        </properties>
        <status _jt="IBSSUserStatus" name="ACTIVE"/>
        <groups _jt="ArrayList" size="0"/>
        <pSetList _jt="ArrayList" size="0"/>
    </rootObject>
</ibfsrpc>

サインオン済みユーザのサインオン

シングルサインオン等でユーザが既にサインオンしている場合、IBIRS_passwordパラメータなしでサインオンすることによりトークン等の情報を取得できます。

signOff

WebFOCUSからサインオフするためのリクエストです。

  • メソッド: GET
  • レスポンス形式: XML
  • CSRFトークン: 不要

リクエストパラメータ

  • IBIRS_action: "signOff"

レスポンス

レスポンスサンプル

<ibfsrpc _jt="IBFSResponseObject" language="EN" name="signOff" returncode="10000" returndesc="SUCCESS" subreturncode="0" type="simple">
    <ibfsparams size="0"/>
    <rootObject _jt="string" value="OK"/>
</ibfsrpc>

get

特定のパスにあるアイテムを取得するリクエストです。
孫のノードまで取得したい場合は、listを使用します。

  • メソッド: GET
  • レスポンス形式: XML
  • CSRFトークン: 不要

リクエストパラメータ

  • IBIRS_action: "get"
  • IBIRS_path: WebFOCUSノードのfullpath
  • IBIRS_args: 取得対象となるXMLオブジェクト（オプション）

レスポンス

対象となるパスの情報

ibfsrpc > rootObjectの属性値として対象となるパスのitemに該当する情報を取得します。

対象となるパスの子要素

ibfsrpc > rootObject > childlen > itemの属性値として子要素の情報を取得します。

  • description: 表示名
  • fullPath: 子要素のフルパス
  • name: 子要素の名前
  • policy: この要素に対する権限（utilsサービスのIBIRS_action=expandPolicyを使ってXML化する）
  • rsPath: 子要素のrsパス
  • thumbPath: 表示画像
  • type: 子要素の種別
  • typeDescription: 子要素の種別（表示名）

レスポンスサンプル

IBIRS_path=IBFS:/WFC/Repository/My_Workspace

レスポンス全文
<ibfsrpc _jt="IBFSResponseObject" language="ja_JP" name="get" returncode="10000" returndesc="SUCCESS" subreturncode="0" type="simple">
    <ibfsparams size="2">
        <entry key="IBIRS_args" value="__null"/>
        <entry key="IBIRS_path" value="IBFS:/WFC/Repository/My_Workspace"/>
    </ibfsparams>
    <rootObject _jt="IBFSMRObject" appName="myhome getting_started" binary="false" container="true" createdBy="admin" createdOn="1736154048395" defaultLng="en_US" description="マイワークスペース" dummy="false" effectiveAppName="myhome getting_started" effectiveRSName="EDASERVE" fullPath="IBFS:/WFC/Repository/My_Workspace" handle="76660ba4_0be6_4d7e_a55d_51e344f87456__679100163" isFavorite="false" lastModified="1736154048395" lastaccessBy="admin" lastaccessOn="1736154048395" lastmodBy="admin" length="0" name="My_Workspace" policy="//P+v3/Dn///8Oj/////9v//////////gAAAAA==" rawDescription="${My_Workspace}" returnedLng="en_US" rsPath="/ibi_apps/rs/ibfs/WFC/Repository/My_Workspace" srtorder="-1000" thumbPath="/ibi_apps/ibi_html/ibi_images/file_type/file.svg" type="MRFolder" typeDescription="フォルダ">
        <children _jt="ArrayList" size="2">
            <item _jt="IBFSMRObject" binary="false" container="true" createdBy="admin" createdOn="1736184831696" defaultLng="ja_JP" description="マイコンテンツ" dummy="false" effectiveAppName="myhome getting_started" effectiveRSName="EDASERVE" fullPath="IBFS:/WFC/Repository/My_Workspace/~admin" handle="059acbe4_fb9f_427e_b2ba_ec2955c59e8a__1227285789" inMyContent="true" index="0" isFavorite="false" lastModified="1736184831696" lastaccessBy="admin" lastaccessOn="1736995039956" lastmodBy="admin" length="0" name="~admin" ownerId="10001" ownerName="admin" ownerPath="IBFS:/SSYS/USERS/admin" ownerType="U" parent="My_Workspace" policy="//P2v3/D////8+jfv///9v9/33/f////gAAAAA==" rawDescription="${My_Content}" returnedLng="ja_JP" rsPath="/ibi_apps/rs/ibfs/WFC/Repository/My_Workspace/~admin" srtorder="-300" thumbPath="/ibi_apps/ibi_html/ibi_images/file_type/file.svg" type="MyReportFolder" typeDescription="フォルダ (マイコンテンツ)">
                <properties size="0"/>
            </item>
            <item _jt="IBFSVirtualFolder" container="true" description="共有コンテンツ" displayName="SHARES" dummy="false" fullPath="IBFS:/WFC/Repository/My_Workspace/##SHARE" index="1" isFavorite="false" length="0" name="Shared_Content" parent="My_Workspace" policy="9/H2uX9BA+X78EBPp///9v9//3///9//gAAAAA==" rsPath="/ibi_apps/rs/ibfs/WFC/Repository/My_Workspace/##SHARE" srtorder="-200" thumbPath="/ibi_apps/ibi_html/ibi_images/file_type/file.svg" type="MemoryVirtualFolder" typeDescription="フォルダ (仮想)" vfType="Shared"/>
        </children>
        <properties size="4">
            <entry key="Cascade" value="/SSYS/GROUPS/My_Workspace"/>
            <entry key="GeneralAccessGroup" value="/SSYS/GROUPS/My_Workspace/BasicUsers"/>
            <entry key="MyDomain" value="on"/>
            <entry key="autogenmyreports" value="on"/>
        </properties>
        <nlsValues _jt="HashMap">
            <entry>
                <key _jt="string" value="en_US"/>
                <value _jt="ArrayList" size="2">
                    <item _jt="string" index="0" value="${My_Workspace}"/>
                </value>
            </entry>
        </nlsValues>
    </rootObject>
</ibfsrpc>

list

特定のパスの子孫要素を取得するリクエストです。

  • メソッド: GET
  • レスポンス形式: XML
  • CSRFトークン: 不要

リクエストパラメータ

  • IBIRS_action: "list"
  • IBIRS_path: WebFOCUSノードのfullpath
  • IBIRS_options: 絞り込み条件（オプション）

レスポンス

対象となるパスの情報

ibfsrpc > rootObjectの属性値として対象となるパスのitemに該当する情報を取得します。

対象となるパスの子要素

itemの属性値として子要素の情報を取得します。
itemの位置はflattenの指定により異なります。

  • description: 表示名
  • fullPath: 子要素のフルパス
  • name: 子要素の名前
  • policy: この要素に対する権限（utilsサービスのIBIRS_action=expandPolicyを使ってXML化する）
  • rsPath: 子要素のrsパス
  • thumbPath: 表示画像
  • type: 子要素の種別
  • typeDescription: 子要素の種別（表示名）

レスポンスサンプル

IBIRS_path=IBFS:/SSYS/USERS
recursionDepth=2

<ibfsrpc _jt="IBFSResponseObject" language="ja_JP" name="list" returncode="10000" returndesc="SUCCESS" subreturncode="0" type="simple">
    <ibfsparams size="2">
        <entry key="IBIRS_options" value="recursionDepth=2"/>
        <entry key="IBIRS_path" value="IBFS:/SSYS/USERS"/>
    </ibfsparams>
    <rootObject _jt="ArrayList" size="3">
        <item _jt="IBFSUserObject" actions="manageRulesOn,viewRulesOn,resourceRules,rulesForResource" description="" dummy="false" email="" fullPath="IBFS:/SSYS/USERS/admin" handle="10001" index="0" isFavorite="false" lastSignin="1742515449577" length="0" menuActionBitMap="AAAAAAYAAgAAAAAAAAAAAAAAAAAAAAAAAAIAAAA=" name="admin" parent="USERS" policy="//P+v3/D////8+j/////9v////z/////gAAAAA==" rsPath="/ibi_apps/rs/ibfs/SSYS/USERS/admin" thumbPath="/ibi_apps/ibi_html/ibi_images/file_type/file.svg" type="User" typeDescription="ユーザ" userStatusDisplay="アクティブ">
            <properties size="3">
                <entry key="AuthNType" value="IntAuthN"/>
                <entry key="SeatDate" value="20250106"/>
                <entry key="SeatType" value="PU,IA"/>
            </properties>
            <status _jt="IBSSUserStatus" name="ACTIVE"/>
            <groups _jt="ArrayList" size="0"/>
            <pSetList _jt="ArrayList" size="0"/>
        </item>
        <item _jt="IBFSUserObject" actions="manageRulesOn,viewRulesOn,resourceRules,rulesForResource" description="Desktop Guest Account" dummy="false" email="" fullPath="IBFS:/SSYS/USERS/wfdesktop" handle="10008" index="1" isFavorite="false" length="0" menuActionBitMap="AAAAAAYAAgAAAAAAAAAAAAAAAAAAAAAAAAIAAAA=" name="wfdesktop" parent="USERS" policy="//P+v3/D////8+j/////9v//////////gAAAAA==" rawDescription="${Desktop_guest_account}" rsPath="/ibi_apps/rs/ibfs/SSYS/USERS/wfdesktop" thumbPath="/ibi_apps/ibi_html/ibi_images/file_type/file.svg" type="User" typeDescription="ユーザ" userStatusDisplay="アクティブ">
            <status _jt="IBSSUserStatus" name="ACTIVE"/>
            <groups _jt="ArrayList" size="0"/>
            <pSetList _jt="ArrayList" size="0"/>
        </item>
        <item _jt="IBFSUserObject" actions="manageRulesOn,viewRulesOn,resourceRules,rulesForResource" description="Public User" dummy="false" email="" fullPath="IBFS:/SSYS/USERS/public" handle="10007" index="2" isFavorite="false" length="0" menuActionBitMap="AAAAAAYAAgAAAAAAAAAAAAAAAAAAAAAAAAIAAAA=" name="public" parent="USERS" policy="//P+v3/D////8+j/////9v//////////gAAAAA==" rawDescription="${Public_user}" rsPath="/ibi_apps/rs/ibfs/SSYS/USERS/public" thumbPath="/ibi_apps/ibi_html/ibi_images/file_type/file.svg" type="User" typeDescription="ユーザ" userStatusDisplay="アクティブ">
            <status _jt="IBSSUserStatus" name="ACTIVE"/>
            <groups _jt="ArrayList" size="0"/>
            <pSetList _jt="ArrayList" size="0"/>
        </item>
    </rootObject>
</ibfsrpc>

getContent

指定したアイテムのコンテンツを取得します。

  • メソッド: GET
  • レスポンス形式: Plane/Text
  • CSRFトークン: 不要

リクエストパラメータ

  • IBIRS_action: "getContent"
  • IBIRS_path: WebFOCUSノードのfullpath

レスポンス

得られるテキスト

テキストを含むプロシジャやシノニム定義、URLからテキストを取得できます。
フォルダ等のコンテンツを含まないアイテムを指定するとエラーになります。

  • type="FexFile": WebFOCUSプロシージャのプログラム
  • type="URLFile": リンク先のURL

レスポンスサンプル

FexFile

SET PAGE = OFF
SET CSSURL = x

-* Report1
TABLE FILE CAR
 PRINT 
   MODEL 
   SEAT 
   SALES
 BY COUNTRY
 BY CAR
END

UrlFile

https://www.google.co.jp/

describeFex

  • メソッド: GET
  • レスポンス形式: XML
  • CSRFトークン: 不要

WebFOCUSレポートのパラメータを取得します。
この機能を利用して、カスタム変数入力画面を作成することが出来ます。
この機能は、埋め込みアプリケーションを開発する上で重要な情報を得ることが出来ます。

  • 見栄えの良い変数入力画面を作成可能
  • カスタムバリデーションが利用可能
  • 特定の変数名が使われる場合に、準備したリスト選択を適用可能
  • 特定の変数名が使われる場合に、システムから取得した値を自動設定
  • 特定の変数名が使われる場合に、データベースから取得したリストを表示

リクエストパラメータ

  • IBIRS_action: "describeFex"
  • IBIRS_path: WebFOCUSノードのfullpath

レスポンス

以下のプロシジャを対象に"describeFex"を実行

fullpathで指定したプロシージャ
-SET SetNoUse = 'Set No Use Value';

-SET SetUse = 'Set Use Valuet';

-DEFAULTS DefNoUse = 'Def No Use Value'  , DefUse = 'De fUse Value'

-DEFAULTH DefhNoUse = 'Defh No Use Value', DefhUse = 'Defh Use Value';

-* SETコマンドで値を指定した変数
-TYPE SetUse = &SetUse
-* DEFAULT(S)コマンドで値を指定した変数
-TYPE DefUse = &DefUse
-* DEFAULTH(S)コマンドで値を指定した変数
-TYPE DefhUse = &DefhUse

-* 宣言していない変数
-TYPE Undefined1 = &Undefined1
-TYPE Undefined2 = &Undefined2.A8.
-TYPE Undefined3 = &Undefined3.I4.Input number.
-TYPE Undefined4 = &Undefined4.(ABC,DEF,GHI).

変数情報

  • ibfsrpc > rootObject > bindingInfo: プロシジャ内で利用不可な変数オブジェクト
  • ibfsrpc > rootObject > amperMap: プロシジャ内で利用可能な変数オブジェクト

レスポンスサンプル

非常に長いですが、全文載せています。

レスポンス全文
<ibfsrpc _jt="IBFSResponseObject" language="ja_JP" name="describeFex" returncode="10000" returndesc="SUCCESS" subreturncode="0" type="simple">
    <ibfsparams size="2">
        <entry key="IBIRS_args" value="__null"/>
        <entry key="IBIRS_path" value="IBFS:/WFC/Repository/My_Workspace/~admin/paramTest.fex"/>
    </ibfsparams>
    <rootObject class="com.ibi.wfrs.IBFSWFDescribe" formAction="/ibi_apps/rs" isSavedParam="false" nrOfDefaultVars="2" nrOfPromptVars="6">
        <describeLevel class="com.ibi.wfrs.WFDescribeFlag" name="XMLRUN"/>
        <bindingInfo _jt="HashMap">
            <entry>
                <key _jt="string" value="IBIF_describe_null"/>
                <value class="com.ibi.wfrs.IBFSWFDescribe$BindingVar" isReqParm="false" value="_FOC_NULL"/>
            </entry>
            <entry>
                <key _jt="string" value="IBIC_server"/>
                <value class="com.ibi.wfrs.IBFSWFDescribe$BindingVar" isReqParm="false" value="EDASERVE"/>
            </entry>
            <entry>
                <key _jt="string" value="IBFS_description"/>
                <value class="com.ibi.wfrs.IBFSWFDescribe$BindingVar" isReqParm="false" value="パラメータテスト"/>
            </entry>
            <entry>
                <key _jt="string" value="IBIRS_path"/>
                <value class="com.ibi.wfrs.IBFSWFDescribe$BindingVar" isReqParm="true" value="IBFS:/WFC/Repository/My_Workspace/~admin/paramTest.fex"/>
            </entry>
            <entry>
                <key _jt="string" value="FOCEXURL"/>
                <value class="com.ibi.wfrs.IBFSWFDescribe$BindingVar" isReqParm="false" value="/ibi_apps/rs?IBIF_webapp=/ibi_apps&IBIC_server=EDASERVEmyhome getting_started=myhome getting_started&"/>
            </entry>
            <entry>
                <key _jt="string" value="IBIAPP_app"/>
                <value class="com.ibi.wfrs.IBFSWFDescribe$BindingVar" isReqParm="false" value="myhome getting_started"/>
            </entry>
            <entry>
                <key _jt="string" value="IBI_PostMsgsToParent"/>
                <value class="com.ibi.wfrs.IBFSWFDescribe$BindingVar" isReqParm="true" value="ON"/>
            </entry>
            <entry>
                <key _jt="string" value="IBIRS_random"/>
                <value class="com.ibi.wfrs.IBFSWFDescribe$BindingVar" isReqParm="true" value="95015"/>
            </entry>
            <entry>
                <key _jt="string" value="IBFS_name"/>
                <value class="com.ibi.wfrs.IBFSWFDescribe$BindingVar" isReqParm="false" value="paramTest.fex"/>
            </entry>
            <entry>
                <key _jt="string" value="SAVE_PARMS_PATH"/>
                <value class="com.ibi.wfrs.IBFSWFDescribe$BindingVar" isReqParm="false" value="IBFS:/WFC/Repository/My_Workspace/~admin"/>
            </entry>
            <entry>
                <key _jt="string" value="IBI_CSRF_Token_Name"/>
                <value class="com.ibi.wfrs.IBFSWFDescribe$BindingVar" isReqParm="false" value="IBIwfXsrfToken"/>
            </entry>
            <entry>
                <key _jt="string" value="SAVE_FEX_NAME"/>
                <value class="com.ibi.wfrs.IBFSWFDescribe$BindingVar" isReqParm="false" value="paramTest.fex"/>
            </entry>
            <entry>
                <key _jt="string" value="SCRIPT_NAME"/>
                <value class="com.ibi.wfrs.IBFSWFDescribe$BindingVar" isReqParm="false" value="/ibi_apps/rs"/>
            </entry>
            <entry>
                <key _jt="string" value="IBIRS_args"/>
                <value class="com.ibi.wfrs.IBFSWFDescribe$BindingVar" isReqParm="true" value="__null"/>
            </entry>
            <entry>
                <key _jt="string" value="SAVE_PARMS"/>
                <value class="com.ibi.wfrs.IBFSWFDescribe$BindingVar" isReqParm="false" value="TRUE"/>
            </entry>
            <entry>
                <key _jt="string" value="XSL_NEWLINE_DELIM"/>
                <value class="com.ibi.wfrs.IBFSWFDescribe$BindingVar" isReqParm="false" value="0xD;0xA;"/>
            </entry>
            <entry>
                <key _jt="string" value="IBI_Webapp_Context_Default"/>
                <value class="com.ibi.wfrs.IBFSWFDescribe$BindingVar" isReqParm="false" value="/ibi_apps"/>
            </entry>
            <entry>
                <key _jt="string" value="IBIRS_service"/>
                <value class="com.ibi.wfrs.IBFSWFDescribe$BindingVar" isReqParm="true" value="ibfs"/>
            </entry>
            <entry>
                <key _jt="string" value="FOCHTMLURL"/>
                <value class="com.ibi.wfrs.IBFSWFDescribe$BindingVar" isReqParm="false" value="/ibi_apps/ibi_html/S3_17207238601F"/>
            </entry>
            <entry>
                <key _jt="string" value="SUBSYSTEM"/>
                <value class="com.ibi.wfrs.IBFSWFDescribe$BindingVar" isReqParm="false" value="Self Service"/>
            </entry>
            <entry>
                <key _jt="string" value="fromTool"/>
                <value class="com.ibi.wfrs.IBFSWFDescribe$BindingVar" isReqParm="true" value="true"/>
            </entry>
            <entry>
                <key _jt="string" value="SAVE_PARMRPT"/>
                <value class="com.ibi.wfrs.IBFSWFDescribe$BindingVar" isReqParm="false" value="IBFS:/WFC/Repository/My_Workspace/~admin/paramTest.fex"/>
            </entry>
            <entry>
                <key _jt="string" value="IBFS_displayName"/>
                <value class="com.ibi.wfrs.IBFSWFDescribe$BindingVar" isReqParm="false" value="パラメータテスト"/>
            </entry>
            <entry>
                <key _jt="string" value="IBIRS_action"/>
                <value class="com.ibi.wfrs.IBFSWFDescribe$BindingVar" isReqParm="true" value="describeFex"/>
            </entry>
            <entry>
                <key _jt="string" value="IBIwfXsrfToken"/>
                <value class="com.ibi.wfrs.IBFSWFDescribe$BindingVar" isReqParm="true" value="ce67011b43570e5f48610a649d8240b5"/>
            </entry>
        </bindingInfo>
        <amperMap class="java.util.LinkedHashMap">
            <entry>
                <key _jt="string" value="FOCFOCEXEC"/>
                <value aggType="" amperIdx="0" chainIdx="-1" class="com.ibi.wfrs.IBFSWFDescribe$AmperVar" format="" idxInChain="-1" inForm="false" isDefault="false" max="0.0" min="0.0" name="FOCFOCEXEC" noSelection="false" parent="" proc="" sortFields="" sortOrder="" validate="">
                    <type class="com.ibi.wfrs.IBFSAmperVarType" name="system"/>
                    <userDefValues _jt="array" itemsClass="string" size="0"/>
                    <defValues _jt="array" itemsClass="string" size="0"/>
                    <displayType class="com.ibi.wfrs.IBFSAmperDisplayType" name="prompt"/>
                    <values class="java.util.LinkedHashMap"/>
                    <parameters _jt="HashMap"/>
                </value>
            </entry>
            <entry>
                <key _jt="string" value="_PERSISTENT_GEO_UNIFIED_ROLE"/>
                <value aggType="" amperIdx="1" chainIdx="-1" class="com.ibi.wfrs.IBFSWFDescribe$AmperVar" format="" idxInChain="-1" inForm="false" isDefault="false" max="0.0" min="0.0" name="_PERSISTENT_GEO_UNIFIED_ROLE" noSelection="false" parent="" proc="" sortFields="" sortOrder="" validate="">
                    <type class="com.ibi.wfrs.IBFSAmperVarType" name="global"/>
                    <userDefValues _jt="array" itemsClass="string" size="0"/>
                    <defValues _jt="array" itemsClass="string" size="0"/>
                    <displayType class="com.ibi.wfrs.IBFSAmperDisplayType" name="prompt"/>
                    <values class="java.util.LinkedHashMap"/>
                    <parameters _jt="HashMap"/>
                </value>
            </entry>
            <entry>
                <key _jt="string" value="_PERSISTENT_IBI_HOLDMAG_TARGET"/>
                <value aggType="" amperIdx="2" chainIdx="-1" class="com.ibi.wfrs.IBFSWFDescribe$AmperVar" format="" idxInChain="-1" inForm="false" isDefault="false" max="0.0" min="0.0" name="_PERSISTENT_IBI_HOLDMAG_TARGET" noSelection="false" parent="" proc="" sortFields="" sortOrder="" validate="">
                    <type class="com.ibi.wfrs.IBFSAmperVarType" name="global"/>
                    <userDefValues _jt="array" itemsClass="string" size="0"/>
                    <defValues _jt="array" itemsClass="string" size="0"/>
                    <displayType class="com.ibi.wfrs.IBFSAmperDisplayType" name="prompt"/>
                    <values class="java.util.LinkedHashMap"/>
                    <parameters _jt="HashMap"/>
                </value>
            </entry>
            <entry>
                <key _jt="string" value="FOCEXURL"/>
                <value aggType="" amperIdx="3" chainIdx="-1" class="com.ibi.wfrs.IBFSWFDescribe$AmperVar" format="" idxInChain="-1" inForm="false" isDefault="false" max="0.0" min="0.0" name="FOCEXURL" noSelection="false" parent="" proc="" sortFields="" sortOrder="" validate="">
                    <type class="com.ibi.wfrs.IBFSAmperVarType" name="set"/>
                    <userDefValues _jt="array" itemsClass="string" size="0"/>
                    <defValues _jt="array" itemsClass="string" size="0"/>
                    <displayType class="com.ibi.wfrs.IBFSAmperDisplayType" name="prompt"/>
                    <values class="java.util.LinkedHashMap"/>
                    <parameters _jt="HashMap"/>
                </value>
            </entry>
            <entry>
                <key _jt="string" value="FOCHTMLURL"/>
                <value aggType="" amperIdx="4" chainIdx="-1" class="com.ibi.wfrs.IBFSWFDescribe$AmperVar" format="" idxInChain="-1" inForm="false" isDefault="false" max="0.0" min="0.0" name="FOCHTMLURL" noSelection="false" parent="" proc="" sortFields="" sortOrder="" validate="">
                    <type class="com.ibi.wfrs.IBFSAmperVarType" name="set"/>
                    <userDefValues _jt="array" itemsClass="string" size="0"/>
                    <defValues _jt="array" itemsClass="string" size="0"/>
                    <displayType class="com.ibi.wfrs.IBFSAmperDisplayType" name="prompt"/>
                    <values class="java.util.LinkedHashMap"/>
                    <parameters _jt="HashMap"/>
                </value>
            </entry>
            <entry>
                <key _jt="string" value="GOOGLEMAPSAPIKEY"/>
                <value aggType="" amperIdx="5" chainIdx="-1" class="com.ibi.wfrs.IBFSWFDescribe$AmperVar" format="" idxInChain="-1" inForm="false" isDefault="false" max="0.0" min="0.0" name="GOOGLEMAPSAPIKEY" noSelection="false" parent="" proc="" sortFields="" sortOrder="" validate="">
                    <type class="com.ibi.wfrs.IBFSAmperVarType" name="set"/>
                    <userDefValues _jt="array" itemsClass="string" size="0"/>
                    <defValues _jt="array" itemsClass="string" size="0"/>
                    <displayType class="com.ibi.wfrs.IBFSAmperDisplayType" name="prompt"/>
                    <values class="java.util.LinkedHashMap"/>
                    <parameters _jt="HashMap"/>
                </value>
            </entry>
            <entry>
                <key _jt="string" value="WF_TITLE"/>
                <value aggType="" amperIdx="6" chainIdx="-1" class="com.ibi.wfrs.IBFSWFDescribe$AmperVar" format="" idxInChain="-1" inForm="false" isDefault="false" max="0.0" min="0.0" name="WF_TITLE" noSelection="false" parent="" proc="" sortFields="" sortOrder="" validate="">
                    <type class="com.ibi.wfrs.IBFSAmperVarType" name="set"/>
                    <userDefValues _jt="array" itemsClass="string" size="0"/>
                    <defValues _jt="array" itemsClass="string" size="0"/>
                    <displayType class="com.ibi.wfrs.IBFSAmperDisplayType" name="prompt"/>
                    <values class="java.util.LinkedHashMap"/>
                    <parameters _jt="HashMap"/>
                </value>
            </entry>
            <entry>
                <key _jt="string" value="WF_SUMMARY"/>
                <value aggType="" amperIdx="7" chainIdx="-1" class="com.ibi.wfrs.IBFSWFDescribe$AmperVar" format="" idxInChain="-1" inForm="false" isDefault="false" max="0.0" min="0.0" name="WF_SUMMARY" noSelection="false" parent="" proc="" sortFields="" sortOrder="" validate="">
                    <type class="com.ibi.wfrs.IBFSAmperVarType" name="set"/>
                    <userDefValues _jt="array" itemsClass="string" size="0"/>
                    <defValues _jt="array" itemsClass="string" size="0"/>
                    <displayType class="com.ibi.wfrs.IBFSAmperDisplayType" name="prompt"/>
                    <values class="java.util.LinkedHashMap"/>
                    <parameters _jt="HashMap"/>
                </value>
            </entry>
            <entry>
                <key _jt="string" value="IBFS_FILENAME"/>
                <value aggType="" amperIdx="8" chainIdx="-1" class="com.ibi.wfrs.IBFSWFDescribe$AmperVar" format="" idxInChain="-1" inForm="false" isDefault="false" max="0.0" min="0.0" name="IBFS_FILENAME" noSelection="false" parent="" proc="" sortFields="" sortOrder="" validate="">
                    <type class="com.ibi.wfrs.IBFSAmperVarType" name="set"/>
                    <userDefValues _jt="array" itemsClass="string" size="0"/>
                    <defValues _jt="array" itemsClass="string" size="0"/>
                    <displayType class="com.ibi.wfrs.IBFSAmperDisplayType" name="prompt"/>
                    <values class="java.util.LinkedHashMap"/>
                    <parameters _jt="HashMap"/>
                </value>
            </entry>
            <entry>
                <key _jt="string" value="IBFS_OlapFilePath"/>
                <value aggType="" amperIdx="9" chainIdx="-1" class="com.ibi.wfrs.IBFSWFDescribe$AmperVar" format="" idxInChain="-1" inForm="false" isDefault="false" max="0.0" min="0.0" name="IBFS_OlapFilePath" noSelection="false" parent="" proc="" sortFields="" sortOrder="" validate="">
                    <type class="com.ibi.wfrs.IBFSAmperVarType" name="set"/>
                    <userDefValues _jt="array" itemsClass="string" size="0"/>
                    <defValues _jt="array" itemsClass="string" size="0"/>
                    <displayType class="com.ibi.wfrs.IBFSAmperDisplayType" name="prompt"/>
                    <values class="java.util.LinkedHashMap"/>
                    <parameters _jt="HashMap"/>
                </value>
            </entry>
            <entry>
                <key _jt="string" value="MR_FULL_FEXNAME"/>
                <value aggType="" amperIdx="10" chainIdx="-1" class="com.ibi.wfrs.IBFSWFDescribe$AmperVar" format="" idxInChain="-1" inForm="false" isDefault="false" max="0.0" min="0.0" name="MR_FULL_FEXNAME" noSelection="false" parent="" proc="" sortFields="" sortOrder="" validate="">
                    <type class="com.ibi.wfrs.IBFSAmperVarType" name="set"/>
                    <userDefValues _jt="array" itemsClass="string" size="0"/>
                    <defValues _jt="array" itemsClass="string" size="0"/>
                    <displayType class="com.ibi.wfrs.IBFSAmperDisplayType" name="prompt"/>
                    <values class="java.util.LinkedHashMap"/>
                    <parameters _jt="HashMap"/>
                </value>
            </entry>
            <entry>
                <key _jt="string" value="MR_FULL_PATH"/>
                <value aggType="" amperIdx="11" chainIdx="-1" class="com.ibi.wfrs.IBFSWFDescribe$AmperVar" format="" idxInChain="-1" inForm="false" isDefault="false" max="0.0" min="0.0" name="MR_FULL_PATH" noSelection="false" parent="" proc="" sortFields="" sortOrder="" validate="">
                    <type class="com.ibi.wfrs.IBFSAmperVarType" name="set"/>
                    <userDefValues _jt="array" itemsClass="string" size="0"/>
                    <defValues _jt="array" itemsClass="string" size="0"/>
                    <displayType class="com.ibi.wfrs.IBFSAmperDisplayType" name="prompt"/>
                    <values class="java.util.LinkedHashMap"/>
                    <parameters _jt="HashMap"/>
                </value>
            </entry>
            <entry>
                <key _jt="string" value="FOCREL"/>
                <value aggType="" amperIdx="12" chainIdx="-1" class="com.ibi.wfrs.IBFSWFDescribe$AmperVar" format="" idxInChain="-1" inForm="false" isDefault="false" max="0.0" min="0.0" name="FOCREL" noSelection="false" parent="" proc="" sortFields="" sortOrder="" validate="">
                    <type class="com.ibi.wfrs.IBFSAmperVarType" name="system"/>
                    <userDefValues _jt="array" itemsClass="string" size="0"/>
                    <defValues _jt="array" itemsClass="string" size="0"/>
                    <displayType class="com.ibi.wfrs.IBFSAmperDisplayType" name="prompt"/>
                    <values class="java.util.LinkedHashMap"/>
                    <parameters _jt="HashMap"/>
                </value>
            </entry>
            <entry>
                <key _jt="string" value="EXCELSERVURL"/>
                <value aggType="" amperIdx="13" chainIdx="-1" class="com.ibi.wfrs.IBFSWFDescribe$AmperVar" format="" idxInChain="-1" inForm="false" isDefault="false" max="0.0" min="0.0" name="EXCELSERVURL" noSelection="false" parent="" proc="" sortFields="" sortOrder="" validate="">
                    <type class="com.ibi.wfrs.IBFSAmperVarType" name="set"/>
                    <userDefValues _jt="array" itemsClass="string" size="0"/>
                    <defValues _jt="array" itemsClass="string" size="0"/>
                    <displayType class="com.ibi.wfrs.IBFSAmperDisplayType" name="prompt"/>
                    <values class="java.util.LinkedHashMap"/>
                    <parameters _jt="HashMap"/>
                </value>
            </entry>
            <entry>
                <key _jt="string" value="SetNoUse"/>
                <value aggType="" amperIdx="14" chainIdx="-1" class="com.ibi.wfrs.IBFSWFDescribe$AmperVar" format="" idxInChain="-1" inForm="false" isDefault="false" max="0.0" min="0.0" name="SetNoUse" noSelection="false" parent="" proc="" sortFields="" sortOrder="" validate="">
                    <type class="com.ibi.wfrs.IBFSAmperVarType" name="set"/>
                    <userDefValues _jt="array" itemsClass="string" size="0"/>
                    <defValues _jt="array" itemsClass="string" size="0"/>
                    <displayType class="com.ibi.wfrs.IBFSAmperDisplayType" name="prompt"/>
                    <values class="java.util.LinkedHashMap"/>
                    <parameters _jt="HashMap"/>
                </value>
            </entry>
            <entry>
                <key _jt="string" value="SetUse"/>
                <value aggType="" amperIdx="15" chainIdx="-1" class="com.ibi.wfrs.IBFSWFDescribe$AmperVar" format="" idxInChain="-1" inForm="false" isDefault="false" max="0.0" min="0.0" name="SetUse" noSelection="false" parent="" proc="" sortFields="" sortOrder="" validate="">
                    <type class="com.ibi.wfrs.IBFSAmperVarType" name="set"/>
                    <userDefValues _jt="array" itemsClass="string" size="0"/>
                    <defValues _jt="array" itemsClass="string" size="0"/>
                    <displayType class="com.ibi.wfrs.IBFSAmperDisplayType" name="prompt"/>
                    <values class="java.util.LinkedHashMap"/>
                    <parameters _jt="HashMap"/>
                </value>
            </entry>
            <entry>
                <key _jt="string" value="DefNoUse"/>
                <value aggType="" amperIdx="16" chainIdx="-1" class="com.ibi.wfrs.IBFSWFDescribe$AmperVar" format="" idxInChain="-1" inForm="true" isDefault="true" max="0.0" min="0.0" name="DefNoUse" noSelection="false" parent="" proc="" sortFields="" sortOrder="" strDef="Def No Use Value" validate="">
                    <type class="com.ibi.wfrs.IBFSAmperVarType" name="defaultType"/>
                    <userDefValues _jt="array" itemsClass="string" size="1">
                        <item _jt="string" index="0" value="Def No Use Value"/>
                    </userDefValues>
                    <defValues _jt="array" itemsClass="string" size="1">
                        <item _jt="string" index="0" value="Def No Use Value"/>
                    </defValues>
                    <displayType class="com.ibi.wfrs.IBFSAmperDisplayType" name="prompt"/>
                    <values class="java.util.LinkedHashMap"/>
                    <parameters _jt="HashMap"/>
                </value>
            </entry>
            <entry>
                <key _jt="string" value="DefUse"/>
                <value aggType="" amperIdx="17" chainIdx="-1" class="com.ibi.wfrs.IBFSWFDescribe$AmperVar" format="" idxInChain="-1" inForm="true" isDefault="true" max="0.0" min="0.0" name="DefUse" noSelection="false" parent="" proc="" sortFields="" sortOrder="" strDef="De fUse Value" validate="">
                    <type class="com.ibi.wfrs.IBFSAmperVarType" name="defaultType"/>
                    <userDefValues _jt="array" itemsClass="string" size="1">
                        <item _jt="string" index="0" value="De fUse Value"/>
                    </userDefValues>
                    <defValues _jt="array" itemsClass="string" size="1">
                        <item _jt="string" index="0" value="De fUse Value"/>
                    </defValues>
                    <displayType class="com.ibi.wfrs.IBFSAmperDisplayType" name="prompt"/>
                    <values class="java.util.LinkedHashMap"/>
                    <parameters _jt="HashMap"/>
                </value>
            </entry>
            <entry>
                <key _jt="string" value="Undefined1"/>
                <value aggType="" amperIdx="18" chainIdx="-1" class="com.ibi.wfrs.IBFSWFDescribe$AmperVar" format="" idxInChain="-1" inForm="true" isDefault="false" max="0.0" min="0.0" name="Undefined1" noSelection="false" parent="" proc="" sortFields="" sortOrder="" validate="">
                    <type class="com.ibi.wfrs.IBFSAmperVarType" name="unresolved"/>
                    <userDefValues _jt="array" itemsClass="string" size="0"/>
                    <defValues _jt="array" itemsClass="string" size="0"/>
                    <displayType class="com.ibi.wfrs.IBFSAmperDisplayType" name="prompt"/>
                    <values class="java.util.LinkedHashMap"/>
                    <parameters _jt="HashMap"/>
                </value>
            </entry>
            <entry>
                <key _jt="string" value="Undefined2"/>
                <value aggType="" amperIdx="19" chainIdx="-1" class="com.ibi.wfrs.IBFSWFDescribe$AmperVar" format="A8" idxInChain="-1" inForm="true" isDefault="false" max="0.0" min="0.0" name="Undefined2" noSelection="false" parent="" proc="" sortFields="" sortOrder="" validate="">
                    <type class="com.ibi.wfrs.IBFSAmperVarType" name="unresolved"/>
                    <userDefValues _jt="array" itemsClass="string" size="0"/>
                    <defValues _jt="array" itemsClass="string" size="0"/>
                    <displayType class="com.ibi.wfrs.IBFSAmperDisplayType" name="prompt"/>
                    <values class="java.util.LinkedHashMap"/>
                    <parameters _jt="HashMap"/>
                </value>
            </entry>
            <entry>
                <key _jt="string" value="Undefined3"/>
                <value aggType="" amperIdx="20" chainIdx="-1" class="com.ibi.wfrs.IBFSWFDescribe$AmperVar" description="Input number" format="I4" idxInChain="-1" inForm="true" isDefault="false" max="0.0" min="0.0" name="Undefined3" noSelection="false" parent="" proc="" sortFields="" sortOrder="" validate="">
                    <type class="com.ibi.wfrs.IBFSAmperVarType" name="unresolved"/>
                    <userDefValues _jt="array" itemsClass="string" size="0"/>
                    <defValues _jt="array" itemsClass="string" size="0"/>
                    <displayType class="com.ibi.wfrs.IBFSAmperDisplayType" name="prompt"/>
                    <values class="java.util.LinkedHashMap"/>
                    <parameters _jt="HashMap"/>
                </value>
            </entry>
            <entry>
                <key _jt="string" value="Undefined4"/>
                <value aggType="" amperIdx="21" chainIdx="-1" class="com.ibi.wfrs.IBFSWFDescribe$AmperVar" format="" idxInChain="-1" inForm="true" isDefault="false" max="0.0" min="0.0" name="Undefined4" noSelection="false" operation="" parent="" proc="" sortFields="" sortOrder="" validate="">
                    <type class="com.ibi.wfrs.IBFSAmperVarType" name="unresolved"/>
                    <userDefValues _jt="array" itemsClass="string" size="0"/>
                    <defValues _jt="array" itemsClass="string" size="0"/>
                    <displayType class="com.ibi.wfrs.IBFSAmperDisplayType" name="staticType"/>
                    <values class="java.util.LinkedHashMap">
                        <entry>
                            <key _jt="string" value="ABC"/>
                            <value _jt="string" value="ABC"/>
                        </entry>
                        <entry>
                            <key _jt="string" value="DEF"/>
                            <value _jt="string" value="DEF"/>
                        </entry>
                        <entry>
                            <key _jt="string" value="GHI"/>
                            <value _jt="string" value="GHI"/>
                        </entry>
                    </values>
                    <parameters _jt="HashMap"/>
                </value>
            </entry>
        </amperMap>
        <tableChainList _jt="ArrayList" size="0"/>
        <globalRefreshPaths _jt="HashMap"/>
    </rootObject>
</ibfsrpc>

run

  • メソッド: GET
  • レスポンス形式: 出力結果HTML
  • CSRFトークン: 不要

WebFOCUSレポートを実行します。
RESTful APIのパラメータに加え、レポート実行用のパラメータ（COUNTRY=JAPAN等)もパラメータになります。

リクエストパラメータ

  • IBIRS_action: "run"
  • IBIRS_path: レポートのフルパス(拡張子.fex)
  • レポート用パラメータ: レポート内で利用する変数

レスポンス

レポートの出力結果HTMLが返されます。
fetch等でレスポンスを取得する場合は、取得したHTMLを別ウィンドウやフレーム内に描画して利用します。
DIVタグ等に展開する場合は、出力結果の様式に注意してください

Discussion