...
| 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」オブジェクト内の詳細が、パスワード検証プロセスで使用されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “VALIDATEUSER” | | Webサービス関数です。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持する、「AdministrationPerson」オブジェクトです。 |
「AdministrationPerson」オブジェクトで設定が必要なパラメーターは、以下の通りです。 | AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 | Password | String | Yellowfinユーザーのパスワードです。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
ユーザー情報の操作
ユーザーの詳細は、Webサービス呼び出しを使用してあとから変更することができます。AdministrationPersonオブジェクトのUserIdフィールドは、ユーザーを識別するために使用されるため、変更することができません。AdministrationPersonオブジェクト内のその他のフィールドには、新しい変更内容が投入されます。セキュリティ上の理由から、このWebサービス呼び出しを使用してユーザーのパスワードを変更することはできませんが、個別のCHANGEPASSWORD関数（下記）を使用して変更することができます。ユーザーの詳細は、Webサービスの呼び出しを使用して、後から変更することができます。「AdministrationPerson」オブジェクトの「User ID」フィールドは、ユーザーを識別するために使用されるため、変更することができません。「AdministrationPerson」オブジェクト内のその他のフィールドには、新しい変更内容が投入されます。セキュリティ上の理由から、このWebサービス呼び出しを使用してユーザーのパスワードを変更することはできませんが、個別の「CHANGEPASSWORD」関数（下記）を使用して変更することができます。
| Expand |
|---|
|
以下のコードは、ユーザーの詳細を編集するためのYellowfin Webサービスを呼び出します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();
person.setUserId("testuser");
person.setFirstName("John");
person.setLastName("Doe");
person.setInitial("F");
person.setSalutationCode("MR");
person.setRoleCode("YFADMIN");
person.setEmailAddress("testuser@yellowfin.com.au")
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
rsr.setFunction("UPDATEUSER");
rsr.setPerson(person);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
このコードはユーザー詳細を含む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 = “UPDATEUSER” | | Webサービス関数。Webサービス関数です。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。 |
取得プロセスに関するYellowfinユーザーのユーザーIDを保持する、「AdministrationPerson」オブジェクトです。 |
「AdministrationPerson」オブジェクトで設定できるパラメーターは、以下の通りです。 | AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 | Password | String | Yellowfinユーザーのパスワード。Yellowfinユーザーのパスワードです。 | FirstName | String | Yellowfinユーザーの名。Yellowfinユーザーの名です。 | LastName | String | Yellowfinユーザーの姓。Yellowfinユーザーの姓です。 | Initial | String | Yellowfinユーザーのミドルネーム。Yellowfinユーザーのミドルネームです。 | SalutationCode | String | Yellowfinユーザーの敬称。可能な値は以下の通りです。Yellowfinユーザーの敬称です。値の選択肢は、は以下の通りです。 | RoleCode | StringYellowfinのロール。ここで指定するロールは、参照コード（YFADMIN）またはロール（Yellowfin管理者）の名前にすることができます。 | Yellowfinのロールです。こちらで指定するロールは、「参照コード（YFADMIN）」、または「ロール（Yellowfin管理者）」の名前にすることができます。 | EmailAddress | String | Yellowfinユーザーの電子メールアドレス。Yellowfinユーザーの電子メールアドレスです。 | LanguageCode | String | 優先言語を表す2文字のコード。優先言語を表す2文字のコードです。 | IpId | Integer | 内部Yellowfin IP ID。IDです。 | TimeZoneCode | String | YellowfinユーザーのTimeZoneCode。有効な値については、付録を参照してください。YellowfinユーザーのTimeZoneCodeです。有効な値については、付録を参照してください。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | Person | AdministrationPerson更新されたユーザーの詳細すべてを保持するAdministrationPersonオブジェクト。 | 更新されたユーザーの詳細すべてを保持する「AdministrationPerson」オブジェクトです。 |
|
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、指定されたYellowfinユーザーのパスワードを変更します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();
person.setUserId("test@yellowfin.com.au");
person.setPassword("testtest");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
rsr.setFunction("CHANGEPASSWORD");
rsr.setPerson(person);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
このコードはこちらのコードは、「rs.getStatusCode()で」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 この関数は指定されたYellowfinユーザーのパスワードを変更します。こちらの関数は、指定された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 = “CHANGEPASSWORD” | | Webサービス関数。Webサービス関数です。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持する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サービス呼び出しを使用して、デフォルト組織またはクライアント組織内のユーザーに属するオブジェクトを取得することができます。応答で返されるオブジェクトは、リクエストで実行される呼び出しのタイプに依存します。様々なWebサービス呼び出しを使用して、デフォルト組織、またはクライアント組織内のユーザーに属するオブジェクトを取得することができます。応答で返されるオブジェクトは、リクエストで実行される呼び出しのタイプに依存します。
| Expand |
|---|
| title | GETUSERREPORTS / GETALLUSERREPORTS |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、特定ユーザーがアクセス可能なWebサービスを呼び出し、特定ユーザーがアクセス可能な「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("GETUSERREPORTS");
rsr.setPerson(person);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
このコードは、こちらのコードは、「rs.getReports()でAdministrationReportオブジェクトの配列を返し、」で「AdministrationReport」オブジェクトの配列を返し、「rs.getStatusCode()で」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。 この関数は、指定されたYellowfinユーザーがアクセス可能なこちらの関数は、指定されたYellowfinユーザーがアクセス可能な「Webサービス名を含むすべてのレポートを返します。」を含むすべてのレポートを返します。 | リクエスト要素 | データ型 | 説明 | 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 = “GETUSERREPORTS” | String | Webサービス関数。Webサービス関数です。 | OrgRef | String | この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。 |
取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクト。 |
「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | Reports | AdministrationReport | AdministrationReportオブジェクトの配列。これらのオブジェクトにはレポートメタデータが保持されます。 |
|
| Expand |
|---|
|
以下のコードは、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("GETALLUSERREPORTS");
rsr.setPerson(person);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
このコードは、こちらのコードは、「rs.getReports()でAdministrationReportオブジェクトの配列を返し、」で「AdministrationReport」オブジェクトの配列を返し、「rs.getStatusCode()で」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。 | リクエスト要素 | データ型 | 説明 | 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 = “GETUSERREPORTS” | String | Webサービス関数。Webサービス関数です。 | OrgRef | String | この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。 |
取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクト。 |
「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです | AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | Reports | AdministrationReportAdministrationReportオブジェクトの配列。これらのオブジェクトにはレポートメタデータが保持されます。 | 「AdministrationReport」オブジェクトの配列です。これらのオブジェクトには、レポートメタデータが保持されます。 |
|
| Expand |
|---|
| title | GETREPORTSWITHCOMMENTS |
|---|
|
以下のコードは、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("GETREPORTSWITHCOMMENTS");
rsr.setPerson(person);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
このコードは、こちらのコードは、「rs.getReports()でAdministrationReportオブジェクトの配列を返し、」で「AdministrationReport」オブジェクトの配列を返し、「rs.getStatusCode()で」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。 この関数は、指定されたYellowfinユーザーがアクセス可能なYellowfin内のコメントされたすべてのレポートを返します。こちらの関数は、指定されたYellowfinユーザーがアクセス可能な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 = “GETREPORTSWITHCOMMENTS” | String | Webサービス関数。Webサービス関数です。 | OrgRef | String | この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。 |
取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクト。 |
「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | Reports | AdministrationReportAdministrationReportオブジェクトの配列。これらのオブジェクトにはレポートメタデータが保持されます。 | 「AdministrationReport」オブジェクトの配列です。これらのオブジェクトには、レポートメタデータが保持されます。 |
|
| Expand |
|---|
| title | GETFAVOURITES / GETFAVORITES |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、特定ユーザーがアクセス可能なすべての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オブジェクトの配列を返し、」で「AdministrationReport」オブジェクトの配列を返し、「rs.getStatusCode()で」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。 この関数は、指定されたYellowfinユーザーのすべてのお気に入りのレポートを返します。こちらの関数は、指定された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 = “GETFAVOURITES”または“GETFAVORITES” | String | Webサービス関数。Webサービス関数です。 | OrgRef | String | この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。 |
取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。 |
「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | Reports | AdministrationReport | AdministrationReportオブジェクトの配列。これらのオブジェクトにはレポートメタデータが保持されます。「AdministrationReport」オブジェクトの配列です。これらのオブジェクトには、レポートメタデータが保持されます。 |
|
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、特定ユーザーの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);
|
このコードは、こちらのコードは、「rs.getReports()でAdministrationReportオブジェクトの配列を返し、」で「AdministrationReport」オブジェクトの配列を返し、「rs.getStatusCode()で」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。 この関数は、指定されたYellowfinユーザーの受信トレイ内にあるレポートを返します。こちらの関数は、指定された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 = “GETINBOX” | String | Webサービス関数。Webサービス関数です。 | OrgRef | String | この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。この関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。 |
取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。 |
「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | | Reports | AdministrationReportAdministrationReportオブジェクトの配列。これらのオブジェクトにはレポートメタデータが保持されます。 | 「AdministrationReport」オブジェクトの配列です。これらのオブジェクトには、レポートメタデータが保持されます。 |
|
| Expand |
|---|
|
以下のコードは、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);
|
このコードは、こちらのコードは、「rs.getReportGroups()でAdministrationReportGroupオブジェクトの配列を返し、」で「AdministrationReportGroup」オブジェクトの配列を返し、「rs.getStatusCode()で」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 この関数は、指定されたYellowfinユーザーがアクセス可能なダッシュボードタブの一覧を返します。こちらの関数は、指定された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 = “GETUSERTABS” | String | Webサービス関数。Webサービス関数です。 | OrgRef | String | この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。この関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。 |
取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。 |
「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | ReportsGroups | AdministrationReportGroup | AdministrationReportGroupオブジェクトの配列。これらのオブジェクトにはダッシュボードメタデータが保持されます。「AdministrationReportGroup」オブジェクトの配列です。これらのオブジェクトには、ダッシュボードメタデータが保持されます。 |
|
| Expand |
|---|
| title | GETUSERTABSWITHREPORTS |
|---|
|
以下のコードは、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);
|
このコードは、こちらのコードは、「rs.getReportGroups()でAdministrationReportGroupオブジェクトの配列を返し、」で「AdministrationReportGroup」オブジェクトの配列を返し、「rs.getStatusCode()で」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 この関数は、指定されたYellowfinユーザーがアクセス可能なダッシュボードタブの一覧を返します。このとき、レポートのメタデータも同時にロードされます。ダッシュボードタブのすべてのレポートのメタデータは、AdministrationReportGroupオブジェクト内に含まれます。こちらの関数は、指定されたYellowfinユーザーがアクセス可能なダッシュボードタブの一覧を返します。このとき、レポートのメタデータも同時にロードされます。ダッシュボードタブのすべてのレポートのメタデータは、「AdministrationReportGroup」オブジェクト内に含まれます。 | リクエスト要素 | データ型 | 説明 | 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 = “GETUSERTABSWITHREPORTS” | String | Webサービス関数。Webサービス関数です。 | OrgRef | String | この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。この関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。 |
取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。 |
「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | ReportsGroups | AdministrationReportGroup | AdministrationReportGroupオブジェクトの配列。これらのオブジェクトにはダッシュボードメタデータが保持されます。この特定の関数では、レポートのメタデータもこのオブジェクトのGroupReports「AdministrationReportGroup」オブジェクトの配列です。これらのオブジェクトには、ダッシュボードメタデータが保持されます。この特定の関数では、レポートのメタデータも、このオブジェクトの「GroupReports()パラメーターにロードされます。」パラメーターにロードされます。 |
|
| Expand |
|---|
|
この関数は、指定されたダッシュボードタブ内に含まれるレポートの一覧を返します。このレポートには、Yellowfinの指定されたユーザーがアクセスすることができます。こちらの関数は、指定されたダッシュボードタブ内に含まれるレポートの一覧を返します。このレポートには、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 = “LOADTABREPORTS” | String | Webサービス関数。Webサービス関数です。 | Person | AdministrationPerson取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。 | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。 | ReportGroup | AdministrationReportGroup | 取得プロセスに関するダッシュボードタブIDを保持するAdministrationReportGroupオブジェクト。 |
取得プロセスに関するダッシュボードタブIDを保持する「AdministrationReportGroup」オブジェクトです。 |
「AdministrationPerson」、および「AdministrationReportGroup」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
| AdministrationReportGroup要素 | データ型 | 説明 | ReportGroupId | String | ダッシュボードタブIDダッシュボードタブIDです。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | ReportGroups | AdministrationReportGroup | AdministrationReportGroupオブジェクトの配列。これらのオブジェクトにはダッシュボードメタデータが保持されます。この特定の関数では、レポートのメタデータもこのオブジェクトのGroupReports「AdministrationReportGroup」オブジェクトの配列です。これらのオブジェクトには、ダッシュボードメタデータが保持されます。この特定の関数では、レポートのメタデータも、このオブジェクトの「GroupReports()パラメーターにロードされます。」パラメーターにロードされます。 |
|
...
グループとロールの管理
Webサービス呼び出しを使用して、グループとロールを作成および変更することができます。応答で返されるオブジェクトは、リクエストで実行される呼び出しのタイプに依存します。Webサービス呼び出しを使用して、グループとロールの作成や変更をすることができます。応答で返されるオブジェクトは、リクエストで実行される呼び出しのタイプに依存します。
注意：クライアント組織機能を「システム設定」ページでオンにしている場合、特定のタイプの呼び出しについて適用可能な場合はクライアント組織を指定することもできます。システム構成ページで、クライアント組織機能を有効化している場合、特定のタイプの呼び出しについて適用可能な場合は、クライアント組織を指定することもできます。
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内で使用可能なすべてのロールを返します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
rsr.setOrgId(new Integer(1));
rsr.setFunction("LISTROLES");
rs = AdministrationService.remoteAdministrationCall(rsr);
|
このコードは、こちらのコードは、「rs.getRoles()でAdministrationRoleオブジェクトの配列を返し、」で「AdministrationRole」オブジェクトの配列を返し、「rs.getStatusCode()で」で「SUCCESS」を返します。 この関数は、Yellowfin内で使用可能なすべてのロールを返します。こちらの関数は、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 = “LISTROLES” | String | Webサービス関数。Webサービス関数です。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | ロールRole | AdministrationRoleAdministrationRoleオブジェクトの配列。これらのオブジェクトにはYellowfinロールのメタデータが保持されます。 | 「AdministrationRole」オブジェクトの配列です。これらのオブジェクトには、Yellowfinロールのメタデータが保持されます。 |
|
| Expand |
|---|
|
以下コードは、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);
|
このコードは、こちらのコードは、「rs.getGroups()でAdministrationGroupオブジェクトの配列を返し、」で「AdministrationGroup」オブジェクトの配列を返し、「rs.getStatusCode()で」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 この関数は、Yellowfin内で使用可能なすべてのユーザーグループを返します。こちらの関数は、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 = “LISTGROUPS” | String | Webサービス関数。Webサービス関数です。 | OrgRef | String | この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | グループGroups | AdministrationGroupAdministrationGroupオブジェクトの配列。これらのオブジェクトにはYellowfinユーザーグループのメタデータが保持されます。 | 「AdministrationGroup」オブジェクトの配列です。これらのオブジェクトには、Yellowfinユーザーグループのメタデータが保持されます。 |
|
| Expand |
|---|
|
以下のコードは、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();
|
このコードは、こちらのコードは、「rs.getGroup()でAdministrationGroupオブジェクトを返し、」で「AdministrationGroup」オブジェクトを返し、「rs.getGroupMembers()でAdministrationGroupMembersの配列を返し、」で「AdministrationGroupMembers」の配列を返し、「rs.getStatusCode()で」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 この関数は、指定されたYellowfinグループおよびそのメンバーの一覧を返します。こちらの関数は、指定された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 = “GETGROUP” | String | Webサービス関数。Webサービス関数です。 | OrgRef | String | この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 | Group | AdministrationGroup | 取得プロセスに関するYellowfinユーザーグループの名前を保持するAdministrationGroupオブジェクト。 |
取得プロセスに関するYellowfinユーザーグループの名前を保持する「AdministrationGroup」オブジェクトです。 |
「AdministrationGroup」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationGroup要素 | データ型 | 説明 | GroupName | String | 指定したYellowfinグループの名前指定したYellowfinグループの名前です。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | Group | AdministrationGroup | グループメタデータを保持するAdministrationGroupオブジェクトの配列。グループメンバーもこのオブジェクトのGroupMembersグループメタデータを保持する「AdministrationGroup」オブジェクトの配列です。グループメンバーも、このオブジェクトの「GroupMembers()のパラメーターにロードされます。」のパラメーターにロードされます。 |
|
| 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配列は「AdministrationPerson」オブジェクトの「AdministrationGroupMember」配列に入力することによって、新規作成されたグループに、既存のYellowfinユーザーを同時に配置することもできます。各「AdministrationPerson」オブジェクトに必要なのは、LoginId変数セットのみであり、「AdministrationGroupMember」配列は、「group.setGroupMembers()」に保存されます。 この関数はYellowfinグループを作成します。この関数では、新規グループに既存のYellowfinユーザーを保存できる点にも注意してください。こちらの関数は、Yellowfinグループを作成します。こちらの関数では、新規グループに既存の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 = “CREATEGROUP” | String | Webサービス関数。Webサービス関数です。 | OrgRef | String | この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 | Group | AdministrationGroup | 取得プロセスに関するYellowfinユーザーグループの名前を保持するAdministrationGroupオブジェクト。 |
取得プロセスに関するYellowfinユーザーグループの名前を保持する「AdministrationGroup」オブジェクトです。 |
「AdministrationGroup」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationGroup要素 | データ型 | 説明 | GroupName | String | 指定したYellowfinグループの名前指定したYellowfinグループの名前です。 | GroupDescription | String | 指定したYellowfinグループの説明指定したYellowfinグループの説明です。 | GroupMembers | Array（AdministrationPerson）AdministrationPersonオブジェクトの配列。これはオプションのパラメーターで、既存のYellowfinユーザーをこのグループに保存するよう設定することができます。このシナリオの場合、AdministrationPersonオブジェクトに必要なのは、オブジェクトごとにそのUserIdパラメーターを設定することだけです。 | 「AdministrationPerson」オブジェクトの配列です。これはオプションのパラメーターで、既存のYellowfinユーザーを、このグループに保存するよう設定することができます。こちらのシナリオの場合、各「AdministrationPerson」オブジェクトに必要なのは、オブジェクトごとにそのUserIdパラメーターを設定することだけです。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
| Expand |
|---|
|
以下のコードは、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);
|
このコードはこちらのコードは、「rs.getStatusCode()で」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 この関数は、指定されたグループに指定されたYellowfinユーザーを含めます。こちらの関数は、指定されたグループに指定された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 = “INCLUDEUSERINGROUP” | String | Webサービス関数。Webサービス関数です。 | OrgRef | String | この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 | Group | AdministrationGroup取得プロセスに関するYellowfinユーザーグループの名前を保持するAdministrationGroupオブジェクト。 | 取得プロセスに関するYellowfinユーザーグループの名前を保持する「AdministrationGroup」オブジェクトです。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。 |
取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。 |
「AdministrationGroup」、および「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationGroup要素 | データ型 | 説明 | GroupName | String | 指定したYellowfinグループの名前指定したYellowfinグループの名前です。 |
| AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
| Expand |
|---|
| title | EXCLUDEUSERFROMGROUP |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたグループから指定されたユーザーを除外します。 注意：このユーザーはグループから削除されるのではなく、グループ定義から除外されるだけです。これが役立つのは、たとえば以下のような場合です。このユーザーは、グループから削除されるのではなく、グループ定義から除外されるだけです。こちらは、以下のような場合に有効です。 - John DoeはグループAのメンバーであるDoeは、グループAのメンバーである。
- グループAはグループBのメンバーであるグループAは、グループBのメンバーである。
- John DoeはグループBのメンバーであってはならないため、グループBから除外する必要がある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ユーザーを除外します。このユーザーはグループから削除されるのではなく、グループ定義から除外されるだけである点に注意してください。これが役立つのは、たとえば以下のような場合です。こちらの関数は、指定されたグループから指定されたYellowfinユーザーを除外します。このユーザーはグループから削除されるのではなく、グループ定義から除外されるだけである点に注意してください。こちらは、以下のような場合に有効です。 - John DoeはグループAのメンバーであるDoeは、グループAのメンバーである。
- グループAはグループBのメンバーであるグループAは、グループBのメンバーである。
- John DoeはグループBのメンバーであってはならないため、グループBから除外する必要があるDoeはグループBのメンバーであってはならないため、グループBから除外する必要がある。
| リクエスト要素 | データ型 | 説明 | 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 = “EXCLUDEUSERFROMGROUP” | String | Webサービス関数。Webサービス関数です。 | OrgRef | String | この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。この関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 | Group | AdministrationGroup取得プロセスに関するYellowfinユーザーグループの名前を保持するAdministrationGroupオブジェクト。 | 取得プロセスに関するYellowfinユーザーグループの名前を保持する「AdministrationGroup」オブジェクトです。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。 |
取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。 |
「AdministrationGroup」、および「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationGroup要素 | データ型 | 説明 | GroupName | String | 指定したYellowfinグループの名前指定したYellowfinグループの名前です。 |
| AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
| Expand |
|---|
|
以下のコードは、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);
|
このコードはこちらのコードは、「rs.getStatusCode()で」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 この関数は、指定したグループから指定されたYellowfinユーザーを削除します。このシナリオはEXCLUDEUSERFROMGROUPのシナリオとは異なります。この関数の場合、ユーザーはグループから完全に削除される点に注意してください。こちらの関数は、指定したグループから指定されたYellowfinユーザーを削除します。こちらのシナリオは、「EXCLUDEUSERFROMGROUP」のシナリオとは異なります。こちらの関数の場合、ユーザーはグループから完全に削除される点に注意してください。 | リクエスト要素 | データ型 | 説明 | 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 = “DELUSERFROMGROUP” | String | Webサービス関数。Webサービス関数です。 | OrgRef | String | この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 | Group | AdministrationGroup取得プロセスに関するYellowfinユーザーグループの名前を保持するAdministrationGroupオブジェクト。 | 取得プロセスに関するYellowfinユーザーグループの名前を保持する「AdministrationGroup」オブジェクトです。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。 |
取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。 |
「AdministrationGroup」、および「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationGroup要素 | データ型 | 説明 | GroupName | String | 指定したYellowfinグループの名前指定したYellowfinグループの名前です。 |
| AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。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配列は「AdministrationPerson」オブジェクトの「AdministrationGroupMember」配列を投入することによって、変更されたグループに、既存のYellowfinユーザーを同時に配置することもできます。各「AdministrationPerson」オブジェクトに必要なのは、LoginId変数セットのみであり、「AdministrationGroupMember」配列は、「group.setGroupMembers()」に保存されます。 この関数はYellowfinの指定されたグループの詳細を変更します。この関数では、新規グループに既存のYellowfinユーザーを保存できる点にも注意してください。こちらの関数は、Yellowfinの指定されたグループの詳細を変更します。こちらの関数では、新規グループに既存の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 = “MODIFYGROUP” | String | Webサービス関数。Webサービス関数です。 | OrgRef | String | この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 | Group | AdministrationGroup | 取得プロセスに関するYellowfinユーザーグループの名前を保持するAdministrationGroupオブジェクト。 |
取得プロセスに関するYellowfinユーザーグループの名前を保持する「AdministrationGroup」オブジェクトです。 |
「AdministrationGroup」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationGroup要素 | データ型 | 説明 | GroupName | String | 指定したYellowfinグループの名前指定したYellowfinグループの名前です。 | GroupDescription | String | 指定したYellowfinグループの説明指定したYellowfinグループの説明です。 | GroupMembers | Array（AdministrationPerson）AdministrationPersonオブジェクトの配列。これはオプションのパラメーターで、既存のYellowfinユーザーをこのグループに保存するよう設定することができます。このシナリオの場合、AdministrationPersonオブジェクトに必要なのは、オブジェクトごとにそのLoginIdパラメーターを設定することだけです。 | 「AdministrationPerson」オブジェクトの配列です。こちらはオプションのパラメーターで、既存のYellowfinユーザーを、このグループに保存するよう設定することができます。こちらのシナリオの場合、各「AdministrationPerson」オブジェクトに必要なのは、LoginIdパラメーターを設定することだけです。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。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("DELETEGROUP");
rsr.setGroup(group);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
このコードはこちらのコードは、「rs.getStatusCode()で」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 この関数はYellowfinから指定されたユーザーを削除します。こちらの関数は、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 = “DELETEGROUP” | String | Webサービス関数。Webサービス関数です。 | OrgRef | String | この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 | Group | AdministrationGroup | 取得プロセスに関するYellowfinユーザーグループの名前を保持するAdministrationGroupオブジェクト。 |
取得プロセスに関するYellowfinユーザーグループの名前を保持する「AdministrationGroup」オブジェクトです。 |
「AdministrationGroup」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationGroup要素 | データ型 | 説明 | GroupName | String | 指定したYellowfinグループの名前指定したYellowfinグループの名前です。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
...
クライアント組織機能
Yellowfinには、クライアント組織と呼ばれる機能があり、この機能を使用するとYellowfinの複数の仮想インスタンスを同じサーバーインスタンスに配置できます。と呼ばれる機能があり、こちらの機能を使用することで、複数のYellowfin仮想インスタンスを、同じサーバーインスタンスに配置することができます。
クライアント組織機能は、以下に示す使用可能なWebサービス呼び出しによって管理することができます。クライアント組織機能は、以下に示す使用可能なWebサービスの呼び出しによって、管理することができます。
| Expand |
|---|
|
以下のコードは、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("LISTCLIENTS");
rs = AdministrationService.remoteAdministrationCall(rsr);
|
このコードは、AdministrationClientOrgオブジェクトの配列を返し、こちらのコードは、「AdministrationClientOrg」オブジェクトの配列を返し、「rs.getStatusCode()で」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 この関数は、Yellowfin内で使用可能なすべてのクライアント組織を一覧表示します。こちらの関数は、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 = “LISTCLIENTS” | String | Webサービス関数。Webサービス関数です。 |
返される応答には、以下のパラメーターが含まれます。 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。 |
|
| Expand |
|---|
|
以下コードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたクライアント組織を取得します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg aco = new AdministrationClientOrg();
aco.setClientReferenceId("CLIENTREFERENCEIDHERE");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("GETCLIENT");
rsr.setClient(aco);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
このコードは、こちらのコードは、「rs.getClient()でAdministrationClientOrgオブジェクトを返し、」で「AdministrationClientOrg」オブジェクトを返し、「rs.getStatusCode()で」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 この関数はYellowfin内の指定されたクライアント組織の詳細を取得します。こちらの関数は、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 = “GETCLIENT” | String | Webサービス関数。Webサービス関数です。 | Client | AdministrationClientOrg | 取得プロセスに関するYellowfinクライアント参照IDを保持するAdministrationClientOrgオブジェクト。 |
取得プロセスに関するYellowfinクライアント参照IDを保持する「AdministrationClientOrg」オブジェクトです。 |
「AdministrationClientOrg」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationClientOrg要素 | データ型 | 説明 | ClientReferenceId | Integer | 指定されたクライアント組織のクライアント参照ID指定されたクライアント組織のクライアント参照IDです。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内に指定されたクライアント組織を作成します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg aco = new AdministrationClientOrg();
aco.setClientName("CLIENTNAME");
aco.setClientReferenceId("CLIENTREFERENCEIDHERE");
aco.setTimeZoneCode("AUSTRALIA/SYDNEY");
aco.setDefaultOrg(false);
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("CREATECLIENT");
rsr.setClient(aco);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
このコードはこちらのコードは、「rs.getStatusCode()で」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 この関数はYellowfinに指定されたクライアント組織を作成します。こちらの関数は、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 = “CREATECLIENT” | String | Webサービス関数。Webサービス関数です。 | Client | AdministrationClientOrg | 取得プロセスに関するYellowfinクライアント参照IDを保持するAdministrationClientOrgオブジェクト。 |
取得プロセスに関するYellowfinクライアント参照IDを保持する「AdministrationClientOrg」オブジェクトです。 |
「AdministrationClientOrg」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationClientOrg要素 | データ型 | 説明 | ClientName | String | クライアント組織の名前クライアント組織の名前です。 | ClientReferenceID | String | クライアントの識別に使用される固有のIDであるクライアント参照IDクライアントの識別に使用される、固有のIDであるクライアント参照IDです。 | TimeZoneCode | String | クライアント組織のローカルタイムゾーンコードクライアント組織のローカルタイムゾーンコードです。 | DefaultOrg | Booleanこの組織がデフォルト組織である場合にtrueを返すブール値 | こちらの組織がデフォルト組織である場合に、「true」を返すBoolean値です。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたクライアント組織を削除します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg aco = new AdministrationClientOrg();
aco.setClientReferenceId("CLIENTREFERENCEIDHERE");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("DELETECLIENT");
rsr.setClient(aco);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
このコードはこちらのコードは、「rs.getStatusCode()で」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 この関数はYellowfinの指定されたクライアント組織を削除します。こちらの関数は、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 = “DELETECLIENT” | String | Webサービス関数。Webサービス関数です。 | Client | AdministrationClientOrg | 取得プロセスに関するYellowfinクライアント参照IDを保持するAdministrationClientOrgオブジェクト。 |
取得プロセスに関するYellowfinクライアント参照IDを保持する「AdministrationClientOrg」オブジェクトです。 |
「AdministrationClientOrg」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationClientOrg要素 | データ型 | 説明 | ClientReferenceId | Integer | 指定されたクライアント組織のクライアント参照ID指定されたクライアント組織のクライアント参照IDです。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたクライアント組織を更新します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg aco = new AdministrationClientOrg();
aco.setClientName("CLIENTNAME");
aco.setClientReferenceId("CLIENTREFERENCEIDHERE");
aco.setTimeZoneCode("AUSTRALIA/SYDNEY");
aco.setDefaultOrg(false);
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("UPDATECLIENT");
rsr.setClient(aco);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
このコードはこちらのコードは、「rs.getStatusCode()で」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 以下のコードは、Yellowfin Webサービスを呼び出し、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 = “UPDATECLIENT” | String | Webサービス関数。Webサービス関数です。 | Client | AdministrationClientOrg | 取得プロセスに関するYellowfinクライアント参照IDを保持するAdministrationClientOrgオブジェクト。 |
取得プロセスに関するYellowfinクライアント参照IDを保持する「AdministrationClientOrg」オブジェクトです。 |
「AdministrationClientOrg」オブジェクトで、設定できるパラメーターは、以下の通りです。 | AdministrationClientOrg要素 | データ型 | 説明 | ClientName | String | クライアント組織の名前クライアント組織の名前です。 | ClientReferenceId | Integer | 指定されたクライアント組織のクライアント参照ID。このIDは最初の取得プロセスに使用され、この関数の使用中には変更することができない点に注意が必要です。指定されたクライアント組織のクライアント参照IDです。こちらのIDは、最初の取得プロセスに使用され、こちらの関数の使用中に変更することができない点に、注意が必要です。 | TimeZoneCode | String | クライアント組織のローカルタイムゾーンコードクライアント組織のローカルタイムゾーンコードです。 | DefaultOrg | Booleanこの組織がデフォルト組織である場合にtrueを返すブール値 | こちらの組織がデフォルト組織である場合に、「true」を返すBoolean値です。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたクライアント組織に属するすべてのユーザーを一覧表示します。Webサービスを呼び出し、Yellowfin内の指定されたクライアント組織に属する、すべてのユーザーを一覧表示します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg aco = new AdministrationClientOrg();
AdministrationPerson[] people = null;
aco.setClientReferenceId("CLIENTREFERENCEIDHERE");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("LISTUSERSATCLIENT");
rsr.setClient(aco);
rs = AdministrationService.remoteAdministrationCall(rsr);
people = rs.getPeople();
|
このコードは、こちらのコードは、「rs.getPeople()でAdministrationPersonオブジェクトの配列を返し、」で「AdministrationPerson」オブジェクトの配列を返し、「rs.getStatusCode()で」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 この関数はYellowfinの指定されたクライアント組織に属するすべてのYellowfinユーザーを一覧表示します。こちらの関数は、Yellowfinの指定されたクライアント組織に属する、すべての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 = “LISTUSERSATCLIENT” | String | Webサービス関数。Webサービス関数です。 | Client | AdministrationClientOrg | 取得プロセスに関するYellowfinクライアント参照IDを保持するAdministrationClientOrgオブジェクト。 |
取得プロセスに関するYellowfinクライアント参照IDを保持する「AdministrationClientOrg」オブジェクトです。 |
「AdministrationClientOrg」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationClientOrg要素 | データ型 | 説明 | ClientReferenceId | Integer | 指定されたクライアント組織のクライアント参照ID指定されたクライアント組織のクライアント参照IDです。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | People | Array（AdministrationPerson）AdministrationPersonオブジェクトの配列。各オブジェクトにはYellowfinユーザーのメタデータが保持されます。 | 「AdministrationPerson」オブジェクトの配列です。各オブジェクトには、Yellowfinユーザーのメタデータが保持されます。 |
|
| Expand |
|---|
|
以下のコードは、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オブジェクトの配列を返し、)」で「AdministrationClientOrg」オブジェクトの配列を返し、「rs.getStatusCode()で」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 | リクエスト要素 | データ型 | 説明 | 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 = “GETUSERACCESS” | String | Webサービス関数。Webサービス関数です。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。 |
AdministrationClientOrgオブジェクトで設定が必要なパラメーターは、以下の通りです。 AdministrationPerson要素取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。 |
「AdministrationClientOrg」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationClientOrgy要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | Clients | Array（AdministrationClientOrg）AdministrationClientOrgオブジェクトの配列。各オブジェクトにはYellowfinクライアント組織のメタデータが保持されます。 | 「AdministrationClientOrg」オブジェクトの配列です。各オブジェクトには、Yellowfinクライアント組織のメタデータが保持されます。 |
|
| 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.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の指定されたユーザーに対して指定されたクライアント組織へのアクセス権を追加します。こちらの関数は、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 = “ADDUSERACCESS” | String | Webサービス関数。Webサービス関数です。 | OrgRef | String | この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 | Person | AdministrationPerson取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。 | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。 | Client | AdministrationClientOrg | 取得プロセスに関するYellowfinクライアント組織のクライアント参照IDを保持するAdministrationClientOrgオブジェクト。 |
取得プロセスに関するYellowfinクライアント組織のクライアント参照IDを保持する「AdministrationClientOrg」オブジェクトです。 |
「AdministrationPerson」、および「AdministrationClientOrg」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
| AdministrationClientOrg要素 | データ型 | 説明 | ClientReferenceId | Integer | 指定されたクライアント組織のクライアント参照ID指定されたクライアント組織のクライアント参照IDです。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。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.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の指定されたユーザーに対して指定されたクライアント組織へのアクセス権を削除します。こちらの関数は、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 = “REMOVEUSERACCESS” | String | Webサービス関数。Webサービス関数です。 | OrgRef | String | この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 | Person | AdministrationPerson取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。 | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。 | Client | AdministrationClientOrg | 取得プロセスに関するYellowfinクライアント組織のクライアント参照IDを保持するAdministrationClientOrgオブジェクト。 |
取得プロセスに関するYellowfinクライアント組織のクライアント参照IDを保持する「AdministrationClientOrg」オブジェクトです。 |
「AdministrationPerson」、および「AdministrationClientOrg」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
| AdministrationClientOrg要素 | データ型 | 説明 | ClientReferenceId | Integer | 指定されたクライアント組織のクライアント参照ID指定されたクライアント組織のクライアント参照IDです。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
| Expand |
|---|
|
この関数は、指定されたレポートがYellowfinの指定されたユーザーのお気に入り一覧に存在するかどうかをチェックします。 リクエスト要素 | データ型 | 説明 |
|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 | OrgId | Integer | Yellowfin内のデフォルト組織ID。常に1に設定します。 | Function = “ISUSERFAVOURITE” | String | Webサービス関数。 | OrgRef | String | この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。 | ReportId | Integer | レポートの固有のID。 |
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。 AdministrationPerson要素 | データ型 | 説明 |
|---|
UserId | String | YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。 応答要素 | データ型 | 説明 |
|---|
StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。 |
|
...