...
Webサービス呼び出しを使用して、グループとロールの作成や変更をすることができます。応答で返されるオブジェクトは、リクエストで実行される呼び出しのタイプに依存します。
注意：システム構成ページで、クライアント組織機能を有効化している場合、特定のタイプの呼び出しについて適用可能な場合は、クライアント組織を指定することもできます。
...
| Expand |
|---|
|
以下のコードは、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サービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
...
| Expand |
|---|
| title | EXCLUDEUSERFROMGROUP |
|---|
|
以下のコードは、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("EXCLUDEUSERFROMGROUP");
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 = “EXCLUDEUSERFROMGROUP” | 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サービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
...
| Expand |
|---|
|
以下のコードは、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サービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
...
| Expand |
|---|
|
デフォルト組織への追加以下のコードは、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.setDefaultOrg(true);
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("ADDUSERACCESS");
rsr.setPerson(person);
rsr.setClient(aco);
rs = AdministrationService.remoteAdministrationCall(rsr); |
こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 こちらの関数は、Yellowfinの指定されたユーザーに対して指定されたクライアント組織へのアクセス権を追加します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “ADDUSERACCESS” | String | Webサービス関数です。 | OrgRef | String | こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。 | Client | AdministrationClientOrg | 取得プロセスに関するYellowfinクライアント組織のクライアント参照IDを保持する「AdministrationClientOrg」オブジェクトです。 |
「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
クライアント組織への追加以下のコードは、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);
|
こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 こちらの関数は、Yellowfinの指定されたユーザーに対して指定されたクライアント組織へのアクセス権を追加します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “ADDUSERACCESS” | String | Webサービス関数です。 | OrgRef | String | こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照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サービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
| Expand |
|---|
|
デフォルト組織からの削除以下のコードは、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.setDefaultOrg(false);
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("REMOVEUSERACCESS");
rsr.setPerson(person);
rsr.setClient(aco);
rs = AdministrationService.remoteAdministrationCall(rsr); |
こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 こちらの関数は、Yellowfinの指定されたユーザーに対して、指定されたクライアント組織へのアクセス権を削除します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “REMOVEUSERACCESS” | String | Webサービス関数です。 | OrgRef | String | こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。 | Client | AdministrationClientOrg | 取得プロセスに関するYellowfinクライアント組織のクライアント参照IDを保持する「AdministrationClientOrg」オブジェクトです。 |
「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
クライアント組織からの削除以下のコードは、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);
|
こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 こちらの関数は、Yellowfinの指定されたユーザーに対して、指定されたクライアント組織へのアクセス権を削除します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “REMOVEUSERACCESS” | String | Webサービス関数です。 | OrgRef | String | こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照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サービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
...