Versions Compared

Version Old Version 8 New Version 9
Changes made by

Yellowfin Admin

Yellowfin Admin

Saved on

Key

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

Anchor
top
top

...

Expand
titleGETFAVOURITES / GETFAVORITES

以下のコードは、Yellowfin Webサービスを呼び出し、特定ユーザーがアクセス可能なすべてのレポートのお気に入りを返します。

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

Person.setUserId("testuser@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 user belongs to a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("GETFAVOURITES");
rsr.setPerson(person);

rs = AdministrationService.remoteAdministrationCall(rsr);

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

この関数は、指定されたYellowfinユーザーのすべてのお気に入りのレポートを返します。

リクエスト要素

データ型

説明

LoginId

String

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

Password

String

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

OrgId

Integer

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

Function = “GETFAVOURITES”または“GETFAVORITES”

String

Webサービス関数。

OrgRef

String

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

Person

AdministrationPerson

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

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

AdministrationPerson要素

データ型

説明

UserId

String

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

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

応答要素

データ型

説明

StatusCode

String

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

  • SUCCESS
  • FAILURE

Reports

AdministrationReport

AdministrationReportオブジェクトの配列。これらのオブジェクトにはレポートメタデータが保持されます。

Description

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

この関数は、指定されたYellowfinユーザーの受信トレイ内にあるレポートを返します。

Expand
titleGETINBOX

The following code will call the Yellowfin web service and return all reports that are in the particular user’s inbox:以下のコードは、Yellowfin Webサービスを呼び出し、特定ユーザーの受信トレイ内にあるすべてのレポートを返します。

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

Person.setUserId("testuser@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 user belongs to a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("GETINBOX");
rsr.setPerson(person);

rs = AdministrationService.remoteAdministrationCall(rsr);

This code will return an Array of AdministrationReport objects in このコードは、rs.getReports() and SUCCESS in でAdministrationReportオブジェクトの配列を返し、rs.getStatusCode(), otherwise it will return an error message explaining why the process failed.

This function will return the reports that are in the inbox of a specified Yellowfin user.

Request Element

Data Type

リクエスト要素

データ型

説明

LoginId

String

Login ID of the account used to connect to Yellowfin webservices eg. 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 = “GETINBOX”

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

These are the parameters that you need to set in the AdministrationPerson object:

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

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String Status of the web service call. Possible values include:

  • SUCCESS
  • FAILURE

Reports

AdministrationReport

An array of AdministrationReport objects. These objects hold report metadata.この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。

Person

AdministrationPerson

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

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

AdministrationPerson要素

データ型

説明

UserId

String

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

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

応答要素

データ型

説明

StatusCode

String

Reports

AdministrationReport

AdministrationReportオブジェクトの配列。これらのオブジェクトにはレポートメタデータが保持されます。

AdministrationServiceRequest rsr =

以下のコードは、Yellowfin Webサービスを呼び出し、特定ユーザーがアクセス可能なレポートを含まないすべてのダッシュボードタブを返します。

Expand
titleGETUSERTABS

The following code will call the Yellowfin web service and return all dashboard tabs without reports that are accessible for that particular user:

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

Person.setUserId("testuser@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 user belongs to a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("GETUSERTABS");
rsr.setPerson(person);

rs = AdministrationService.remoteAdministrationCall(rsr);

This code will return an Array of AdministrationReportGroup objects in このコードは、rs.getReportGroups() and SUCCESS in でAdministrationReportGroupオブジェクトの配列を返し、rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will return a list of dashboard tabs that are accessible by the specified Yellowfin user.

Request Element

Data Type

Description

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

この関数は、指定されたYellowfinユーザーがアクセス可能なダッシュボードタブの一覧を返します。

リクエスト要素

データ型

説明

LoginId

String

Login ID of the account used to connect to Yellowfin webservices eg. 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 = “GETUSERTABS”

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

AdministrationPerson

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

These are the parameters that you need to set in the AdministrationPerson object:

Description

AdministrationPerson Element

Data Type

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

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:

Response Element

Data Type

Description

StatusCode

String Status of the web service call. Possible values include:YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。

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

応答要素

データ型

説明

StatusCode

String

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

  • SUCCESS
  • FAILURE

ReportsGroups

AdministrationReportGroupAn array of AdministrationReportGroup objects. These objects hold dashboard metadata.

AdministrationReportGroupオブジェクトの配列。これらのオブジェクトにはダッシュボードメタデータが保持されます。
Description

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

この関数は、指定されたYellowfinユーザーがアクセス可能なダッシュボードタブの一覧を返します。このとき、レポートのメタデータも同時にロードされます。ダッシュボードタブのすべてのレポートのメタデータは、AdministrationReportGroupオブジェクト内に含まれます。

Expand
titleGETUSERTABSWITHREPORTS

The following code will call the Yellowfin web service and return all dashboard tabs with reports that are accessible for that particular user:以下のコードは、Yellowfin Webサービスを呼び出し、特定ユーザーがアクセス可能なレポートを含むすべてのダッシュボードタブを返します。

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

Person.setUserId("testuser@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 user belongs to a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("GETUSERTABS");
rsr.setPerson(person);

rs = AdministrationService.remoteAdministrationCall(rsr);

This code will return an Array of AdministrationReportGroup objects in このコードは、rs.getReportGroups() and SUCCESS in でAdministrationReportGroupオブジェクトの配列を返し、rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will return a list of dashboard tabs that are accessible by the specified Yellowfin user, with the reports’ metadata loaded as well. The metadata for every report in the dashboard tab is contained within the AdministrationReportGroup object.

Request Element

Data Type

リクエスト要素

データ型

説明

LoginId

String

Login ID of the account used to connect to Yellowfin webservices eg. 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 = “GETUSERTABSWITHREPORTS”

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

AdministrationPerson

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

These are the parameters that you need to set in the AdministrationPerson object:

Description

AdministrationPerson Element

Data Type

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

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:

Response Element

Data Type

Description

StatusCode

String Status of the web service call. Possible values include:YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。

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

応答要素

データ型

説明

StatusCode

String

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

  • SUCCESS
  • FAILURE

ReportsGroups

AdministrationReportGroupAn array of AdministrationReportGroup objects. These objects hold dashboard metadata. For this particular function, the reports’ metadata is also loaded into this object’s GroupReports() parameter.

AdministrationReportGroupオブジェクトの配列。これらのオブジェクトにはダッシュボードメタデータが保持されます。この特定の関数では、レポートのメタデータもこのオブジェクトのGroupReports()パラメーターにロードされます。
Description

この関数は、指定されたダッシュボードタブ内に含まれるレポートの一覧を返します。このレポートには、Yellowfinの指定されたユーザーがアクセスすることができます。

Expand
titleLOADTABREPORTS

This function will return a list of reports contained within a specified dashboard tab, that is accessible by a specified user in Yellowfin.

Request Element

Data Type

リクエスト要素

データ型

説明

LoginId

String

Login ID of the account used to connect to Yellowfin webservices eg. 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 = “LOADTABREPORTS”

String

Web services functionWebサービス関数。

Person

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

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

ReportGroup

AdministrationReportGroup

The AdministrationReportGroup object holding the Dashboard Tab ID for the retrieval process

These are the parameters that you need to set in the AdministrationPerson and AdministrationReportGroup object:

Description

AdministrationPerson Element

Data Type

取得プロセスに関するダッシュボードタブIDを保持するAdministrationReportGroupオブジェクト。

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

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

AdministrationReportGroup Element

Data Type

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

AdministrationReportGroup要素

データ型

説明

ReportGroupId

String

Dashboard Tab ID

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String Status of the web service call. Possible values include:

  • SUCCESS

    • ダッシュボードタブID

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

    応答要素

    データ型

    説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE

    ReportGroups

    AdministrationReportGroup

    An array of AdministrationReportGroup objects. These objects hold dashboard metadata. For this particular function, the reports’ metadata is also loaded into this object’s GroupReports() parameter.

    Group & Role Administration

    Groups and Roles can be created and modified with a web service call. The objects returned in the response is dependent on the type of call made in the request.

    ...

    AdministrationReportGroupオブジェクトの配列。これらのオブジェクトにはダッシュボードメタデータが保持されます。この特定の関数では、レポートのメタデータもこのオブジェクトのGroupReports()パラメーターにロードされます。

    グループ及びロールの管理

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

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

    Description

    でSUCCESSを返します。

    この関数は、Yellowfin内で使用可能なすべてのロールを返します。

    Expand
    titleLISTROLES

    The following code will call the Yellowfin web service and return all available roles within Yellowfin:以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内で使用可能なすべてのロールを返します。

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

rsr.setOrgId(new Integer(1));
rsr.setFunction("LISTROLES");

rs = AdministrationService.remoteAdministrationCall(rsr);

    The code will return an Array of AdministrationRole objects in このコードは、rs.getRoles() and SUCCESS in でAdministrationRoleオブジェクトの配列を返し、rs.getStatusCode().

    This function will return all the available roles within Yellowfin.

    Request Element

    Data Type

    リクエスト要素

    データ型

    説明

    LoginId

    String

    Login ID of the account used to connect to Yellowfin webservices eg. 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 = “LISTROLES”

    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

    Rolesロール

    AdministrationRoleAn array of AdministrationRole objects. These objects hold Yellowfin Role metadata.

    AdministrationRoleオブジェクトの配列。これらのオブジェクトにはYellowfinロールのメタデータが保持されます。

    Description

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

    この関数は、Yellowfin内で使用可能なすべてのユーザーグループを返します。

    Expand
    titleLISTGROUPS

    The following code will call the Yellowfin web service and return all available groups within Yellowfin:以下コードは、Yellowfin Webサービスを呼び出し、Yellowfin内で使用可能なすべてのグループを返します。

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

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 groups in a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("LISTGROUPS");

rs = AdministrationService.remoteAdministrationCall(rsr);

    The code will return an Array of AdministrationGroup objects in このコードは、rs.getGroups() and SUCCESS in でAdministrationGroupオブジェクトの配列を返し、rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

    This function will return all the available user groups within Yellowfin.

    Request Element

    Data Type

    リクエスト要素

    データ型

    説明

    LoginId

    String

    Login ID of the account used to connect to Yellowfin webservices eg. 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 = “LISTGROUPS”

    String

    Web services functionWebサービス関数。

    OrgRef

    String

    Client Reference ID if this function is to be applied for a particular client organisation. The parameter is optional.

    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

    Groupsグループ

    AdministrationGroupAn array of AdministrationGroup objects. These objects hold Yellowfin user group metadata.

    AdministrationGroupオブジェクトの配列。これらのオブジェクトにはYellowfinユーザーグループのメタデータが保持されます。

    Description

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

    この関数は、指定されたYellowfinグループおよびそのメンバーの一覧を返します。

    Expand
    titleGETGROUP

    The following code will call the Yellowfin web service and return the specified group with its members in Yellowfin:

    code

    以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたグループおよびそのメンバーを返します。

    Code Block
    AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
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("GETGROUP");
rsr.setGroup(group);

rs = AdministrationService.remoteAdministrationCall(rsr);
group = rs.getGroup();

AdministrationGroupMember[] groupMembers = group.getGroupMembers();

    The code will return an AdministrationGroup object in このコードは、rs.getGroup(), an Array of AdministrationGroupMembers in rs.getGroup()でAdministrationGroupオブジェクトを返し、rs.getGroupMembers(), and SUCCESS in でAdministrationGroupMembersの配列を返し、rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

    This function will return a specified Yellowfin group with a list of its members.

    Request Element

    Data Type

    リクエスト要素

    データ型

    説明

    LoginId

    String

    Login ID of the account used to connect to Yellowfin webservices eg. 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 = “GETGROUP”

    String

    Web services functionWebサービス関数。

    OrgRef

    String

    Client Reference ID if this function is to be applied for a particular client organisation. The parameter is optional.

    Group

    AdministrationGroup

    The AdministrationGroup object holding the Yellowfin user group’s name for the retrieval process

    These are the parameters that you need to set in the AdministrationGroup object:

    AdministrationGroup Element

    Data Type

    Description

    GroupName

    String

    Name of the specified Yellowfin Group

    The response returned will contain these parameters:

    Response Element

    Data Type

    Description

    StatusCode

    String

    Status of the web service call. Possible values include:

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

    Group

    AdministrationGroup

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

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

    AdministrationGroup要素

    データ型

    説明

    GroupName

    String

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

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

    応答要素

    データ型

    説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE

    Group

    AdministrationGroupAn array

    of AdministrationGroup objects holding group metadata. The group members are also loaded into this object's GroupMembers() parameter.グループメタデータを保持するAdministrationGroupオブジェクトの配列。グループメンバーもこのオブジェクトのGroupMembers()のパラメーターにロードされます。

    Description

    に保存されます。

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

    Expand
    titleCREATEGROUP

    The following code will call the Yellowfin web service and create the specified group in Yellowfin:以下のコードは、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);

    The code will return SUCCESS in このコードはrs.getStatusCode(), otherwise it will return an error explaining why the process failed.Note: you can also put existing Yellowfin users into this newly created group at the same time by populating an AdministrationGroupMember array of AdministrationPerson objects. Each AdministrationPerson object only needs the LoginId variable set, and the AdministrationGroupMember array is saved at でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

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

    This function will create a Yellowfin group. Note that you are able to save existing Yellowfin users into the new group in this function as well.

    Request Element

    Data Type

    リクエスト要素

    データ型

    説明

    LoginId

    String

    Login ID of the account used to connect to Yellowfin webservices eg. 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 = “CREATEGROUP”

    String

    Web services functionWebサービス関数。

    OrgRef

    String

    Client Reference ID if this function is to be applied for a particular client organisation. The parameter is optional.

    Group

    AdministrationGroup

    The AdministrationGroup object holding the Yellowfin user group’s name for the retrieval process

    These are the parameters that you need to set in the AdministrationGroup object:

    AdministrationGroup Element

    Data Type

    Description

    GroupName

    String

    Name of the specified Yellowfin group

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

    Group

    AdministrationGroup

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

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

    AdministrationGroup要素

    データ型

    説明

    GroupName

    String

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

    GroupDescription

    String

    Business description of the specified Yellowfin group指定したYellowfinグループの説明

    GroupMembers

    Array (AdministrationPerson)

    An array of AdministrationPerson objects. This is an optional parameter where you can set to save existing Yellowfin users into this group. Each AdministrationPerson object in this scenario only needs to have its UserId parameter set.

    The response returned will contain these parameters:

    Description

    Response Element

    Data Type

    Array（AdministrationPerson）

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

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

    応答要素

    データ型

    説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE
    Description

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

    この関数は、指定されたグループに指定されたYellowfinユーザーを含めます。

    Expand
    titleINCLUDEUSERINGROUP

    The following code will call the Yellowfin web service and include a specified user into a specified group in Yellowfin:以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたグループに指定されたユーザーを含めます。

    Code Block
    AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
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("INCLUDEUSERINGROUP");
rsr.setGroup(group);
rsr.setPerson(person);

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 include a specified Yellowfin user into a specified group.

    Request Element

    Data Type

    リクエスト要素

    データ型

    説明

    LoginId

    String

    Login ID of the account used to connect to Yellowfin webservices eg. 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 = “INCLUDEUSERINGROUP”

    String

    Web services functionWebサービス関数。

    OrgRef

    String

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

    Group

    AdministrationGroupThe AdministrationGroup object holding the Yellowfin user group’s name for the retrieval process

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

    Person

    AdministrationPerson

    The AdministrationPerson object holding the Yellowfin user’s User Id for the retrieval process

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

    Description

    AdministrationGroup Element

    Data Type

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

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

    Description

    AdministrationGroup要素

    データ型

    説明

    GroupName

    String

    Name of the specified Yellowfin group

    AdministrationPerson Element

    Data Type

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

    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を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

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

    Expand
    titleEXCLUDEUSERINGROUP

    The following code will call the Yellowfin web service and exclude a specified user from a specified group in Yellowfin.

    Note: this user is not deleted from the group but merely excluded from the group definition. An example of why this would be useful is when:

  • John Doe is a member of Group A
  • Group A is a member of Group B
    • John Doe shouldn’t be a member of Group B, therefore he should be excluded from Group B

    以下のコードは、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);

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

    This function will exclude a specified Yellowfin user from a specified group. Note that this user is not deleted from the group but merely excluded from the group definition. An example of why this would be useful is when:

    • John Doe is a member of Group A
    • Group A is a member of Group B
    • John Doe shouldn’t be a member of Group B, therefore he is to be excluded from Group B

    Request Element

    Data Type

    リクエスト要素

    データ型

    説明

    LoginId

    String

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

    Password

    String

    Password of the account used to connect to Yellowfin webservicesString

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

    OrgId

    Integer

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

    Function = “EXCLUDEUSERINGROUP”

    String

    Web services functionWebサービス関数。

    OrgRef

    String

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

    Group

    AdministrationGroupThe AdministrationGroup object holding the Yellowfin user group’s name for the retrieval process

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

    Person

    AdministrationPerson

    The AdministrationPerson object holding the Yellowfin user’s User Id for the retrieval process

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

    Description

    AdministrationGroup Element

    Data Type

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

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

    Description

    AdministrationGroup要素

    データ型

    説明

    GroupName

    String

    Name of the specified Yellowfin group

    AdministrationPerson Element

    Data Type

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

    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を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

    この関数は、指定したグループから指定されたYellowfinユーザーを削除します。このシナリオはEXCLUDEUSERINGROUPのシナリオとは異なります。この関数の場合、ユーザーはグループから完全に削除される点に注意してください。

    Expand
    titleDELETEUSERFROMGROUP

    The following code will call the Yellowfin web service and delete a specified user from a specified group in Yellowfin:以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたグループから指定されたユーザーを削除します。

    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("DELUSERFROMGROUP");
rsr.setGroup(group);
rsr.setPerson(person);

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 delete a specified Yellowfin user from a specified group. Note that this scenario is different from the one in EXCLUDEUSERINGROUP – in this function a user will be permanently removed from the group.

    Request Element

    Data Type

    リクエスト要素

    データ型

    説明

    LoginId

    String

    Login ID of the account used to connect to Yellowfin webservices eg. 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 = “DELUSERFROMGROUP”

    String

    Web services functionWebサービス関数。

    OrgRef

    String

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

    Group

    AdministrationGroupThe AdministrationGroup object holding the Yellowfin user group’s name for the retrieval process

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

    Person

    AdministrationPerson

    The AdministrationPerson object holding the Yellowfin user’s User Id for the retrieval process

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

    Description

    AdministrationGroup Element

    Data Type

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

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

    Description

    AdministrationGroup要素

    データ型

    説明

    GroupName

    String

    Name of the specified Yellowfin group

    AdministrationPerson Element

    Data Type

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

    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:

    Response Element

    Data Type

    Description

    StatusCode

    String

    Status of the web service call. Possible values include:YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。

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

    応答要素

    データ型

    説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE
    Description

    に保存されます。

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

    Expand
    titleMODIFYGROUP

    The following code will call the Yellowfin web service and modify the specified group in Yellowfin:以下のコードは、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);

    The code will return SUCCESS in このコードはrs.getStatusCode(), otherwise it will return an error explaining why the process failed.Note: you can also put existing Yellowfin users into this modified group at the same time by populating an AdministrationGroupMember array of AdministrationPerson objects. Each AdministrationPerson object only needs the LoginId variable set, and the AdministrationGroupMember array is saved at でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

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

    This function will modify the details for a specified group in Yellowfin. Note that you are able to save existing Yellowfin users into the new group in this function as well.

    Request Element

    Data Type

    リクエスト要素

    データ型

    説明

    LoginId

    String

    Login ID of the account used to connect to Yellowfin webservices eg. 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 = “MODIFYGROUP”

    String

    Web services functionWebサービス関数。

    OrgRef

    String

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

    Group

    AdministrationGroup

    The AdministrationGroup object holding the Yellowfin user group’s name for the retrieval process

    These are the parameters that you need to set in the AdministrationGroup object:

    Description

    AdministrationGroup Element

    Data Type

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

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

    AdministrationGroup要素

    データ型

    説明

    GroupName

    String

    Name of the specified Yellowfin group

    GroupDescription

    String

    Business description of the specified Yellowfin group

    GroupMembers

    Array (AdministrationPerson)

    An array of AdministrationPerson objects. This is an optional parameter where you can set to save existing Yellowfin users into this group. Each AdministrationPerson object in this scenario only needs to have its LoginId parameter set.

    The response returned will contain these parameters:

    Response Element

    Data Type

    Description

    StatusCode

    String

    Status of the web service call. Possible values include:指定したYellowfinグループの名前

    GroupDescription

    String

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

    GroupMembers

    Array（AdministrationPerson）

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

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

    応答要素

    データ型

    説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE
    Description

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

    この関数はYellowfinから指定されたユーザーを削除します。

    Expand
    titleDELETEGROUP

    The following code will call the Yellowfin web service and delete the specified group in Yellowfin:以下のコードは、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("DELETEGROUP");
rsr.setGroup(group);

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 delete a specified group from Yellowfin.

    Request Element

    Data Type

    リクエスト要素

    データ型

    説明

    LoginId

    String

    Login ID of the account used to connect to Yellowfin webservices eg. 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.

    Integer

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

    Function = “DELETEGROUP”

    String

    Web services functionWebサービス関数。

    OrgRef

    String

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

    Group

    AdministrationGroup

    The AdministrationGroup object holding the Yellowfin user group’s name for the retrieval process

    These are the parameters that you need to set in the AdministrationGroup object:

    Description

    AdministrationGroup Element

    Data Type

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

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

    AdministrationGroup要素

    データ型

    説明

    GroupName

    String

    Name of the specified Yellowfin group

    The response returned will contain these parameters:

    Description

    Response Element

    Data Type

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

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

    応答要素

    データ型

    説明

    StatusCode

    String

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

    • SUCCESS
    • FAILURE

    Client Organisation Functionality

    Yellowfin contains functionality called クライアント組織, which allows multiple virtual instances of Yellowfin to reside in the same server instance.

    ...

    マルチテナント機能

    Yellowfinには、クライアント組織と呼ばれる機能があり、この機能を使用するとYellowfinの複数の仮想インスタンスを同じサーバーインスタンスに配置できます。

    クライアント組織機能は、以下に示す使用可能なWebサービス呼び出しによって管理することができます。

    Expand
    titleLISTCLIENTS

    The following code will call the Yellowfin web service and list all client organisations within 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("LISTCLIENTS");

rs = AdministrationService.remoteAdministrationCall(rsr);

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

    This function will list all client organisations available within Yellowfin.

    Request Element

    Data Type

    Description

    LoginId

    String

    Login ID of the account used to connect to Yellowfin webservices eg. 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.

    Function = “LISTCLIENTS”

    String

    Web services function

    The response returned will contain these parameters:

    Response Element

    Data Type

    Description

    StatusCode

    String

    Status of the web service call. Possible values include:

    • SUCCESS
    • FAILURE

    ...