注意:こちらに掲載されているすべてのコードは、「疑似コード」です。実際に使用するコードは、ユーザーの使用環境により異なります。こちらの例は、あくまで参照目的でご利用ください。
シングルサインオン
Expand |
---|
title | LOGINUSER(シングルサインオン) |
---|
|
このサービスは、Yellowfinに接続し、指定されたユーザーのログオントークンを取得します。このトークンがYellowfinログオンURLに渡されると、認証されるユーザーのログイン画面が無効化され、そのユーザーのセッションがただちに開始されます。 Code Block |
---|
AdministrationServiceResponse rs = null;
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(new Integer(1));
rsr.setFunction("LOGINUSER");
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au");
ap.setPassword("test");
rsr.setPerson(ap);
rs = rssbs.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("Success");
out.write("URL: http://<yellowfin-server>/logon.i4?LoginWebserviceId=" + rs.getLoginSessionId());
} else {
out.write("Failure");
}
|
LOGINUSER関数は、指定されたユーザーをYellowfinにシングルサインオンさせます。AdministrationPersonオブジェクトの内容は、ログインしているユーザーを定義するために使用されます。「LOGINUSER」関数は、指定されたユーザーをYellowfinにシングルサインオンさせます。「AdministrationPerson」オブジェクトの内容は、ログインしているユーザーを定義するために使用されます。 リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID(admin@yellowfinWebサービスへの接続に使用されるアカウントのログインIDです(例:admin@yellowfin.com.auなど)。au)。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | IntegerYellowfin内のデフォルト組織ID。常に1に設定します。 | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “LOGINUSER” | | Webサービス関数。Webサービス関数です。 | Person | AdministrationPersonユーザー作成プロセスに関する新規ユーザーの詳細すべてを保持するAdministrationPersonオブジェクト。 | ユーザー作成プロセスに関する新規ユーザー詳細のすべてを保持する、「AdministrationPerson」オブジェクトです。 | OrgRef | String | クライアント組織の内部参照ID(オプション)。ユーザーを指定されたクライアント組織にログインさせます。設定しない場合は、ユーザーのログオン時に「クライアント組織の選択」ページが表示されます。 |
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。クライアント組織の内部参照IDです(こちらの設定は、オプションです)。ユーザーを、指定されたクライアント組織にログインさせます。こちらを設定しない場合、ユーザーのログオン時に「クライアント組織の選択」ページが表示されます。 |
「AdministrationPerson」オブジェクトで設定が必要なパラメーターは、以下の通りです。 AdministrationPerson要素 | データ型 | 説明 | UserId | String | ログインするユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。ログインするユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 | Password | String | 新規ユーザーのパスワード。新規ユーザーのパスワードです。 |
返される応答には、以下のパラメーターが含まれます。 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | LoginSessionId | String | 一意のログイントークン。このトークンはログインURLに付加され、ユーザーをYellowfinに直接移動させます。一意のログイントークンです。このトークンは、ログインURLに付加され、ユーザーをYellowfinに直接移動させます。 |
ログイントークンを使用したYellowfinへのリダイレクトWebサービス呼び出しから受信したトークン(AdministrationResponse.LoginSessionIdの内容)を使用して、ユーザーを以下のURLに転送できます:LoginSessionIdのコンテンツ)を使用して、ユーザーを以下のURLに転送することができます。 http://<YELLOWFIN-SERVER>/logon.i4?LoginWebserviceId=<TOKEN>
このURLを使用することにより、Yellowfinの認証画面がバイパスされ、ユーザーはYellowfinに直接移動します。トークンには有効期限があります。5分以内に使用する必要があり、いったん使用すると再利用はできません。その後、サードパーティのアプリケーションからYellowfinに呼び出しを行うときは、LOGINUSER Webサービスを再度呼び出す必要があります。トークンには有効期限があります。5分以内に使用する必要があり、一旦使用すると再利用はできません。サードパーティアプリケーションから、Yellowfinに呼び出しを行う場合は、LOGINUSER Webサービスを、再度呼び出す必要があります。 JavaScript APIでのトークンの使用埋め込みJavaScript APIウィジェットでSSO(シングルサインオン)トークンを使用することもできます。トークンは、次のようにスクリプトレットURLに追加されます:APIウィジェットで、SSO(シングルサインオン)トークンを使用することもできます。トークンは、以下のように、スクリプトレットURLに追加されます。 <script type="text/javascript" src="http://localhost/JsAPI?dashUUID=e9a6ab0a-bcb0-4fe6-9663-4dd33e58f08e&token=<TOKEN>"></script>
セッションオプションの指定このシングルサインオンリクエストを介して作成されるセッションに対してのみ機能を切り替える変数このシングルサインオンリクエストを介して作成されるセッションに対してのみ機能を切り替える、変数/スイッチを渡すことができます。このようなオプションを有効にするには、AdministrationRequestでParameters属性を使用して渡すか、またはリダイレクトURLに付加します。パラメーターは、以下のようにキー値ペアのリストとしてAdministrationRequest.Parameters属性に追加されます:スイッチを渡すことができます。このようなオプションを有効にするには、「AdministrationRequest」でParameters属性を使用して渡すか、リダイレクトURLに付加します。 パラメーターは、以下のようにキー値ペアの一覧として、「AdministrationRequest.Parameters」属性に追加されます。 YFTOOLBAR=TRUE
ENTRY=DASHBOARD
ログインURLで渡されるオプションは次のようになります:ログインURLで渡されるオプションは、以下のようになります。 http://<yellowfin-server>/logon.i4?LoginWebserviceId=<token>&yftoolbar=true&entry=DASHBOARD
使用可能なオプションの一覧を以下に示します:使用可能なオプション一覧は、以下の通りです。 パラメーターオプションキー | URLオプションキー | 説明 | YFTOOLBAR | yftoolbar | 「TRUE /」、または「 FALSE」に設定します 。このセッションのYellowfinツールバーを隠します。
| ENTRY | entry | ログインプロセスを完了するためのユーザーの唯一の起点を指定します。ほかのパラメーターとともに使用して、ユーザーに表示される内容を指定します。可能な値:ログインプロセス完了時の、ユーザーの唯一のエントリーポイントを指定します。他のパラメーターとともに使用することで、ユーザーに表示される内容を指定します。値の選択肢は、以下の通りです。 DASHBOARD REPORTLIST BROWSE BROWSETAB CREATEREPORT EDITREPORT VIEWREPORT ADMINISTRATION EDITDASHBOARD VIEWDASHBOARD VIEWSTORYBOARD TIMELINE
| REPORTID | reportid | 「ENTRY = EDITREPORT または」、 または「VIEWREPORT」 とともに使用します。これは、リダイレクト先レポートの内部IDです。
| REPORTUUID | reportuuid | 「ENTRY = EDITREPORT または」、 または「VIEWREPORT」 とともに使用します。これは、リダイレクト先レポートのUUIDです。
| STORYBOARDUUID | storyboarduuid | 「ENTRY = VIEWSTORYBOARD」 とともに使用します。これは、リダイレクト先ストーリーボードのUUIDです。
| MOBILEDEVICE | mobiledevice | 「TRUE /」、または「 FALSE 。ユーザーをYellowfinインターフェースのモバイルバージョンに移動させます。」に設定します 。ユーザーを、Yellowfinインターフェースのモバイルバージョンに移動させます。
| REPORTNAME | reportname | 「ENTRY = EDITREPORT または」、 または「VIEWREPORT」 とともに使用します。これは、リダイレクト先レポートの名前です。
| DISABLESOURCEFILTERS | | 「TRUE /」、または「 FALSE 。このセッションにおけるこのユーザーのソースフィルターまたはクライアント参照フィルターを無効化します。こうすると、ユーザーはすべてのデータを表示できます。クライアントソースに基づくコンテンツには効果がありません。」に設定します 。このセッションにおける、このユーザーのソースフィルター、またはクライアント参照フィルターを無効化します。これにより、ユーザーはすべてのデータを参照することができます。クライアントソースの置換に基づくコンテンツには、機能しません。
| DISABLEHEADER | disableheader | 「TRUE /」、または「 FALSE」に設定します 。このセッションのYellowfinヘッダーを隠します。
| HIDEHEADER | hideheader | 「DISABLEHEADER と同じです。」 と同様です。
| DISABLEFOOTER | disablefooter | 「TRUE /」、または「 FALSE」に設定します 。このセッションのYellowfinフッターを隠します。
| HIDEFOOTER | hidefooter | 「DISABLEFOOTER と同じです。」 と同様です。
| DISABLESIDENAV | disablesidenav | 「TRUE /」、または「 FALSE 。このセッションのYellowfin側のナビゲーションを隠します。」に設定します 。このセッションのYellowfinサイドナビゲーションを隠します。
| HIDESIDENAV | hidesidenav | 「DISABLESIDENAV と同じです。」 と同様です。
| DISABLELOGOFF | disablelogoff | 「TRUE /」、または「 FALSE」に設定します 。このセッションのYellowfinログオフリンクを隠します。
| HIDELOGOFF | hidelogoff | 「DISABLELOGOFF と同じです。」 と同様です。
| REASONCODE | reasoncode | このセッションで生成されるすべてのイベントに記録されるカスタム文字列(80文字のASCII文字)。イベントは、Yellowfinデータベースのイベントテーブルに記録されます。このセッションで生成されるすべてのイベントに記録されるカスタム文字列(80文字のASCII文字)です。イベントは、Yellowfinデータベースのイベントテーブルに記録されます。 このオプションは、JavaScript APIで使用することもできます。 | REASONDESCRIPTION | reasondescription | このセッションで生成されるすべてのイベントに記録されるカスタム文字列(2048文字のASCII文字)。イベントは、Yellowfinデータベースのイベントテーブルに記録されます。このセッションで生成されるすべてのイベントに記録されるカスタム文字列(2048文字のASCII文字)です。イベントは、Yellowfinデータベースのイベントテーブルに記録されます。 このオプションは、JavaScript APIで使用することもできます。 | DASHBOARDID | dashboardid | 「ENTRY = EDITDASHBOARD または」、 または「VIEWDASHBOARD」 とともに使用します。これは、リダイレクト先ダッシュボードタブの内部IDです。
| DASHBOARDUUID | dashboarduuid | 「ENTRY = EDITDASHBOARD または」、 または「VIEWDASHBOARD」 とともに使用します。これは、リダイレクト先ダッシュボードタブの内部IDです。
| FILTER<ID> | filter<ID> | 「ENTRY = VIEWREPORT とともに使用します。指定されたレポートのフィルター値を上書きします。FILTERにはフィルターの内部IDを付加し、その後にフィルター値の文字列表現が続きます。例:」 とともに使用します。指定されたレポートのフィルター値を上書きします。「FILTER」にはフィルターの内部IDを付加し、その後にフィルター値の文字列表現が続きます。例:
FILTER2134=MALE 1つのレポートで複数のフィルターを渡すことができます。ひとつのレポートで、複数のフィルターを渡すことができます。
| SOURCEFILTER_<FILTERCODE> | | このセッションのこのユーザーのソースフィルター値を上書きします。このセッションの、このユーザーのソースフィルター値を上書きします。
「SOURCEFILTER_ には「ソースフィルター」設定ページの「フィルタータイプコード」を付加し、その後にアクセスできるようにする値を続けます。例:」 には、「ソースフィルター」設定ページの「フィルタータイプコード」を付加し、その後にアクセスできるようにする値を続けます。例:
SOURCEFILTER_COUNTRY=AU 1つのセッションで複数のソースフィルター値を渡すことができます。ひとつのセッションで、複数のソースフィルター値を渡すことができます。 このオプションは、JavaScript こちらのオプションは、JavaScript APIで使用することもできます。 | CONTENT_<INCLUDE/EXCLUDE> | | このセッションでユーザーが持つコンテンツアクセス権を上書きします。このセッションで、ユーザーが持つコンテンツアクセス権を上書きします。「CONTENT_ には」 には、「INCLUDE または」、 または「EXCLUDE を付加します。このキーの値は、コンテンツカテゴリーコードまたはコンテンツカテゴリーUUIDです。」 を付加します。このキーの値は、コンテンツフォルダーコードまたはコンテンツフォルダーUUIDです。 コンテンツの組み入れ(「INCLUDE )を選択した場合、これらはユーザーがアクセスできるようにするコンテンツカテゴリーのみになります。」 を選択した場合、これらは、ユーザーがアクセスできる唯一のコンテンツフォルダーになります。 コンテンツの除外(「EXCLUDE )を選択した場合、これらの除外コンテンツカテゴリーは、ユーザーが通常アクセスできるコンテンツから削除されます。 コンテンツの組み入れおよび除外は、カテゴリーレベルに基づきます。指定したカテゴリーのすべてのサブカテゴリーが組み入れまたは除外されます。 カテゴリーのコードおよびUUIDを使用した組み入れ/除外の例:」 を選択した場合、これらの除外されたコンテンツフォルダーは、ユーザーが通常アクセスできるコンテンツから削除されます。 コンテンツの「INCLUDE」、および「EXCLUDE」は、フォルダーレベルに基づきます。指定したフォルダーのすべてのフォルダーが「INCLUDE」、または「EXCLUDE」されます。 フォルダーのコード、およびUUIDを使用した「INCLUDE」、または「EXCLUDE」の例:
CONTENT_INCLUDE=TUTORIAL
CONTENT_INCLUDE=c83357db-8aef-4ec7-ab72-fce34de9ee77
CONTENT_EXCLUDE=TUTORIAL
CONTENT_EXCLUDE=c83357db-8aef-4ec7-ab72-fce34de9ee77 同じセッションで同じセッションで、「INCLUDE と」 と「EXCLUDE」 の両方を使用することは論理的ではありません。 このオプションは、JavaScript APIで使用することもできます。 |
|
Expand |
---|
title | LOGINUSERNOPASSWORD(シングルサインオン) |
---|
|
このサービスは、このサービスは、「LOGINUSER と完全に互換がありますが、ログインするユーザーのパスワードが必要ありません。」 と完全に互換がありますが、ログインするユーザーにパスワードは必要ありません。 オプションはオプションは「LOGINUSER と同じですが、以下の点が異なります:」 と同様ですが、以下の点が異なります。 - 「AdministrationRequest.FunctionはFunction」は、「
LOGINUSERNOPASSWORD に設定されます」 に設定されます。 - 「AdministrationPerson.Passwordは空にできますPassword」は、空欄にすることができます。
この機能を有効にするには、Yellowfinデータベースの設定テーブルに追加のパラメーターを追加する必要があります:この機能を有効にするためには、Yellowfinデータベースの構成テーブルに、追加のパラメーターを追加する必要があります。 IpOrg | ConfigTypeCode | ConfigCode | ConfigData | 1 | SYSTEM | SIMPLE_AUTHENTICATION | TRUE |
データベースの変更を有効にするために、Yellowfinの再起動が必要になることがあります。 この設定オプションがYellowfinに追加されていない場合は、Webサービスエラーこちらの設定オプションがYellowfinに追加されていない場合、「Webサービスエラー26: UNSECURE_LOGIN_NOT_ENABLED」 が発生します。 |
ユーザーの複製および管理
ユーザーの複製とは、OEMアプリケーション内の各ユーザーをYellowfinのユーザーに同期させることを指します。ユーザーの複製とは、OEMアプリケーション内の各ユーザーを、Yellowfinユーザーに同期させることを指します。
これにより、Yellowfinでは、ログインしているユーザーを識別し、必要となる制限がある場合はその制限を適用することができます。通常、同期はOEMアプリケーションからYellowfinへのWebサービス呼び出しを使用して行われます。これは、OEMアプリケーションのユーザーが概して静的である場合には、手動で管理することもできます。これにより、Yellowfinでは、ログインしているユーザーを識別し、必要に応じて、制限を適用することができます。同期は通常、OEMアプリケーションからYellowfinへのWebサービス呼び出しを使用して行われます。これは、OEMアプリケーションのユーザーが静的である場合、手動で管理することもできます。
このセクションでは、Webサービスを介したユーザーの作成、操作、および削除方法の概要について説明します。OEMアプリケーションでユーザーの変更が行われるとすぐに、Webサービスが呼び出されてユーザーの変更がミラーリングされることが想定されています。こちらのセクションでは、Webサービスを介したユーザーの作成、操作、および削除方法について説明します。OEMアプリケーションでユーザーの変更が行われるとすぐに、Webサービスが呼び出されてユーザーの変更がミラーリングされることが想定されています。
関数
Expand |
---|
|
以下のコードは、ユーザーを作成するためのYellowfin Webサービスを呼び出します。 Code Block |
---|
AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();
person.setUserId("test@yellowfin.com.au");
person.setPassword("test");
person.setFirstName("Simple");
person.setLastName("Simon");
person.setInitial("S");
person.setSalutationCode("MR");
person.setRoleCode("YFADMIN");
person.setEmailAddress("test@yellowfin.com.au");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
rsr.setFunction("ADDUSER");
rsr.setPerson(person);
rs = AdministrationService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("Success");
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
}
|
このコードはこのコードは「rs.getStatusCode() で」 で、「SUCCESS」 を返します。それ以外の場合は、ユーザー作成プロセスが失敗した理由を説明するエラーメッセージを返します。 この関数はYellowfinにユーザーを作成します。AdministrationPersonオブジェクト内の詳細がユーザー作成プロセスで使用されます。こちらの関数は、Yellowfinにユーザーを作成します。「AdministrationPerson」オブジェクト内の詳細が、ユーザー作成プロセスで使用されます。 リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID(admin@yellowfinWebサービスへの接続に使用されるアカウントのログインIDです(例:admin@yellowfin.com.auなど)。au)。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | IntegerYellowfin内のデフォルト組織ID。常に1に設定します。 | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “ADDUSER” | | Webサービス関数。Webサービス関数です。 | Person | AdministrationPerson | ユーザー作成プロセスに関する新規ユーザーの詳細すべてを保持するAdministrationPersonオブジェクト。 |
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。 AdministrationPerson要素ユーザー作成プロセスに関する新規ユーザー詳細のすべてを保持する、「AdministrationPerson」オブジェクトです。 |
「AdministrationPerson」オブジェクトで設定が必要なパラメーターは、以下の通りです。 AdministrationPerson 要素 | データ型 | 説明 | UserId | String | 新規ユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。新規ユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 | Password | String | 新規ユーザーのパスワード。新規ユーザーのパスワードです。 | FirstName | String | 新規ユーザーの名。新規ユーザーの名です。 | LastName | String | 新規ユーザーの姓。新規ユーザーの姓です。 | Initial | String | 新規ユーザーのミドルネーム。新規ユーザーのミドルネームです。 | SalutationCode | String | 新規ユーザーの敬称。可能な値は以下の通りです。新規ユーザーの敬称です。値の選択肢、は以下の通りです。 | RoleCode | StringYellowfinのロール。ここで指定するロールは、参照コード(YFADMIN)またはロール(Yellowfin管理者)の名前にすることができます。 | Yellowfinのロールです。こちらで指定するロールは、「参照コード(YFADMIN)」、または「ロール(Yellowfin管理者)」の名前にすることができます。 | EmailAddress | String | 新規ユーザーの電子メールアドレス。新規ユーザーの電子メールアドレスです。 |
返される応答には、以下のパラメーターが含まれます。 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
Expand |
---|
title | DELUSER / DELETEUSER |
---|
|
以下のコードは、ユーザーを削除するためのYellowfin Webサービスを呼び出します。 Code Block |
---|
AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();
person.setUserId("test@yellowfin.com.au");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
rsr.setFunction("DELUSER");
rsr.setPerson(person);
rs = AdministrationService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("Success");
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
}
|
このコードはこのコードは「rs.getStatusCode() で」 で、「SUCCESS」 を返します。それ以外の場合は、ユーザー削除プロセスが失敗した理由を説明するエラーメッセージを返します。 この関数はYellowfinからユーザーを削除します。AdministrationPersonオブジェクト内の詳細がユーザー削除プロセスで使用されます。この関数は、Yellowfinからユーザーを削除します。「AdministrationPerson」オブジェクト内の詳細が、ユーザー削除プロセスで使用されます。 リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID(admin@yellowfinWebサービスへの接続に使用されるアカウントのログインIDです(例:admin@yellowfin.com.auなど)。au)。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | IntegerYellowfin内のデフォルト組織ID。常に1に設定します。 | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “DELUSER”または“DELETEUSER”“DELUSER”、または“DELETEUSER” | | Webサービス関数。Webサービス関数です。 | Person | AdministrationPerson | ユーザー削除プロセスに関するユーザーの詳細すべてを保持するAdministrationPersonオブジェクト。 |
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。ユーザー削除プロセスに関するユーザー詳細のすべてを保持する、「AdministrationPerso」オブジェクトです。 |
「AdministrationPerson」オブジェクトで設定が必要なパラメーターは、以下の通りです。 AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
ユーザー情報の取得およびテスト
作成されたユーザーの詳細は、Webサービス呼び出しを使用して取得することができます。AdministrationPersonオブジェクトのUserIdフィールドは、ユーザーを識別するために使用されます。結果として、投入されたAdministrationPersonオブジェクトが返されます。セキュリティ上の理由から、パスワードは返されず、NULL
となります。また、このセクションでは、ユーザー情報をアプリケーションに照らし合わせてテストすることもできます。作成されたユーザーの詳細は、Webサービス呼び出しを使用して取得することができます。「AdministrationPerson」オブジェクトのUser IDフィールドは、ユーザーを識別するために使用されます。結果として、投入された「AdministrationPerson」オブジェクトが返されます。セキュリティ上の理由から、パスワードは返されず、「NULL」
となります。また、こちらのセクションでは、ユーザー情報をアプリケーションに照らし合わせてテストすることもできます。
Expand |
---|
|
以下のコードは、ユーザーの詳細を取得するためのYellowfin 以下のコードは、ユーザー詳細を取得するための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));
rsr.setFunction("GETUSER");
rsr.setPerson(person);
rs = AdministrationService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("Success");
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
}
|
このコードはユーザー詳細を含むAdministrationPersonオブジェクトを返し、こちらのコードは、ユーザー詳細を含む「AdministrationPerson」オブジェクトを返し、「rs.getStatusCode() で」 で、「SUCCESS」 を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。 この関数はYellowfinの特定ユーザーの詳細を取得します。AdministrationPersonオブジェクト内の詳細が取得プロセスで使用されます。この関数は、Yellowfinの特定ユーザー詳細を取得します。「AdministrationPerson」オブジェクト内の詳細が取得プロセスで使用されます。 リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID(admin@yellowfinWebサービスへの接続に使用されるアカウントのログインIDです(例:admin@yellowfin.com.auなど)。au)。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | IntegerYellowfin内のデフォルト組織ID。常に1に設定します。 | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “GETUSER” | | Webサービス関数。Webサービス関数です。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。 |
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。取得プロセスに関するYellowfinユーザーのユーザーIDを保持する、「AdministrationPerson」オブジェクトです。 |
「AdministrationPerson」オブジェクトで設定が必要なパラメーターは、以下の通りです。 AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | Person | AdministrationPerson返されたユーザーの詳細すべてを保持するAdministrationPersonオブジェクト。 | 返されたユーザー詳細のすべてを保持する、「AdministrationPerson」オブジェクトです。 |
|
Expand |
---|
|
以下のコードは、内部IpIdを介してユーザーの詳細を取得するためのYellowfin 以下のコードは、内部IpIdを介してユーザー詳細を取得するための、Yellowfin Webサービスを呼び出します。 Code Block |
---|
AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();
Person.setIpId(5);
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
rsr.setFunction("GETUSERBYIP");
rsr.setPerson(person);
rs = AdministrationService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("Success");
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
}
|
このコードはユーザー詳細を含むAdministrationPersonオブジェクトを返し、こちらのコードは、ユーザー詳細を含む「AdministrationPerson」オブジェクトを返し、「rs.getStatusCode() で」 で、「SUCCESS」 を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。 この関数はYellowfinの特定ユーザーのIP IDを検索し、そのユーザーの詳細を取得します。AdministrationPersonオブジェクト内の詳細が取得プロセスで使用されます。この関数は、Yellowfinの特定ユーザーのIP IDを検索し、そのユーザーの詳細を取得します。「AdministrationPerson」オブジェクト内の詳細が取得プロセスで使用されます。 リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID(admin@yellowfinWebサービスへの接続に使用されるアカウントのログインIDです(例:admin@yellowfin.com.auなど)。au)。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | IntegerYellowfin内のデフォルト組織ID。常に1に設定します。 | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “GETUSERBYIP” | | Webサービス関数。Webサービス関数です。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。 |
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。取得プロセスに関するYellowfinユーザーのユーザーIDを保持する、「AdministrationPerson」オブジェクトです。 |
「AdministrationPerson」オブジェクトで設定が必要なパラメーターは、以下の通りです。 AdministrationPerson要素 | データ型 | 説明 | IP ID |
| | Integer| | YellowfinユーザーのIP ID |
|返される応答には、以下のパラメーターが含まれます。 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | Person | AdministrationPerson返されたユーザーの詳細すべてを保持するAdministrationPersonオブジェクト。 | 返されたユーザー詳細のすべてを保持する、「AdministrationPerson」オブジェクトです。 |
|
Expand |
---|
|
この関数は、特定の検索文字列に基づいて、Yellowfinからユーザーを取得します。この文字列がユーザーの名、姓、および電子メールアドレスと比較されます。 リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID(admin@yellowfinWebサービスへの接続に使用されるアカウントのログインIDです(例:admin@yellowfin.com.auなど)。au)。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | IntegerYellowfin内のデフォルト組織ID。常に1に設定します。 | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “GETUSERSFROMSEARCH” | | Webサービス関数。Webサービス関数です。 | Parameters | Array(String) | Yellowfinユーザーの名、姓、および電子メールアドレスと照合する検索文字列。Yellowfinユーザーの名、姓、および電子メールアドレスと照合する検索文字列です。 |
返される応答には、以下のパラメーターが含まれます。 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | People | Array(AdministrationPerson)AdministrationPersonオブジェクトの配列。これらのオブジェクトには、検索文字列に一致した、返されたユーザーの詳細が保持されます。 | 「AdministrationPerson」オブジェクトの配列です。これらのオブジェクトには、検索文字列に一致した、返されたユーザーの詳細が保持されます。 |
|
Expand |
---|
|
以下のコードは、ユーザーをテストするためのYellowfin Webサービスを呼び出します。 Code Block |
---|
AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();
person.setUserId("admin@yellowfin.com.au");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setFunction("VALIDATEUSER");
rsr.setPerson(person);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
このコードは、成功すると特定ユーザーのAdministrationPersonオブジェクトを返します。それ以外の場合は、ユーザー検証プロセスが失敗した理由を説明するエラーメッセージを返します。こちらのコードは、成功すると、特定ユーザーの「AdministrationPerson」オブジェクトを返します。それ以外の場合は、ユーザー検証プロセスが失敗した理由を説明するエラーメッセージを返します。この関数は、指定されたYellowfinユーザーがアプリケーション内に現在存在するかどうかをチェックしてテストします。AdministrationPersonオブジェクト内の詳細がユーザー検証プロセスで使用されます。 こちらの関数は、指定されたYellowfinユーザーが、現在アプリケーション内に存在するかどうかを確認してテストします。「AdministrationPerson」オブジェクト内の詳細が、ユーザー検証プロセスで使用されます。 リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID(admin@yellowfinWebサービスへの接続に使用されるアカウントのログインIDです(例:admin@yellowfin.com.auなど)。au)。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “VALIDATEUSER” | | Webサービス関数。Webサービス関数です。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。 |
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。取得プロセスに関するYellowfinユーザーのユーザーIDを保持する、「AdministrationPerson」オブジェクトです。 |
「AdministrationPerson」オブジェクトで設定が必要なパラメーターは、以下の通りです。 AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | Person | AdministrationPerson返されたユーザーの詳細すべてを保持するAdministrationPersonオブジェクト。 | 返されたユーザーの詳細すべてを保持する、「AdministrationPerson」オブジェクトです。 |
|
Expand |
---|
|
以下のコードは、ユーザーのパスワードをテストするためのYellowfin Webサービスを呼び出します。 Code Block |
---|
AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();
person.setUserId("testuser@yellowfin.com.au");
person.setPassword("test");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
rsr.setFunction("VALIDATEPASSWORD");
rsr.setPerson(person);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
このコードは、パスワードの有効期限が切れているかどうかをチェックし、有効期限が切れていない場合にはこちらのコードは、パスワードの有効期限が切れているかどうかを確認し、有効期限が切れていない場合は、「rs.getStatusCode() で」 で、「FAILURE を返します。それ以外の場合は、」 を返します。それ以外の場合は、「SUCCESS」 を返します。 この関数はYellowfinユーザーのパスワードをテストします。AdministrationPersonオブジェクト内の詳細がパスワード検証プロセスで使用されます。こちらの関数は、Yellowfinユーザーのパスワードをテストします。「AdministrationPerson」オブジェクト内の詳細が、パスワード検証プロセスで使用されます。 リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID(admin@yellowfinWebサービスへの接続に使用されるアカウントのログインIDです(例:admin@yellowfin.com.auなど)。au)。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | IntegerYellowfin内のデフォルト組織ID。常に1に設定します。 | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “VALIDATEUSER” | | Webサービス関数。Webサービス関数です。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。 |
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。取得プロセスに関するYellowfinユーザーのユーザーIDを保持する、「AdministrationPerson」オブジェクトです。 |
「AdministrationPerson」オブジェクトで設定が必要なパラメーターは、以下の通りです。 AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 | Password | String | Yellowfinユーザーのパスワード。Yellowfinユーザーのパスワードです。 |
返される応答には、以下のパラメーターが含まれます。 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
ユーザー情報の操作
ユーザーの詳細は、Webサービス呼び出しを使用してあとから変更することができます。AdministrationPersonオブジェクトのUserIdフィールドは、ユーザーを識別するために使用されるため、変更することができません。AdministrationPersonオブジェクト内のその他のフィールドには、新しい変更内容が投入されます。セキュリティ上の理由から、このWebサービス呼び出しを使用してユーザーのパスワードを変更することはできませんが、個別のCHANGEPASSWORD関数(下記)を使用して変更することができます。
...
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サービス呼び出しのステータス。可能な値は以下の通りです。 |
|
...