Page Comparison

...

Expand

title	GETFAVOURITES

こちらのwebサービスの呼び出しは、指定したユーザーによりお気に入りに登録されたすべてのレポートを返します。

リクエストパラメーター

以下の要素は、こちらのリクエストとともに渡されます。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。
Password	String	上記アカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。
Function	String	Webサービス関数です。こちらは、「GETFAVOURITEGETFAVOURITES」に設定します。
Person	AdministrationPerson	ユーザーの詳細を含むオブジェクトです。以下の表を参照してください。

以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。

AdministrationPerson要素	データ型	説明
UserId	String	お気に入りに登録したレポートを取得するユーザーのIDです。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。

リクエストの例

以下は、こちらのリクエストのSOAP XMLの例です。

Code Block

language	xml

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:remoteAdministrationCall>
         <arg0>
            <loginId>admin@yellowfin.com.au</loginId>
            <password>test</password>
            <orgId>1</orgId>
            <function>GETFAVOURITES</function>
            <person>
                <userId>admin@yellowfin.com.au</userId>
            </person>  
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

応答パラメーター

返される応答には、これらのパラメーターが含まれます。

応答要素	データ型	説明
StatusCode	String	Webサービスの呼び出しのステータスです。値の選択肢は、以下の通りです。 SUCCESS FAILURE
Person	AdministrationPerson	ユーザーの完全な詳細です。
Reports	Administrationreports[]	ユーザーのお気に入りレポートの配列です。

応答の例

サービスは、今回のSOAPの例に基づき、以下の応答を返します。

Code Block

theme	Eclipse
language	xml

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
         <return>
            <errorCode>0</errorCode>
            <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
            <messages>Getting user information...</messages>
            <messages>Getting user information...</messages>
            <messages>Web Service Request Complete</messages>
            <person>
               <emailAddress>admin@yellowfin.com.au</emailAddress>
               <firstName>System</firstName>
               <initial/>
               <ipId>5</ipId>
               <languageCode>EN</languageCode>
               <lastName>Administrator</lastName>
               <roleCode>YFADMIN</roleCode>
               <salutationCode/>
               <status>ACTIVE</status>
               <timeZoneCode>AUSTRALIA/SYDNEY</timeZoneCode>
               <userId>admin@yellowfin.com.au</userId>
            </person>
            <reports>
               <authoringMode>JAVA</authoringMode>
               <averageRunTime>0</averageRunTime>
               <birtData/>
               <chartTypeCode/>
               <dashboardEnabled>true</dashboardEnabled>
               <dataOutput>COLUMN</dataOutput>
               <deliveryMode/>
               <executionObject/>
               <lastModifiedDate>2016-03-29T00:00:00+11:00</lastModifiedDate>
               <lastModifierId>5</lastModifierId>
               <lastModifierName>System Administrator</lastModifierName>
               <publishDate>2016-03-23T00:00:00+11:00</publishDate>
               <reportCategory>Audit Reports</reportCategory>
               <reportDescription/>
               <reportId>56401</reportId>
               <reportName>Active Sessions</reportName>
               <reportSubCategory>Admin Reports</reportSubCategory>
               <reportTemplate>REPORTANDCHART</reportTemplate>
               <reportUUID>594d4da4-1b58-44d3-bf4f-11456a42f68c</reportUUID>
               <roleCode>OPERATIONAL</roleCode>
               <sourceName/>
               <usage>24</usage>
               <viewDescription>Yellowfin Usage Audit</viewDescription>
               <viewId>56169</viewId>
               <viewName>NEW VIEW</viewName>
            </reports>
            <reports>
               <authoringMode>JAVA</authoringMode>
               <averageRunTime>0</averageRunTime>
               <birtData/>
               <chartTypeCode/>
               <dashboardEnabled>true</dashboardEnabled>
               <dataOutput>COLUMN</dataOutput>
               <deliveryMode/>
               <executionObject/>
               <lastModifiedDate>2016-03-29T00:00:00+11:00</lastModifiedDate>
               <lastModifierId>5</lastModifierId>
               <lastModifierName>System Administrator</lastModifierName>
               <publishDate>2016-03-23T00:00:00+11:00</publishDate>
               <reportCategory>Audit Reports</reportCategory>
               <reportDescription/>
               <reportId>56401</reportId>
               <reportName>Active Sessions</reportName>
               <reportSubCategory>Admin Reports</reportSubCategory>
               <reportTemplate>REPORTANDCHART</reportTemplate>
               <reportUUID>594d4da4-1b58-44d3-bf4f-11456a42f68c</reportUUID>
               <roleCode>OPERATIONAL</roleCode>
               <sourceName/>
               <usage>24</usage>
               <viewDescription>Yellowfin Usage Audit</viewDescription>
               <viewId>56169</viewId>
               <viewName>NEW VIEW</viewName>
            </reports>
            <sessionId>dffb6a0f4f155d46c73d1e77dffbd81c</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

