Versions Compared

Version Old Version 10 New Version 11
Changes made by

Yellowfin Admin

Yellowfin Admin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Anchor
top
top

...

Webサービス呼び出しを使用して、グループとロールを作成および変更することができます。応答で返されるオブジェクトは、リクエストで実行される呼び出しのタイプに依存します。

注意：クライアント組織機能を「システム設定」ページでオンにしている場合、特定のタイプの呼び出しについて適用可能な場合はクライアント組織を指定することもできます。

...

Expand
titleCREATEGROUP

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinに指定されたグループを作成します。

Code Block
AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationGroup group = new AdministrationGroup();

group.setGroupName("Group Name");
group.setGroupDescription("Group Description");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if you wish to create the group in a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("CREATEGROUP");
rsr.setGroup(group);

rs = AdministrationService.remoteAdministrationCall(rsr);

このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

注意：AdministrationPersonオブジェクトのAdministrationGroupMember配列に入力することによって、新規作成されたグループに既存のYellowfinユーザーを同時に配置することもできます。各AdministrationPersonオブジェクトに必要なのはLoginId変数セットのみであり、AdministrationGroupMember配列はgroup.setGroupMembers()に保存されます。

この関数はYellowfinグループを作成します。この関数では、新規グループに既存のYellowfinユーザーを保存できる点にも注意してください。

リクエスト要素

データ型

説明

LoginId

String

Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。

Password

String

Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。

OrgId

Integer

Yellowfin内のデフォルト組織ID。常に1に設定します。

Function = “CREATEGROUP”

String

Webサービス関数。

OrgRef

String

この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。

Group

AdministrationGroup

取得プロセスに関するYellowfinユーザーグループの名前を保持するAdministrationGroupオブジェクト。

AdministrationGroupオブジェクトで設定が必要なパラメーターは、以下の通りです。

AdministrationGroup要素

データ型

説明

GroupName

String

指定したYellowfinグループの名前

GroupDescription

String

指定したYellowfinグループの説明

GroupMembers

Array（AdministrationPerson）

AdministrationPersonオブジェクトの配列。これはオプションのパラメーターで、既存のYellowfinユーザーをこのグループに保存するよう設定することができます。このシナリオの場合、AdministrationPersonオブジェクトに必要なのは、オブジェクトごとにそのUserIdパラメーターを設定することだけです。

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

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータス。可能な値は以下の通りです。

  • SUCCESS
  • FAILURE

...

Expand
titleEXCLUDEUSERINGROUP

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたグループから指定されたユーザーを除外します。

注意：このユーザーはグループから削除されるのではなく、グループ定義から除外されるだけです。これが役立つのは、たとえば以下のような場合です。

  • John DoeはグループAのメンバーである
  • グループAはグループBのメンバーである
  • John DoeはグループBのメンバーであってはならないため、グループBから除外する必要がある
Code Block
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationGroup group = new AdministrationGroup();
AdministrationPerson person = new AdministrationPerson();

group.setGroupName("Group Name");
person.setUserId("test@yellowfin.com.au");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if you wish to get the group in a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("EXCLUDEUSERINGROUP");
rsr.setGroup(group);
rsr.setPerson(person);

rs = AdministrationService.remoteAdministrationCall(rsr);

このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

この関数は、指定されたグループから指定されたYellowfinユーザーを除外します。このユーザーはグループから削除されるのではなく、グループ定義から除外されるだけである点に注意してください。これが役立つのは、たとえば以下のような場合です。

  • John DoeはグループAのメンバーである
  • グループAはグループBのメンバーである
  • John DoeはグループBのメンバーであってはならないため、グループBから除外する必要がある

リクエスト要素

データ型

説明

LoginId

String

Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。

Password

String

Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。

OrgId

Integer

Yellowfin内のデフォルト組織ID。常に1に設定します。

Function = “EXCLUDEUSERINGROUP”

String

Webサービス関数。

OrgRef

String

この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。

Group

AdministrationGroup

取得プロセスに関するYellowfinユーザーグループの名前を保持するAdministrationGroupオブジェクト。

Person

AdministrationPerson

取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。

AdministrationGroupおよびAdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。

AdministrationGroup要素

データ型

説明

GroupName

String

指定したYellowfinグループの名前

AdministrationPerson要素

データ型

説明

UserId

String

YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。

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

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータス。可能な値は以下の通りです。

  • SUCCESS
  • FAILURE

...

Expand
titleMODIFYGROUP

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたグループを変更します。

Code Block
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationGroup group = new AdministrationGroup();

group.setGroupName("Group Name");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if you wish to get the group in a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("MODIFYGROUP");
rsr.setGroup(group);

rs = AdministrationService.remoteAdministrationCall(rsr);

このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

注意：AdministrationPersonオブジェクトのAdministrationGroupMember配列を投入することによって、変更されたグループに既存のYellowfinユーザーを同時に配置することもできます。各AdministrationPersonオブジェクトに必要なのはLoginId変数セットのみであり、AdministrationGroupMember配列はgroup.setGroupMembers()に保存されます。

この関数はYellowfinの指定されたグループの詳細を変更します。この関数では、新規グループに既存のYellowfinユーザーを保存できる点にも注意してください。

リクエスト要素

データ型

説明

LoginId

String

Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。

Password

String

Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。

OrgId

Integer

Yellowfin内のデフォルト組織ID。常に1に設定します。

Function = “MODIFYGROUP”

String

Webサービス関数。

OrgRef

String

この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。

Group

AdministrationGroup

取得プロセスに関するYellowfinユーザーグループの名前を保持するAdministrationGroupオブジェクト。

AdministrationGroupオブジェクトで設定が必要なパラメーターは、以下の通りです。

AdministrationGroup要素

データ型

説明

GroupName

String

指定したYellowfinグループの名前

GroupDescription

String

指定したYellowfinグループの説明

GroupMembers

Array（AdministrationPerson）

AdministrationPersonオブジェクトの配列。これはオプションのパラメーターで、既存のYellowfinユーザーをこのグループに保存するよう設定することができます。このシナリオの場合、AdministrationPersonオブジェクトに必要なのは、オブジェクトごとにそのLoginIdパラメーターを設定することだけです。

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

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータス。可能な値は以下の通りです。

  • SUCCESS
  • FAILURE

...

Expand
titleGETUSERACCESS

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたユーザーがアクセス可能なすべてのクライアント組織を一覧表示します。

