Page History

Versions Compared

Key

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

...

これらのオブジェクトは、管理webサービスに固有です。

Anchor

	AdministrationServiceRequest
	AdministrationServiceRequest

Expand

title	AdministrationServiceRequest

こちらのオブジェクトは、webサービスに対して行われる呼び出しの型を定義します。

オブジェクトパラメーター：

パラメーター名	型	説明
sessionId	String
loginId	String	こちらは、Yellowfin webサービス使用権を有効にしたYellowfinアカウントを参照します。Yellowfinのデフォルト（プライマリー）組織に所属するユーザーでなくてはいけません。
password	String	こちらは、上記アカウントのパスワードを参照します。
ntlm	Boolean
orgId	Integer	Yellowfin内のデフォルト（プライマリー）組織IDです。常に、1に設定します。
loginSessionId	String
orgRef	String
query	String
reportId	Integer
dashboardTabId	Integer
function	String	こちらは、呼び出しの型を参照します。
person	AdministrationPerson
group	AdministrationGroup
report	AdministrationReport
client	AdministrationClientOrg
reportGroup	AdministrationReportGroup
favourite	PersonFavourite
contentResources	ContentResource[]
importOptions	ImportOption[]
role	AdministrationRole
retrospectiveDays	Integer
binaryData	byte[]
people	AdministrationPerson[]
datasource	AdministrationDataSource
sourceClientLink	AdministrationDataSourceClientLink
sourceId	Integer
schedule	AdministrationSchedule

すべてのパラメーターは、対応する「get」と「set」メソッドを持ちます。例：

Code Block

theme	Eclipse
language	java

AdministrationServiceRequest sr = new AdministrationServiceRequest();
sr.setSessionId(savedSessionID);

すべてのパラメーターを定義する必要はありません。各webサービスの呼び出しは、必要なパラメーターの一覧を持ちます。指定されないパラメーターは、デフォルトでnull値を持ちます。

しかし、以下の示すように、すべてのリクエストに必須のパラメーターがあります。

loginId
password
orgId
function

その他のパラメーターは、関数値に応じて要求されます。

各リクエストにはwebサービスユーザーの詳細を含めなくてはならず、これはYellowfinのwebサービスを呼び出せるユーザーになります。また、これは既存のユーザーでなくてはならず、「Yellowfin webサービス使用権」を付与され、これらの詳細がloginId、password、orgIdとして指定されていなくてはいけません。

Anchor

	AdministrationServiceResponse
	AdministrationServiceResponse

Expand

title	AdministrationServiceResponse

こちらのオブジェクトは、webサービスにより返されます。

こちらのオブジェクトのパラメーター：

パラメーター名	型
ReportId	Integer
StatusCode	String
ErrorCode	Integer
Messages	String[]
SessionId	String
LoginSessionId	String
person	AdministrationPerson
people	AdministrationPerson[]
group	AdministrationGroup
groups	AdministrationGroup[]
roles	AdministrationRole[]
reports	AdministrationReport[]
reportGroups	AdministrationReportGroup[]
report	AdministrationReport
clients	AdministrationClientOrg[]
client	AdministrationClientOrg
personfavourites	PersonFavourite[]
binaryAttachments	ReportBinaryObject[]
contentResources	ContentResource[]
importIssues	ImportIssue[]
EntityId	Integer
parentDashboard	ParentDashboard
parentDashboards	ParentDashboard[]
parentReportGroups	ParentReportGroup[]
binaryData	String
contentType	String
fileName	String
queryResults	ReportRow[]
datasources	AdministrationDataSource[]
loadedDataSource	AdministrationDataSource
schedule	AdministrationSchedule

すべてのパラメーターは、対応する「get」と「set」メソッドを持ちます。例：

Code Block

theme	Eclipse
language	java

AdministrationServiceResponse ssr = doWebserviceCall(sr);
 
String statusCode = ssr.getStatusCode();

...

Content

Space Tools

Versions Compared

Old Version 4

New Version 5

Key