手順

Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。

Expand

title	詳細手順

管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。

Code Block

theme	Eclipse
language	java

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
 
rsr.setFunction("GETFAVOURITES");

お気に入りレポートを取得するユーザーを指定します。

Code Block

theme	Eclipse
language	java

AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("test.user@yellowfin.com.au");
rsr.setPerson(ap);

リクエストを構成したら、呼び出しを実行します。
Code Block
language java
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
管理サービスを初期化します。実行方法の詳細は、こちらを参照してください。

返される応答には、StatusCode、Person、Reportsパラメーターが含まれます。より詳細な情報は、上記の応答パラメーターの表を参照してください。

完成例

以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。

コードをコピーして、「ws_getfavourites.jsp」として保存します。
root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
インターネットブラウザから、「http://<host>:<port>/ws_getinboxgetfavourites.jsp」を実行します。

Code Block

theme	Eclipse
language	java

<%          
/*              ws_getinboxgetfavourites.jsp                             */
%>
<%@ page language="java" contentType="text/html; charset=UTF-8" %>
<%@ page import="com.hof.util.*, java.util.*, java.text.*" %>
<%@ page import="com.hof.web.form.*" %>
<%@ page import="com.hof.mi.web.service.*" %>
<%
AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false);       // adjust host and port number
AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
  
rsr.setLoginId("admin@yellowfin.com.au");             // provide your Yellowfin web services admin account
rsr.setPassword("test");                            // set to the password of the account above account
rsr.setOrgId(1);
rsr.setFunction("GETINBOXGETFAVOURITES");
  
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("test.user@yellowfin.com.au");
  
rsr.setPerson(ap);
  
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
  
if ("SUCCESS".equals(rs.getStatusCode()) ) {
    out.write("<br>Success");
    AdministrationReport[] reports = rs.getReports();
    if (reports != null)
        for(AdministrationReport r: reports){
            out.write("<br>Report Name: " + r.getReportName());
        }
} else {
    out.write("Failure");
    out.write(" Code: " + rs.getErrorCode());
}
%>

Expand

title	ISREPORTFAVOURITE

こちらのwebサービスの呼び出しは、特定のレポートが指定したユーザーのお気に入りに登録されているかどうかを確認します。ユーザーとレポートの両方を指定しなくてはいけません。後者は、レポートIDを提供することで、指定します。このIDは、Yellowfinデータベースのレポートヘッダーテーブルから取得することができます。また、GETIDFORUUID webサービスの呼び出しをしようすることで、レポートIDを取得することもできます。

リクエストパラメーター

以下の要素は、こちらのリクエストとともに渡されます。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。
Password	String	上記アカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。
Function	String	Webサービス関数です。こちらは、「ISREPORTFAVOURITE」に設定します。
Person	AdministrationPerson	ユーザーの詳細を含むオブジェクトです。以下の表を参照してください。
ReportId	Integer	ユーザーのお気に入りに登録されているかを確認するレポートのレポートIDです。

以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。

AdministrationPerson要素	データ型	説明
UserId	String	お気に入りに登録したレポートを取得するユーザーのIDです。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。

リクエストの例

以下は、こちらのリクエストのSOAP XMLの例です。