Code Block
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg[] clients = null;
AdministrationPerson person = new AdministrationPerson();

person.setUserId("test@yellowfin.com.au");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("GETUSERACCESS");
rsr.setPerson(person);

rs = AdministrationService.remoteAdministrationCall(rsr);
clients = rs.getClients();

このコードは、rs.getClients()でAdministrationClientOrgオブジェクトの配列を返し、rs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

リクエスト要素

データ型

説明

LoginId

String

Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。

Password

String

Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。

OrgId

Integer

Yellowfin内のデフォルト組織ID。常に1に設定します。

Function = “GETUSERACCESS”

String

Webサービス関数。

Person

AdministrationPerson

取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。

AdministrationClientOrgオブジェクトで設定が必要なパラメーターは、以下の通りです。

AdministrationPerson要素

データ型

説明

UserId

String

YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。

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

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータス。可能な値は以下の通りです。

  • SUCCESS
  • FAILURE

Clients

Array（AdministrationClientOrg）

AdministrationClientOrgオブジェクトの配列。各オブジェクトにはYellowfinクライアント組織のメタデータが保持されます。

Description

でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

この関数は、Yellowfinの指定されたユーザーに対して指定されたクライアント組織へのアクセス権を追加します。

Expand
titleADDUSERACCESS

The following code will call the Yellowfin web service and add access to a specified client organisation for a specified user within Yellowfin:以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたユーザーに対して指定されたクライアント組織へのアクセス権を追加します。

Code Block
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg aco = new AdministrationClientOrg();
AdministrationPerson person = new AdministrationPerson();

person.setUserId("test@yellowfin.com.au");
aco.setClientReferenceId("CLIENTREFERENCEIDHERE"); 

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("ADDUSERACCESS");
rsr.setPerson(person);
rs.setClient(aco);

rs = AdministrationService.remoteAdministrationCall(rsr);

The code will return SUCCESS in このコードはrs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will add access to a specified client organisation for a specified user win Yellowfin.

Request Element

Data Type

リクエスト要素

データ型

説明

LoginId

String

Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.auYellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。

Password

String

Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。

OrgId

Integer

Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。

Function = “ADDUSERACCESS”

String

Webサービス関数。

Web services function

OrgRef

String

Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional.この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。

Person

AdministrationPersonThe AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process

取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。

Client

AdministrationClientOrg

The AdministrationClientOrg object holding the Yellowfin client organisation’s Client Reference ID for the retrieval process

These are the parameters that you need to set in the AdministrationPerson and AdministrationClientOrg objects:

Description

AdministrationPerson Element

Data Type

取得プロセスに関するYellowfinクライアント組織のクライアント参照IDを保持するAdministrationClientOrgオブジェクト。

AdministrationPersonおよびAdministrationClientOrgオブジェクトで設定が必要なパラメーターは、以下の通りです。

Description

AdministrationPerson要素

データ型

説明

UserId

String

User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method

AdministrationClientOrg Element

Data Type

YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。

AdministrationClientOrg要素

データ型

説明

ClientReferenceId

Integer

Client Reference ID for the specified client organisation

The response returned will contain these parameters:

Description

Response Element

Data Type

指定されたクライアント組織のクライアント参照ID

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

応答要素

データ型

説明

StatusCode

String

Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。

  • SUCCESS
  • FAILURE
Description
Expand
titleREMOVEUSERACCESS

The following code will call the Yellowfin web service and remove access to a specified client organisation for a specified user within Yellowfin:以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたユーザーに対して指定されたクライアント組織へのアクセス権を削除します。

Code Block
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg aco = new AdministrationClientOrg();
AdministrationPerson person = new AdministrationPerson();

person.setUserId("test@yellowfin.com.au");
aco.setClientReferenceId("CLIENTREFERENCEIDHERE"); 

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("REMOVEUSERACCESS");
rsr.setPerson(person);
rs.setClient(aco);

rs = AdministrationService.remoteAdministrationCall(rsr);

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will remove access to a specified client organisation for a specified user in Yellowfin.

Request Element

Data Type

このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
この関数は、Yellowfinの指定されたユーザーに対して指定されたクライアント組織へのアクセス権を削除します。
リクエスト要素
データ型
説明
LoginId
String
Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.auYellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password
String
Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId
Integer
Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “REMOVEUSERACCESS”
String
Web services functionWebサービス関数。
OrgRef
String
Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional.
Person
AdministrationPerson
The AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process
Client
AdministrationClientOrg
The AdministrationClientOrg object holding the Yellowfin client organisation’s Client Reference ID for the retrieval process
These are the parameters that you need to set in the AdministrationPerson and AdministrationClientOrg objects:
AdministrationPerson Element
Data Type
Description
UserId
String
User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method
AdministrationClientOrg Element
Data Type
Description
ClientReferenceId
Integer
Client Reference ID for the specified client organisation
The response returned will contain these parameters:
Response Element
Data Type
Description
StatusCode
String
Status of the web service call. Possible values include:この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。
Person
AdministrationPerson
取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。
Client
AdministrationClientOrg
取得プロセスに関するYellowfinクライアント組織のクライアント参照IDを保持するAdministrationClientOrgオブジェクト。
AdministrationPersonおよびAdministrationClientOrgオブジェクトで設定が必要なパラメーターは、以下の通りです。
AdministrationPerson要素
データ型
説明
UserId
String
YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。
AdministrationClientOrg要素
データ型
説明
ClientReferenceId
Integer
指定されたクライアント組織のクライアント参照ID
返される応答には、以下のパラメーターが含まれます。
応答要素
データ型
説明
StatusCode
String
Webサービス呼び出しのステータス。可能な値は以下の通りです。
  • SUCCESS
  • FAILURE
Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au
この関数は、指定されたレポートがYellowfinの指定されたユーザーのお気に入り一覧に存在するかどうかをチェックします。
 Expand
titleISREPORTFAVOURITE
This function will check if a specified report is in a specified user’s favourites list in Yellowfin.
Request Element
Data Type
Description
LoginId
String
リクエスト要素
データ型
説明
LoginId
String
Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password
String
Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId
Integer
Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “ISUSERFAVOURITE”
String
Web services functionWebサービス関数。
OrgRef
String
Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional.この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。
Person
AdministrationPersonThe AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process
取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。
ReportId
Integer
Unique ID for the report
These are the parameters that you need to set in the AdministrationPerson object:
Description
AdministrationPerson Element
Data Type
レポートの固有のID。
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
AdministrationPerson要素
データ型
説明
UserId
String
User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method
The response returned will contain these parameters:
Description
Response Element
Data Type
YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。
返される応答には、以下のパラメーターが含まれます。
応答要素
データ型
説明
StatusCode
String
Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。
  • SUCCESS
  • FAILURE
