こちらのwebサービスの呼び出しは、特定のユーザーのお気に入り一覧から、レポート、ストーリーボード、ビューなどの項目やオブジェクトを削除します。また、ユーザーのダッシュボードからダッシュボードタブを削除し、ユーザーによりフラグ付けされたコメントのフラグを外すこともできます。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスの管理者ユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスになります。 このYellowfinアカウントは、「Yellowfin Webサービス使用権」が有効化されたロールを持ち、デフォルト（プライマリー）組織に所属していなくてはいけません。 | Password | String | 上記アカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト（プライマリー）組織IDです。常に、「1」に設定します。 | Function | String | Webサービス関数です。こちらは、「REMOVEPERSONFAVOURITE」に設定します。 | | Favourite | PersonFavourite | こちらのオブジェクトは、ユーザーのお気に入り登録から削除する項目を指定するために使用します。こちらでユーザーも指定します。より詳細な情報は、以下の表を参照してください。 |
以下は、こちらのwebサービスの呼び出しのPersonFavouriteオブジェクトに設定しなくてはいけない主要なパラメーターです。| PersonFavourite要素 | データ型 | 説明 | | PersonId | Integer | 内部ID（IP ID）とともにユーザーを識別するために必須のパラメーターです。選択された項目は、ユーザーのお気に入りから削除されます。ID）とともにユーザーを識別するために必須のパラメーターです。この値は、YellowfinのデータベースのPerson.IpIdフィールドに対応するか、AdministrationPerson.getIpId()を使用して取得しなくてはいけません。選択された項目は、ユーザーのお気に入りから削除されます。 | | ContentType | String | こちらの必須パラメーターは、お気に入りから削除する項目のコンテンツタイプを指定するために使用します。値の選択肢は、以下の通りです。 - REPORT
- REPORTGROUP
- DISCUSSIONGROUP
- REPORTVIEW
- STORYBOARD
- IMAGE
| | ContentId | Integer | こちらの必須パラメーターは、内部IDを提供することで、ユーザーのお気に入りに登録された項目を定義するために使用します。 | | FavouriteType | String | こちらは、ユーザーのお気に入りからレポートやダッシュボードを削除するために必要です。 | | CreationCode | String | | | TextEntityId | Integer | こちらのパラメーターは、コメントのフラグ付けを外すために必要です。 |
リクエストの例以下は、こちらのリクエストのSOAP XMLの例です。 | Code Block |
|---|
| <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>REMOVEPERSONFAVOURITE</function>
<favourite>
<personId>13000</personId>
<contentType>REPORTGROUP</contentType>
<contentId>61209</contentId>
</favourite>
</arg0>
</web:remoteAdministrationCall>
</soapenv:Body>
</soapenv:Envelope> |
応答パラメーター返される応答には、これらのパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
応答の例サービスは、今回のSOAPの例に基づき、以下の応答を返します。 | Code Block |
|---|
| <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>0cc3673ed857e1e28fb0e326b8f3b24e</sessionId>
<statusCode>SUCCESS</statusCode>
</return>
</ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope> |
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。 | Expand |
|---|
| 管理ユーザーとしてのログインと、実行するwebサービスの呼び出しの指定を含む、こちらの関数の基礎的なリクエストから開始します。
| Code Block |
|---|
| AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
rsr.setFunction("REMOVEPERSONFAVOURITE"); |
PersonFavouriteオブジェクトを使用して、ユーザーを識別します。 | Code Block |
|---|
| PersonFavourite pf = new PersonFavourite();
pf.setPersonId(13073); |
こちらのオブジェクト内でお気に入りから削除されるオブジェクトを指定します。 | Code Block |
|---|
| pf.setContentId(61252);
pf.setContentType("REPORTVIEW"); |
|
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。 - コードをコピーして、「ws_removepersonfavourite.jsp」として保存します。
- root（Yellowfin/appserver/webapps/ROOT）フォルダーにファイルを配置します。
- 環境に応じて、ホスト、ポート番号、管理ユーザーの詳細を調整します。
- インターネットブラウザから、「http://<host>:<port>/ws_removepersonfavourite.jsp」を実行します。
| Code Block |
|---|
| <%
/* ws_removepersonfavourite.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("REMOVEPERSONFAVOURITE");
PersonFavourite pf = new PersonFavourite();
pf.setPersonId(13073);
pf.setContentId(70270);
pf.setContentType("REPORTVIEW");
rsr.setFavourite(pf);
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("<br>Success");
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
}
%> |
|