Code Block

language	xml

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:remoteAdministrationCall>
         <arg0>
            <loginId>admin@yellowfin.com.au</loginId>
            <password>test</password>
            <orgId>1</orgId>
            <function>ISREPORTFAVOURITE</function>
            <reportId>56401</reportId>
            <person>
                <userId>admin@yellowfin.com.au</userId>
            </person>  
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

応答パラメーター

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

StatusCode

String

Webサービスの呼び出しのステータスです。値の選択肢は、以下の通りです。

SUCCESS：指定したレポートが、ユーザーのお気に入りに登録されている場合。
FAILURE：レポートが、ユーザーのお気に入りに登録されていない場合。

応答の例

サービスは、今回のSOAPの例に基づき、以下の応答を返します。

Code Block

theme	Eclipse
language	xml

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
         <return>
            <errorCode>0</errorCode>
            <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
            <messages>Web Service Request Complete</messages>
            <sessionId>ca75c7ebef710e4fc7c6ca6137baa784</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

手順

Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。

Expand

title	詳細手順

管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。

Code Block

theme	Eclipse
language	java

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
 
rsr.setFunction("ISREPORTFAVOURITE");

レポートのお気に入り登録状況を確認するユーザーを識別します。
Code Block
theme Eclipse
language java
AdministrationPerson ap = new AdministrationPerson(); ap.setUserId("test.user@yellowfin.com.au"); rsr.setPerson(ap);
お気に入り登録状況を確認するレポートを指定します。
Code Block
theme Eclipse
language java
rsr.setReportId(61131);
リクエストを構成したら、呼び出しを実行します。
Code Block
language java
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
管理サービスを初期化します。実行方法の詳細は、こちらを参照してください。

返される応答には、StatusCodeが含まれます。より詳細な情報は、上記の応答パラメーターの表を参照してください。

完成例

以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。

コードをコピーして、「ws_isreportfavourite.jsp」として保存します。
root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
インターネットブラウザから、「http://<host>:<port>/ws_isreportfavourite.jsp」を実行します。

Code Block

theme	Eclipse
language	java

<%          
/*              ws_isreportfavourite.jsp                        */
%>
<%@ page language="java" contentType="text/html; charset=UTF-8" %>
<%@ page import="com.hof.util.*, java.util.*, java.text.*" %>
<%@ page import="com.hof.web.form.*" %>
<%@ page import="com.hof.mi.web.service.*" %>
<%
AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false);       // adjust host and port number
AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
  
rsr.setLoginId("admin@yellowfin.com.au");         // provide your Yellowfin web services admin account
rsr.setPassword("test");                        // set to the password of the account above
rsr.setOrgId(1);
rsr.setFunction("ISREPORTFAVOURITE");
  
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("test.user@yellowfin.com.au");
  
rsr.setPerson(ap);
  
rsr.setReportId(61131);
  
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
  
if ("SUCCESS".equals(rs.getStatusCode()) ) {
                out.write("<br>Success");
                                     
} else {
                out.write("Failure");
                out.write(" Code: " + rs.getErrorCode());
}
%>

Expand

title	ADDTOFAVOURITES

こちらのwebサービスの呼び出しは、特定のレポートを指定したユーザーのお気に入りに登録します。ユーザーとレポートの両方を指定しなくてはいけません。後者は、レポートIDを提供することで指定することができます。レポートIDを取得するために、GETIDFORUUIS webサービスの呼び出しをしようするか、データベース（値は、レポートヘッダーテーブルに保存されています）からこれを取得します。

リクエストパラメーター

以下の要素は、こちらのリクエストとともに渡されます。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。
Password	String	上記アカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。
Function	String	Webサービス関数です。こちらは、「ADDTOFAVOURITES」に設定します。
Person	AdministrationPerson	ユーザーの詳細を含むオブジェクトです。以下の表を参照してください。
ReportId	Integer	ユーザーのお気に入りとして登録するレポートのレポートIDです。

以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。

AdministrationPerson要素	データ型	説明
UserId	String	レポートをお気に入りに登録するユーザーのIDです。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。