Description
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
この関数は、指定されたレポートを指定されたユーザーのレポートのお気に入り一覧に追加します。
 Expand
titleADDTOFAVOURITES / ADDTOFAVORITES
The following code will call the Yellowfin web service and add a specified report to a specified user’s favourites list:以下のコードは、Yellowfin Webサービスを呼び出し、指定されたレポートを指定されたユーザーのお気に入り一覧に追加します。
 Code Block
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();

person.setUserId("test@yellowfin.com.au");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("ADDTOFAVOURITES");
rsr.setPerson(person);
rs.setReportId(12345);

rs = AdministrationService.remoteAdministrationCall(rsr);

The code will return SUCCESS in このコードはrs.getStatusCode(), otherwise it will return an error explaining why the process failed.
This function will add a specified report to a specified user’s report favourites list.
Request Element
Data Type
リクエスト要素
データ型
説明
LoginId
String
Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password
String
Password of the account used to connect to Yellowfin webservices
OrgId
Integer
Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId
Integer
Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “ADDTOFAVOURITES" OR または"ADDTOFAVORITES”
String
Web services functionWebサービス関数。
OrgRef
String
Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional.この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。
Person
AdministrationPersonThe AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process
取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。
ReportId
Integer
Unique ID for the report
These are the parameters that you need to set in the AdministrationPerson object:
Description
AdministrationPerson Element
Data Type
レポートの固有のID。
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
AdministrationPerson要素
データ型
説明
UserId
String
User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method
The response returned will contain these parameters:
Description
Response Element
Data Type
YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。
返される応答には、以下のパラメーターが含まれます。
応答要素
データ型
説明
StatusCode
String
Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。
  • SUCCESS
  • FAILURE
Description
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
この関数は、指定されたユーザーのレポートのお気に入り一覧に対して指定されたレポートを削除します。
 Expand
titleREMOVEFAVOURITES / REMOVEFAVORITES
The following code will call the Yellowfin web service and remove a specified report to a specified user’s favourites list:以下のコードは、Yellowfin Webサービスを呼び出し、指定されたユーザーのお気に入り一覧に対して指定されたレポートを削除します。
 Code Block
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();

person.setUserId("test@yellowfin.com.au");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("REMOVEFAVOURITE");
rsr.setPerson(person);
rs.setReportId(12345);

rs = AdministrationService.remoteAdministrationCall(rsr);

The code will return SUCCESS in このコードはrs.getStatusCode(), otherwise it will return an error explaining why the process failed.
This function will remove a specified report to a specified user’s report favourites list.
Request Element
Data Type
リクエスト要素
データ型
説明
LoginId
String
Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfinYellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password
String
Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId
Integer
Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “REMOVETOFAVOURITES" OR または"REMOVETOFAVORITES”
String
Web services function
OrgRef
String
Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional.
Webサービス関数。
OrgRef
String
この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。
Person
AdministrationPersonThe AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process
取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。
ReportId
Integer
Unique ID for the report
These are the parameters that you need to set in the AdministrationPerson object:
Description
AdministrationPerson Element
Data Type
レポートの固有のID。
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
AdministrationPerson要素
データ型
説明
UserId
String
User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method
The response returned will contain these parameters:
Description
Response Element
Data Type
YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。
返される応答には、以下のパラメーターが含まれます。
応答要素
データ型
説明
StatusCode
String
Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。
  • SUCCESS
  • FAILURE
Description
この関数は、Yellowfin内の指定されたユーザーのすべてのアバターイメージを返します。
 Expand
titleGETAVATARS
This function will return all avatar images of specified users within Yellowfin:
Request Element
Data Type
リクエスト要素
データ型
説明
LoginId
String
Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfinYellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password
String
Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId
Integer
Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “GETAVATARS”
String Web services functionWebサービス関数。
Parameters
Array (String)
The Unique IDs of Yellowfin users
The response returned will contain these parameters:
Description
Response Element
Data Type
Array（String）
Yellowfinユーザーの固有のID。
返される応答には、以下のパラメーターが含まれます。
応答要素
データ型
説明
StatusCode
String
Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。
  • SUCCESS
  • FAILURE
BinaryAttachments
Array (ReportBinaryObject)
Array of ReportBinary objects holding the Base64 decoded avatar imagesArray（ReportBinaryObject）
Base64でデコードされたアバターイメージを保持するReportBinaryオブジェクトの配列。
Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin
この関数は、Yellowfin内の指定されたユーザーのプロファイルのアバターイメージを設定します。
 Expand
titleSETAVATARIMAGE
This function will set the avatar image of the specified user’s profile within Yellowfin:
Request Element
Data Type
Description
LoginId
String
リクエスト要素
データ型
説明
LoginId
String
Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password
String
Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId
Integer
Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “SETAVATARIMAGE”
String
Web services functionWebサービス関数。
OrgRef
String
Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional.この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。
Person
AdministrationPersonThe AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process
取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。
Parameters
Array (Bytes)
Base64 encoded avatar image
These are the parameters that you need to set in the AdministrationPerson object:
Description
AdministrationPerson Element
Data Type
Array（Bytes）
Base64でエンコードされたアバターイメージ。
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
AdministrationPerson要素
データ型
説明
UserId
String
User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID methodYellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。
IpId
Integer
Unique IP ID of the Yellowfin user
The response returned will contain these parameters:
Description
Response Element
Data Type
Yellowfinユーザーの固有のIP ID。
返される応答には、以下のパラメーターが含まれます。
応答要素
データ型
説明
StatusCode
String
Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。
  • SUCCESS
  • FAILURE
Description
この関数は、Yellowfin内の指定された参照コードを再読み込みします。
 Expand
titleRELOADCODES
This function will reload the specified Org Reference Codes within Yellowfin.
Request Element
Data Type
リクエスト要素
データ型
説明
LoginId
String
Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password
String
Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId
Integer
Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “RELOADCODES”
String
Web services functionWebサービス関数。
Parameters
Array (String)
The list of Org Reference Codes
The response returned will contain these parameters:
Description
Response Element
Data Type
Array（String）
参照コードの一覧。
返される応答には、以下のパラメーターが含まれます。
応答要素
データ型
説明
StatusCode
String
Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。
  • SUCCESS
  • FAILURE
Description
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
この関数はYellowfinのジオメトリキャッシュをクリアします。
 Expand
titleGEOMETRYFLUSH
The following code will call the Yellowfin web service and clear the geometry cache in Yellowfin:以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのジオメトリキャッシュをクリアします。
 Code Block
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

// This is a Yellowfin View ID
String[] parameters ={
"48910"
};

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("GEOMETRYFLUSH");
rsr.setParameters(parameters);

rs = AdministrationService.remoteAdministrationCall(rsr);

The code will return SUCCESS in このコードはrs.getStatusCode(), otherwise it will return an error explaining why the process failed.
The function will clear the geometry cache in Yellowfin.
Request Element
Data Type
リクエスト要素
データ型
説明
LoginId
String
Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.auYellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password
String
Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId
Integer
Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “GEOMETRYFLUSH”
String
Web services functionWebサービス関数。
Parameters
Array (String)
The list of View IDs from which the geometry objects are cached with
The response returned will contain these parameters:
Description
Response Element
Data Type
Array（String）
ジオメトリオブジェクトのキャッシュ元となるビューIDの一覧。
返される応答には、以下のパラメーターが含まれます。
応答要素
データ型
説明
StatusCode
String
Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。
  • SUCCESS
  • FAILURE
Description
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
この関数はYellowfinのビューのキャッシュを削除します。
 Expand
titleREMOVEVIEW
The following code will call the Yellowfin web service and remove a view’s cache in Yellowfin:以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのビューのキャッシュを削除します。
 Code Block
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

// This is a Yellowfin View ID
String[] parameters ={
"49283"
};

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("REMOVEVIEW");
rsr.setParameters(parameters);

rs = AdministrationService.remoteAdministrationCall(rsr);

The code will return SUCCESS in このコードはrs.getStatusCode(), otherwise it will return an error explaining why the process failed.
This function will remove a view's cache in Yellowfin.
Request Element
Data Type
リクエスト要素
データ型
説明
LoginId
String
Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password
String
Password of the account used to connect to Yellowfin webservices
OrgId
Integer
Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId
Integer
Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “REMOVEVIEW”
String
Web services functionWebサービス関数。
Parameters
Array (String)
The list of View IDs
The response returned will contain these parameters:
Description
Response Element
Data Type
Array（String）
ビューIDの一覧。
返される応答には、以下のパラメーターが含まれます。
応答要素
データ型
説明
StatusCode
String
Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。
  • SUCCESS
  • FAILURE
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
 Expand
titleFLUSHREPORT
The following code will call the Yellowfin web service and remove a report’s cached definitions in Yellowfin:以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinにおけるレポートのキャッシュされた定義を削除します。
 Code Block
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

// This is a Yellowfin Report ID
String[] parameters ={
"11111"
};

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("FLUSHREPORT");
rsr.setParameters(parameters);

rs = AdministrationService.remoteAdministrationCall(rsr);

Description
The code will return SUCCESS in このコードはrs.getStatusCode(), otherwise it will return an error explaining why the process failed.
Request Element
Data Type
リクエスト要素
データ型
説明
LoginId
String
Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfinYellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password
String
Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId
Integer
Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “FLUSHREPORT”
String
Web services functionWebサービス関数。
Parameters
Array (String)
The list of Report IDs
The response returned will contain these parameters:
Description
Response Element
Data Type
Array（String）
レポートIDの一覧。
返される応答には、以下のパラメーターが含まれます。
応答要素
データ型
説明
StatusCode
String
Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。
  • SUCCESS
  • FAILURE
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
 Expand
titleFLUSHTAB
The following code will call the Yellowfin web service and remove a dashboard’s cached definitions in Yellowfin:以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinにおけるダッシュボードのキャッシュされた定義を削除します。
 Code Block
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

// This is a Yellowfin Dashboard Tab ID
String[] parameters ={
"12345"
};

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("FLUSHTAB");
rsr.setParameters(parameters);

rs = AdministrationService.remoteAdministrationCall(rsr);

Description
The code will return SUCCESS in このコードはrs.getStatusCode(), otherwise it will return an error explaining why the process failed.
Request Element
Data Type
リクエスト要素
データ型
説明
LoginId
String
Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfinYellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password
String
Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId
Integer
Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “FLUSHTAB”
String
Web services functionWebサービス関数。
Parameters
Array (String)
The list of Tab IDs
The response returned will contain these parameters:
Description
Response Element
Data Type
Array（String）
タブIDの一覧。
返される応答には、以下のパラメーターが含まれます。
応答要素
データ型
説明
StatusCode
String
Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。
  • SUCCESS
  • FAILURE
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
 Expand
titleDELETEREPORT
The following code will call the Yellowfin web service and delete a report in Yellowfin:以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのレポートを削除します。
 Code Block
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

// This is a Yellowfin Report UUID
String[] parameters ={
"7368e6d4-6167-4a16-ba52-ffa2440a5c8c"
};

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("DELETEREPORT");
// If the report ID is not set, then the code will look for the UUID in parameters
rsr.setReportId(12345);
rsr.setParameters(parameters);

rs = AdministrationService.remoteAdministrationCall(rsr);

Description
The code will return SUCCESS in このコードはrs.getStatusCode(), otherwise it will return an error explaining why the process failed.
Request Element
Data Type
リクエスト要素
データ型
説明
LoginId
String
Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfinYellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auauなど）。
Password
String
Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId
Integer
Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “DELETEREPORT”
String
Web services functionWebサービス関数。
Parameters
Array (String)
The UUID of the Yellowfin Report. Note, you do not need to set this if ReportId is setArray（String）
YellowfinレポートのUUID。ReportIdが設定されている場合、この設定は必要ありません。
ReportId
Integer
The Yellowfin Report ID. Note, you do not need to set this if the UUID is set in the Parameter array
The response returned will contain these parameters:
Description
Response Element
Data Type
YellowfinレポートのID。Parameterの配列にUUIDが設定されている場合、この設定は必要ありません。
返される応答には、以下のパラメーターが含まれます。
応答要素
データ型
説明
StatusCode
String
Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。
  • SUCCESS
  • FAILURE