リクエストの例

以下は、こちらのリクエストのSOAP XMLの例です。

Code Block

language	xml

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:remoteAdministrationCall>
         <arg0>
            <loginId>admin@yellowfin.com.au</loginId>
            <password>test</password>
            <orgId>1</orgId>
            <function>ADDTOFAVOURITES</function>
            <reportId>56401</reportId>
            <person>
                <userId>admin@yellowfin.com.au</userId>
            </person>  
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

応答パラメーター

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

StatusCode

String

Webサービスの呼び出しのステータスです。値の選択肢は、以下の通りです。

SUCCESS：レポートが、ユーザーのお気に入りに登録される場合。
FAILURE：レポートが、ユーザーのお気に入りに登録されない場合。

応答の例

サービスは、今回のSOAPの例に基づき、以下の応答を返します。

Code Block

theme	Eclipse
language	xml

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
         <return>
            <errorCode>0</errorCode>
            <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
            <messages>Web Service Request Complete</messages>
            <sessionId>cf897244c65ceecd6c4c39e8ab8c4fcb</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

手順

Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。

Expand

title	詳細手順

管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。

Code Block

theme	Eclipse
language	java

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
 
rsr.setFunction("ADDTOFAVOURITES");

レポートのお気に入り登録状況を確認するユーザーを識別します。
Code Block
theme Eclipse
language java
AdministrationPerson ap = new AdministrationPerson(); ap.setUserId("test.user@yellowfin.com.au"); rsr.setPerson(ap);
お気に入り登録状況を確認するレポートを指定します。
Code Block
theme Eclipse
language java
rsr.setReportId(61131);
リクエストを構成したら、呼び出しを実行します。
Code Block
language java
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
管理サービスを初期化します。実行方法の詳細は、こちらを参照してください。

返される応答には、StatusCodeが含まれます。より詳細な情報は、上記の応答パラメーターの表を参照してください。

完成例

以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。

コードをコピーして、「ws_addtofavourites.jsp」として保存します。
root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
インターネットブラウザから、「http://<host>:<port>/ws_addtofavourites.jsp」を実行します。

Code Block

theme	Eclipse
language	java

/*              ws_addtofavourites.jsp                  */
%>
<%@ page language="java" contentType="text/html; charset=UTF-8" %>
<%@ page import="com.hof.util.*, java.util.*, java.text.*" %>
<%@ page import="com.hof.web.form.*" %>
<%@ page import="com.hof.mi.web.service.*" %>
<%
AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false);       // adjust host and port number
AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
  
rsr.setLoginId("admin@yellowfin.com.au");         // provide your Yellowfin webservices admin account
rsr.setPassword("test");                                                      // change to be the password of the account above
rsr.setOrgId(1);
rsr.setFunction("ADDTOFAVORITES");
  
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("test.user@yellowfin.com.au");
  
rsr.setPerson(ap);
  
rsr.setReportId(56361);
  
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
  
if ("SUCCESS".equals(rs.getStatusCode()) ) {
    out.write("<br>Success");
                                     
} else {
    out.write("Failure");
    out.write(" Code: " + rs.getErrorCode());
}
%>

Expand

title	REMOVEFAVOURITE

こちらのwebサービスの呼び出しは、特定のレポートを指定したユーザーのお気に入り登録から削除します。ユーザーとレポートの両方を指定しなくてはいけません。後者は、レポートIDを提供することで指定することができます。レポートIDを取得するために、GETIDFORUUIS webサービスの呼び出しをしようするか、データベース（値は、レポートヘッダーテーブルに保存されています）からこれを取得します。

リクエストパラメーター

以下の要素は、こちらのリクエストとともに渡されます。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。
Password	String	上記アカウントのパスワードです。
OrgId	Integer	Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。
Function	String	Webサービス関数です。こちらは、「REMOVEFAVOURITE」、または「REMOVEFAVORITE」に設定します。
Person	AdministrationPerson	ユーザーの詳細を含むオブジェクトです。以下の表を参照してください。
ReportId	Integer	ユーザーのお気に入り登録から削除するレポートのレポートIDです。

以下は、こちらのwebサービスの呼び出しのAdministrationPersonオブジェクトに設定しなくてはいけない主要なパラメーターです。

AdministrationPerson要素	データ型	説明
UserId	String	レポートをお気に入り登録から削除するユーザーのIDです。これは、ログイン方法に応じて、ユーザーID、または電子メールアドレスになります。

リクエストの例

以下は、こちらのリクエストのSOAP XMLの例です。

Code Block

language	xml

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:remoteAdministrationCall>
         <arg0>
            <loginId>admin@yellowfin.com.au</loginId>
            <password>test</password>
            <orgId>1</orgId>
            <function>REMOVEFAVOURITE</function>
            <reportId>56401</reportId>
            <person>
                <userId>admin@yellowfin.com.au</userId>
            </person>  
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

応答パラメーター

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

StatusCode

String

Webサービスの呼び出しのステータスです。値の選択肢は、以下の通りです。

SUCCESS：レポートが、ユーザーのお気に入り登録から削除される場合。
FAILURE：レポートが、ユーザーのお気に入り登録から削除されない場合。

応答の例

サービスは、今回のSOAPの例に基づき、以下の応答を返します。

Code Block

theme	Eclipse
language	xml

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
         <return>
            <errorCode>0</errorCode>
            <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
            <messages>Web Service Request Complete</messages>
            <sessionId>1be6b980918323dab6f41fec3c040c56</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

手順

Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。

Expand

title	詳細手順

管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。

Code Block

theme	Eclipse
language	java

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
 
rsr.setFunction("REMOVEFAVOURITE");

レポートのお気に入り登録状況を確認するユーザーを識別します。
Code Block
theme Eclipse
language java
AdministrationPerson ap = new AdministrationPerson(); ap.setUserId("test.user@yellowfin.com.au"); rsr.setPerson(ap);
お気に入り登録状況を確認するレポートを指定します。
Code Block
theme Eclipse
language java
rsr.setReportId(61131);
リクエストを構成したら、呼び出しを実行します。
Code Block
language java
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
管理サービスを初期化します。実行方法の詳細は、こちらを参照してください。

返される応答には、StatusCodeが含まれます。より詳細な情報は、上記の応答パラメーターの表を参照してください。

完成例

以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。

コードをコピーして、「ws_removefavourite.jsp」として保存します。
root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
インターネットブラウザから、「http://<host>:<port>/ws_removefavourite.jsp」を実行します。

Code Block

theme	Eclipse
language	java

/*              ws_removefavourite.jsp                              */
%>
<%@ page language="java" contentType="text/html; charset=UTF-8" %>
<%@ page import="com.hof.util.*, java.util.*, java.text.*" %>
<%@ page import="com.hof.web.form.*" %>
<%@ page import="com.hof.mi.web.service.*" %>
<%
AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false);        // adjust host and port number
AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
  
rsr.setLoginId("admin@yellowfin.com.au");             // provide your Yellowfin web services admin account
rsr.setPassword("test");                            // set to the password of the account above
rsr.setOrgId(1);
rsr.setFunction("REMOVEFAVOURITE");
  
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("test.user@yellowfin.com.au");
  
rsr.setPerson(ap);
  
rsr.setReportId(56361);
  
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
  
if ("SUCCESS".equals(rs.getStatusCode()) ) {
                out.write("<br>Success");
                                     
} else {
                out.write("Failure");
                out.write(" Code: " + rs.getErrorCode());
}
%>

...

Version	Old Version 2	New Version 3
Changes made by	Yellowfin Admin	Yellowfin Admin
Saved on	Mar 28, 2018	Mar 28, 2018

Versions Compared

Key

リクエストパラメーター

リクエストの例

応答パラメーター

応答の例

手順

完成例

リクエストパラメーター

リクエストの例

応答パラメーター

応答の例

手順

完成例

リクエストパラメーター

リクエストの例

応答パラメーター

応答の例

手順

完成例

リクエストパラメーター

リクエストの例

応答パラメーター

応答の例

手順

完成例