Description
このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
 Expand
titleDELETEVIEW
The following code will call the Yellowfin web service and delete a view in Yellowfin:以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのビューを削除します。
 Code Block
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

// This example has a Yellowfin View UUID. The parameter value here can be either the UUID 
// or the Yellowfin View ID 
String[] parameters ={
"7368e6d4-6167-4a16-ba52-ffa2440a5c8c"
};

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("DELETEVIEW");
rsr.setParameters(parameters);

rs = AdministrationService.remoteAdministrationCall(rsr);

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.
Request Element
Data Type
リクエスト要素
データ型
説明
LoginId
String
Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password
String
Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId
Integer
Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “DELETEVIEW”
String
Web services functionWebサービス関数。
Parameters
Array (String)
Either the Yellowfin View ID or UUID can be set here
The response returned will contain these parameters:
Description
Response Element
Data Type
Array（String）
ここには、YellowfinのビューIDまたはUUIDを設定することができます。
返される応答には、以下のパラメーターが含まれます。
応答要素
データ型
説明
StatusCode
String
Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。
  • SUCCESS
  • FAILURE
Description
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
 Expand
titleDELETESOURCE
The following code will call the Yellowfin web service and delete a data source in Yellowfin:以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのデータソースを削除します。
 Code Block
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

// This is the Yellowfin Data Source ID
String[] parameters ={
"23456"
};

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("DELETESOURCE");
rsr.setParameters(parameters);

rs = AdministrationService.remoteAdministrationCall(rsr);

The code will return {SUCCESS in 
このコードはrs.getStatusCode(), otherwise it will return an error explaining why the process failed.
Request Element
Data Type
リクエスト要素
データ型
説明
LoginId
String
Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password
String
Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId
Integer
Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “DELETESOURCE”
String
Web services functionWebサービス関数。
Parameters
Array (String)
Either the Yellowfin Data Source ID or UUID can be set here
The response returned will contain these parameters:
Description
Response Element
Data Type
Array（String）
ここには、YellowfinのデータソースIDまたはUUIDを設定することができます。
返される応答には、以下のパラメーターが含まれます。
応答要素
データ型
説明
StatusCode
String
Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。
  • SUCCESS
  • FAILURE
The following code will call the Yellowfin web service and delete a dashboard tab in Yellowfin:
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
 Expand
titleDELETETAB
DELETETAB
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのダッシュボードタブを削除します。
 Code Block
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

// This is the Yellowfin Dashboard Tab UUID
String[] parameters ={
"7368e6d4-6167-4a16-ba52-ffa2440a5c8c"
};

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("DELETETAB");
rsr.setDashboardTabId(11223);
// If the Dashboard Tab ID is not set, then the code will look for the UUID in parameters
rsr.setParameters(parameters);

rs = AdministrationService.remoteAdministrationCall(rsr);

Description
The code will return SUCCESS in このコードはrs.getStatusCode(), otherwise it will return an error explaining why the process failed.
Request Element
Data Type
リクエスト要素
データ型
説明
LoginId
String
Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfinYellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password
String
Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId
Integer
Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “DELETETAB”
String
Web services functionWebサービス関数。
Parameters
Array (String)
UUID of the Yellowfin Dashboard Tab. Note that this does not need to be set if the DashboardTabId parameter is setArray（String）
YellowfinダッシュボードタブのUUID。DashboardTabIdパラメーターが設定されている場合、この設定は必要ありません。
DashboardTabId
Integer
Dashboard Tab ID
The response returned will contain these parameters:
Description
Response Element
Data Type
ダッシュボードタブID。
返される応答には、以下のパラメーターが含まれます。
応答要素
データ型
説明
StatusCode
String
Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。
  • SUCCESS
  • FAILURE
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
 Expand
titleRELOADLICENCE
The following code will call the Yellowfin web service and reload the licence definitions in Yellowfin:以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinでライセンス定義を再読み込みします。
 Code Block
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("RELOADLICENCE");

rs = AdministrationService.remoteAdministrationCall(rsr);

Description
The code will return SUCCESS in このコードはrs.getStatusCode(), otherwise it will return an error explaining why the process failed.
Request Element
Data Type
リクエスト要素
データ型
説明
LoginId
String
Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password
String
Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId
Integer
Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “RELOADLICENCE”
String
Web services function
The response returned will contain these parameters:
Description
Response Element
Data Type
Webサービス関数。
返される応答には、以下のパラメーターが含まれます。
応答要素
データ型
説明
StatusCode
String
Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。
  • SUCCESS
  • FAILURE
Description
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
 Expand
titleCLOSECONNECTIONPOOL
The following code will call the Yellowfin web service and close the specified data source’s connection pool in Yellowfin:以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたデータソースの接続プールを閉じます。
 Code Block
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

// This is a Yellowfin Data Source ID
String[] parameters ={
"11111"
};

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("CLOSECONNECTIONPOOL");
rsr.setParameters(parameters);

rs = AdministrationService.remoteAdministrationCall(rsr);

The code will return SUCCESS in このコードはrs.getStatusCode(), otherwise it will return an error explaining why the process failed.
Request Element
Data Type
リクエスト要素
データ型
説明
LoginId
String
Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password
String
Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId
Integer
Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “CLOSECONNECTIONPOOL”
String
Web services functionWebサービス関数。
Parameters
Array (String)
Yellowfin Data Source ID
The response returned will contain these parameters:
Description
Response Element
Data Type
Array（String）
YellowfinのデータソースID。
返される応答には、以下のパラメーターが含まれます。
応答要素
データ型
説明
StatusCode
String
Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。
  • SUCCESS
  • FAILURE
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
 Expand
titleFLUSHCACHEDFILTERCACHE
The following code will call the Yellowfin web service and flush the specified filter’s filter cache in Yellowfin:以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたフィルターのフィルターキャッシュをフラッシュします。
 Code Block
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

// This is a Yellowfin Filter ID
String[] parameters ={
"12345"
};

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("FLUSHCACHEDFILTERCACHE");
rsr.setParameters(parameters);

rs = AdministrationService.remoteAdministrationCall(rsr);

Description
The code will return SUCCESS in このコードはrs.getStatusCode(), otherwise it will return an error explaining why the process failed.
Request Element
Data Type
リクエスト要素
データ型
説明
LoginId
String
Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password
String
Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId
Integer
Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “FLUSHCACHEDFILTERCACHE”
String
Web services functionWebサービス関数。
Parameters
Array (String)
Filter ID
The response returned will contain these parameters:
Response Element
Data Type
Description
StatusCode
String
Status of the web service call. Possible values include:Array（String）
フィルターID。
返される応答には、以下のパラメーターが含まれます。
応答要素
データ型
説明
StatusCode
String
Webサービス呼び出しのステータス。可能な値は以下の通りです。
  • SUCCESS
  • FAILURE
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
 Expand
titleAPPROVEREPORT
The following code will call the Yellowfin web service and approve a report in Yellowfin via the expert approval process:以下のコードは、Yellowfin Webサービスを呼び出し、エキスパートの承認プロセスを介してYellowfinのレポートを承認します。
 Code Block
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("APPROVEREPORT");
rsr.setReportId(12345)

rs = AdministrationService.remoteAdministrationCall(rsr);

Description
The code will return SUCCESS in このコードはrs.getStatusCode(), otherwise it will return an error explaining why the process failed.
Request Element
Data Type
リクエスト要素
データ型
説明
LoginId
String
Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfinYellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password
String
Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId
Integer
Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “APPROVEREPORT”
String
Web services functionWebサービス関数。
ReportId
Integer
Report ID
The response returned will contain these parameters:
Response Element
Data Type
Description
StatusCode
String
Status of the web service call. Possible values include:レポートID。
返される応答には、以下のパラメーターが含まれます。
応答要素
データ型
説明
StatusCode
String
Webサービス呼び出しのステータス。可能な値は以下の通りです。
  • SUCCESS
  • FAILURE
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
 Expand
titleGETCONTENT
The following code will call the Yellowfin web service and obtain all exportable content within Yellowfin:以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内でエクスポート可能なすべてのコンテンツを取得します。
 Code Block
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
ContentResource[] cr = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("GETCONTENT");

rs = AdministrationService.remoteAdministrationCall(rsr);
cr = rs.getContentResources();

Description
The code will return an Array of ContentResource objects in このコードは、rs.getContentResources() and SUCCESS in でContentResourceオブジェクトの配列を返し、rs.getStatusCode(), otherwise it will return an error explaining why the process failed.
Request Element
Data Type
リクエスト要素
データ型
説明
LoginId
String
Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfinYellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password
String
Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId
Integer
Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “GETCONTENT”
String
Web services function
The response returned will contain these parameters:
Description
Response Element
Data Type
Webサービス関数。
返される応答には、以下のパラメーターが含まれます。
応答要素
データ型
説明
StatusCode
StringStatus of the web service call. Possible values include:
Webサービス呼び出しのステータス。可能な値は以下の通りです。
  • SUCCESS
  • FAILURE
ContentResources
Array (ContentResource)
Array of Content Resource objects. Each ContentResource object holds export metadata for all exportable content in Yellowfin.Array（ContentResource）
ContentResourceオブジェクトの配列。各ContentResourceオブジェクトには、Yellowfinでエクスポート可能なすべてのコンテンツのエクスポートメタデータが保持されます。
Description
()でContentResourceオブジェクトの配列を返し、rs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
この関数は、特定のYellowfin成果物についての従属関係を取得します。最初に、GETCONTENT Webサービス呼び出しを実行して、エクスポート可能なすべてのコンテンツメタデータを取得することができます。このコンテンツメタデータはContentResourceオブジェクトの配列という形式で取得され、この関数呼び出しでそれぞれの従属関係を取得するために使用することができます。
 Expand
titleGETEXPORTDEPENDENCIES
The following code will call the Yellowfin web service and obtain dependencies for a specific Yellowfin artifact:以下のコードは、Yellowfin Webサービスを呼び出し、特定のYellowfin成果物についての従属関係を取得します。
 Code Block
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
ContentResource[] cr = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("GETEXPORTDEPENDENCIES");

rs = AdministrationService.remoteAdministrationCall(rsr);
cr = rs.getContentResources();

The code will return an Array of ContentResource objects in このコードは、rs.getContentResources() and SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.
This function will obtain dependencies for a specific Yellowfin artifact. Note, you can execute the GETCONTENT webservices call to retrieve all exportable content metadata first. This comes in the form of an array of ContentResource objects which can be then used in this function call to retrieve their respective dependencies.
Request Element
Data Type
リクエスト要素
データ型
説明
LoginId
String
Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password
String
Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId
Integer
Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “GETEXPORTDEPENDENCIES”
String
Web services functionWebサービス関数。
ContentResources
Array (ContentResource)
Array of ContentResource objects. These objects will hold specific Yellowfin artifact metadata
These are the parameters that you need to set in the ContentResource object:
Data Type
ContentResource Element
Array（ContentResource）
ContentResourceオブジェクトの配列。これらのオブジェクトには、特定のYellowfin成果物のメタデータが保持されます。
ContentResourceオブジェクトで設定が必要なパラメーターは、以下の通りです。
ContentResource要素
データ型
ResourceName
String
ResourceDescription
String
ResourceType
String
ResourceOrgId
Integer
ResourceCode
String
The response returned will contain these parameters:
Response Element
Data Type
Description
StatusCode
String
Status of the web service call. Possible values include:
返される応答には、以下のパラメーターが含まれます。
応答要素
データ型
説明
StatusCode
String
Webサービス呼び出しのステータス。可能な値は以下の通りです。
  • SUCCESS
  • FAILURE
ContentResources
Array (ContentResource)
Array of ContentResource objects. These objects will hold dependency metadataArray（ContentResource）
ContentResourceオブジェクトの配列。これらのオブジェクトには従属関係メタデータが保持されます。
Description
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
この関数はYellowfin内の指定された成果物をエクスポートします。最初に、GETCONTENT Webサービス呼び出しを実行して、エクスポート可能なすべてのコンテンツメタデータを取得することができます。
 Expand
titleEXPORTCONTENT
The following code will call the Yellowfin web service and export the specified artifacts within Yellowfin:以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定された成果物をエクスポートします。
 Code Block
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

// It is advisable to run a GETCONTENT web service call beforehand to retrieve the necessary ContentResource objects
// This list can be copied over to the exportList array below
ContentResource[] exportList;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("EXPORTCONTENT");
rsr.setContentResources(exportList);

rs = AdministrationService.remoteAdministrationCall(rsr);
rbo = rs.getBinaryAttachments();

The code will return an Array of ReportBinaryObjects objects in このコードは、rs.getBinaryAttachments() and SUCCESS in でReportBinaryObjectsオブジェクトの配列を返し、rs.getStatusCode(), otherwise it will return an error explaining why the process failed.
This function will export the specified artifacts within Yellowfin. Note, you can execute the GETCONTENT webservices call to retrieve all exportable content metadata first.
Request Element
Data Type
リクエスト要素
データ型
説明
LoginId
String
Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfinYellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.au
Password
String
Password of the account used to connect to Yellowfin webservicesauなど）。
Password
String
Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId
Integer
Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “EXPORTCONTENT”
String
Web services functionWebサービス関数。
ContentResources
Array (ContentResource)
Array of ContentResource objects. These objects will hold specific Yellowfin artifact metadata
These are the parameters that you need to set in the ContentResource object:
Data Type
ContentResource Element
Array（ContentResource）
ContentResourceオブジェクトの配列。これらのオブジェクトには、特定のYellowfin成果物のメタデータが保持されます。
ContentResourceオブジェクトで設定が必要なパラメーターは、以下の通りです。
ContentResource要素
データ型
ResourceName
String
ResourceDescription
String
ResourceType
String
ResourceOrgId
Integer
ResourceCode
String
The response returned will contain these parameters:
Response Element
Data Type
Description
返される応答には、以下のパラメーターが含まれます。
The following code will call the Yellowfin web service and read a Yellowfin import file, returning the objects to be imported:
応答要素
データ型
説明
StatusCode
String
Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。
  • SUCCESS
  • FAILURE
BinaryAttachments
Array(ReportBinaryObjects)
Array of ReportBinaryObject objects. These objects will hold the XML for exported artifacts.
 Expand
titleGETIMPORTCONTENT
Array（ReportBinaryObjects）
ReportBinaryObjectオブジェクトの配列。これらのオブジェクトには、エクスポートされた成果物のXMLが保持されます。
Description
にあるws_admin_import.jspを参照してください。
この関数は、YellowfinのXMLインポートファイルを読み取り、アプリケーションにインポート可能なオブジェクトの一覧を返します。この関数の入力には、Base64でエンコードされたXMLファイルを使用してください。
 Expand
titleGETIMPORTCONTENT
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのインポートファイルを読み取り、インポートするオブジェクトを返します。
 Code Block
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
Byte[] data = <XML import file>;
ContentResource[] cr = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("GETIMPORTCONTENT");
rsr.setParameters( new String[] { Base64.encodeBytes(data) } );

rs = AdministrationService.remoteAdministrationCall(rsr);
cr = rs.getContentResources();

The code will return an Array of ContentResource objects in このコードは、rs.getContentResources() and SUCCESS in でContentResourceオブジェクトの配列を返し、rs.getStatusCode(), otherwise it will return an error explaining why the process failed.Refer to ws_admin_import.jsp in your Yellowfin web services directory YellowfinでSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
この関数の詳細な動作例については、Yellowfin WebサービスディレクトリYellowfin\development\examples\web services for a more detailed example of how this function would work.
This function will read a Yellowfin XML import file and return a list of objects that can be imported into the application. This function will be expecting a Base64 encoded XML file as input.
Request Element
Data Type
リクエスト要素
データ型
説明
LoginId
String
Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfinYellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auauなど）。
Password
String
Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId
Integer
Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “GETIMPORTCONTENT”
String
Web services functionWebサービス関数。
Parameters
Array (String)
Array of Base64 encoded chunks of the XML import file.
The response returned will contain these parameters:
Description
Response Element
Data Type
Array（String）
Base64でエンコードされた多数のXMLインポートファイルの配列。
返される応答には、以下のパラメーターが含まれます。
応答要素
データ型
説明
StatusCode
String
Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。
  • SUCCESS
  • FAILURE
ContentResources
Array (ContentResource)
Array of ContentResource objects. These objects will hold specific Yellowfin artifact metadataArray（ContentResource）
ContentResourceオブジェクトの配列。これらのオブジェクトには、特定のYellowfin成果物のメタデータが保持されます。
The following code will call the Yellowfin web service and validate the Yellowfin import objects. This function usually follows after the GETIMPORTCONTENT web services call:Primary Organisation ID within Yellowfin. Always set this to 1
このコードは、インポートファイルに問題がある場合にはrs.getImportIssues()でImportIssueオブジェクトの配列を返し、rs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
この関数の詳細な動作例については、Yellowfin WebサービスディレクトリYellowfin\development\examples\web servicesにあるws_admin_import.jspを参照してください。
この関数はYellowfinのインポートオブジェクトの一覧をテストします。通常、この関数はGETIMPORTCONTENT Webサービス呼び出しのあとに実行され、YellowfinのXMLインポートファイルを読み取り、アプリケーションにインポート可能なオブジェクトの一覧を返します。この関数は、この一覧内のすべてのオブジェクトについて検証プロセスを実行します。検証プロセス中に発生したすべての問題は、応答でImportIssueオブジェクトとして返されます。
 Expand
titleTESTIMPORTCONTENT
TESTIMPORTCONTENT
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのインポートオブジェクトをテストします。通常、この関数はGETIMPORTCONTENT Webサービス呼び出しのあとに実行します。
 Code Block
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
Byte[] data = <XML import file>;
ImportIssue[] ii = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("TESTIMPORTCONTENT");
rsr.setParameters( new String[] { Base64.encodeBytes(data) } );

rs = AdministrationService.remoteAdministrationCall(rsr);
ii = rs.getImportIssues();

The code will return an Array of ImportIssue objects in rs.getImportIssues() if there are issues with the import file and SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.
Refer to ws_admin_import.jsp in your Yellowfin web services directory Yellowfin\development\examples\web services for a more detailed example of how this function would work.
This function will validate a list of Yellowfin import objects. This function usually follows after the GETIMPORTCONTENT webservices call, where it reads a Yellowfin XML import file and returns a list of objects that can be imported into the application. In this function, it performs a validation process for every object in that list. Any issues encountered during the validation process is returned as ImportIssue objects in the response.
Request Element
Data Type
Description
LoginId
String
Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au
Password
String
Password of the account used to connect to Yellowfin webservices
OrgId
Integer
リクエスト要素
データ型
説明
LoginId
String
Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password
String
Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId
Integer
Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “TESTIMPORTCONTENT”
String
Web services functionWebサービス関数。
Parameters
Array (String)
An array of Base64 encoded chunks of the XML import fileArray（String）
Base64でエンコードされた多数のXMLインポートファイルの配列。
ImportOptions
Array(ImportOption)
An array of ImportOption objects that controls how content is imported.
The response returned will contain these parameters:
Description
Response Element
Data Type
Array（ImportOption）
コンテンツのインポート方法を制御するImportOptionオブジェクトの配列。
返される応答には、以下のパラメーターが含まれます。
応答要素
データ型
説明
StatusCode
String
Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。
  • SUCCESS
  • FAILURE
ImportIssues
Array (ImportIssue)
Array of ImportIssue objects. These objects will contain error messages returned from the validation processArray（ImportIssue）
ImportIssueオブジェクトの配列。これらのオブジェクトには、検証プロセスから返されたエラーメッセージが含まれます。
servicesにあるws_admin_import.jspを参照してください。
 Expand
titleIMPORTCONTENT
The following code will call the Yellowfin web service and import the specified Yellowfin import objects into the application:以下のコードは、Yellowfin Webサービスを呼び出し、指定されたYellowfinのインポートオブジェクトをアプリケーションにインポートします。
 Code Block
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
Byte[] data = <XML import file>;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("IMPORTCONTENT");
rsr.setParameters( new String[] { Base64.encodeBytes(data) } );

rs = AdministrationService.remoteAdministrationCall(rsr);

The code will return SUCCESS in このコードはrs.getStatusCode(), otherwise it will return an error explaining why the process failed.Refer to ws_admin_import.jsp in your Yellowfin web services directory でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
Description
この関数の詳細な動作例については、Yellowfin WebサービスディレクトリYellowfin\development\examples\web services for a more detailed example of how this function would work.
Request Element
Data Type
リクエスト要素
データ型
説明
LoginId
String
Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.auYellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password
String
Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId
Integer
Primary Organisation ID within Yellowfin. Always set this to 1Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “IMPORTCONTENT”
String
Web services functionWebサービス関数。
Parameters
Array (String)
An array of Base64 encoded chunks of the XML import fileArray（String）
Base64でエンコードされた多数のXMLインポートファイルの配列。
ImportOptions
Array(ImportOption)
An array of ImportOption objects that controls how content is imported.
The response returned will contain these parameters:
Description
Response Element
Data Type
Array（ImportOption）
コンテンツのインポート方法を制御するImportOptionオブジェクトの配列。
返される応答には、以下のパラメーターが含まれます。
応答要素
データ型
説明
StatusCode
String
Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。
  • SUCCESS
  • FAILURE
...
オブジェクト定義
 Expand
titleAdministrationPerson
AdministrationPerson Element
Data Type
Description
UserId
String
User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method
Password
String
Password of the Yellowfin user
FirstName
String
First name of of the Yellowfin user
LastName
String
Last name of of the Yellowfin user
Initial
String
Middle initial of the Yellowfin user
SalutationCode
String
Title of the Yellowfin user. Possible values include:
  • DR
  • MISS
  • MR
  • MRS
  • MS
RoleCode
String
Yellowfin role. The specified role here can be the Org Reference Code (YFADMIN) or the name of the role (Yellowfin Administrator)
EmailAddress
String
Email address of the Yellowfin user
LanguageCode
String
Two letter code for the preferred language
IpId
Integer
Internal Yellowfin IP ID
TimeZoneCode
String
The TimeZoneCode of the Yellowfin user.
 Expand
titleAdministrationReport
AdministrationReport Element
Data Type
ReportName
String
ReportDescription
String
ReportId
Integer
ExecutionObject
String
ReportCategory
String
ReportSubCategory
String
BirtData
String
SourceName
String
SourceId
Integer
AuthoringMode
String
ReportTemplate
String
DataOutput
String
DashboardEnabled
Boolean
ViewId
Integer
ViewName
String
ViewDescription
String
LastModifierName
String
LastModifierId
Integer
LastModifiedDate
Date
PublishDate
Date
DeliveryMode
String
LastRunTime
Integer
AverageRunTime
Integer
RoleCode
String
ChartTypeCode
String
Usage
Integer
 Expand
titleAdministrationReportGroup
AdministrationReportGroup Element
Data Type
Description
ReportGroupName
String
 
ReportGroupDescription
String
 
ReportGroupId
Integer
 
ReportGroupStatus
String
 
ReportGroupType
String
 
ReportGroupInternalReference
String
 
GroupReports
Array (AdministrationReports)
Array of AdministrationReport objects which hold report metadata. These are the reports that make up the portlets within the dashboard tab
AssociatedReports
Array (Integer)
 
 Expand
titleAdministrationRole
AdministrationReportGroup Element
Data Type
Description
RoleName
String
The name of the Yellowfin Role
RoleDescription
String
The business description of the Yellowfin Role
RoleCode
String
The internal code for the Yellowfin Role that is generated and referenced in the database
 Expand
titleAdministrationGroup
AdministrationGroup Element
Data Type
Description
GroupName
String
 
GroupDescription
String
 
GroupId
Integer
 
GroupStatus
String
 
GroupInternalReference
String
 
GroupMembers
Array (AdministrationGroupMember)
An array of AdministrationGroupMember objects. These objects hold group member metadata
 Expand
titleAdministrationClientOrg
AdministrationClientOrg Element
Data Type
Description
ClientName
String
Name of the client organisation
ClientReferenceID
String
Client Reference ID which is the unique ID used to identify a client
TimeZoneCode
String
A client organisation’s local time zone code. See appendix for valid values.
DefaultOrg
Boolean
Boolean value that returns true if this organisation is the primary organisation
 Expand
titleReportBinaryObject
ReportBinaryObject Element
Data Type
Description
Key
String
Unique key used for Binary Object storage
ContentType
String
MIME type for the Binary Object
Data
Array (Byte)
Raw data for Binary Object
 Expand
titleContentResource
ContentResource Element
Data Type
ResourceName
String
ResourceDescription
String
ResourceId
Integer
ResourceUUID
Integer
ResourceType
String
ResourceOrgId
Integer
ResourceCode
String
 Expand
titleImportOption
ImportOption Element
Data Type
Description
ItemIndex
Integer
The index of the item that this option is attached too.
OptionKey
String
The type of option.
OptionValue
String
A value associated with this option.
...