Page History

Versions Compared

Old Version 4

changes.mady.by.user Yellowfin Admin

Saved on Jan 19, 2015

compared with

New Version Current

changes.mady.by.user Yellowfin Admin

Saved on Feb 05, 2016

Key

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

Comment: Migration of unmigrated content due to installation of a new plugin

...

Table of Contents

class	contents

...

関数

Styleclass

Class	topLink

Report Service ページトップ

Expand

title	PDF

The PDF request runs a specified report and returns it in PDF form. The following code will accomplish this:PDFリクエストは指定されたレポートを実行し、それをPDF形式で返します。これを実行するコードは以下の通りです。

Code Block

ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organization
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("PDF");
rsr.setReportId(12345);

rs = ReportService.remoteAdministrationCall(rsr);

The returned ReportServiceResponse object consists of:

返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。

応答要素	データ型	説明	取得コード
ReportId	Integer	ID of the specified report指定されたレポートのID	`getReportId()`
ReportName	String	Name of the specified report指定されたレポートの名前	`getReportName()`
HitCount	Integer	Number of times the specified report has been accessed指定されたレポートがアクセスされた回数	`getHitCount()`
FormatCode	String	Format code of the specified report指定されたレポートのフォーマットコード	`getFormatCode()`
BinaryData	String	Base64 encoded binary chunk of PDFPDFのBase64エンコードバイナリーチャンク	`getBinaryData()`
ContentType	StringMIME	Content Type of this object. Value will be “application/pdf”このオブジェクトのMIMEコンテンツタイプ。値は「application/pdf」です。	`getContentType()`

Expand

title	CSV

The CSV request runs a specified report and returns it in CSV form. The following code will accomplish this:CSVリクエストは指定されたレポートを実行し、それをCSV形式で返します。これを実行するコードは以下の通りです。

Code Block

ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organization
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("CSV");
rsr.setReportId(12345);

rs = ReportService.remoteAdministrationCall(rsr);

The returned ReportServiceResponse object consists of:

返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。

応答要素	データ型	説明	取得コード
ReportId	Integer	ID of the specified report指定されたレポートのID	`getReportId()`
ReportName	String	Name of the specified report指定されたレポートの名前	`getReportName()`
HitCount	Integer	Number of times the specified report has been accessed指定されたレポートがアクセスされた回数	`getHitCount()`
FormatCode	String	Format code of the specified report指定されたレポートのフォーマットコード	`getFormatCode()`
BinaryData	String	Base64 encoded binary chunk of CSVCSVのBase64エンコードバイナリーチャンク	`getBinaryData()`
ContentType	String	MIME Content Type of this object. Value will be “textこのオブジェクトのMIMEコンテンツタイプ。値は「text/comma-separated-values”values」です。	`getContentType()`

Expand

title	XLS

The XLS request runs a specified report and returns it in XLS form. The following code will accomplish this:XLSリクエストは指定されたレポートを実行し、それをXLS形式で返します。これを実行するコードは以下の通りです。

Code Block

ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organization
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("XLS");
rsr.setReportId(12345);

rs = ReportService.remoteAdministrationCall(rsr);

The returned ReportServiceResponse object consists of:

返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。

応答要素	データ型	説明	取得コード	Response Element
ReportId	Integer	ID of the specified report指定されたレポートのID	`getReportId()`
ReportName	String	Name of the specified report指定されたレポートの名前	`getReportName()`
HitCount	Integer	Number of times the specified report has been accessed指定されたレポートがアクセスされた回数	`getHitCount()`
FormatCode	String	Format code of the specified report指定されたレポートのフォーマットコード	`getFormatCode()`
BinaryData	String	Base64 encoded binary chunk of XLS	XLSのBase64エンコードバイナリーチャンク	`getBinaryDatagetBinaryData()`
ContentType	StringMIME	Content Type of this object. Value will be “application/xls”このオブジェクトのMIMEコンテンツタイプ。値は「application/xls」です。	`getContentType()`

Expand

title	TEXT

The TEXT request runs a specified report and returns it in TEXT form. The following code will accomplish this:TEXTリクエストは指定されたレポートを実行し、それをTEXT形式で返します。これを実行するコードは以下の通りです。

Code Block

ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organization
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("TEXT");
rsr.setReportId(12345);

rs = ReportService.remoteAdministrationCall(rsr);

The returned ReportServiceResponse object consists of:

返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。

応答要素	データ型	説明	取得コード	Response Element
ReportId	Integer	ID of the specified report指定されたレポートのID	`getReportId()`
ReportName	String	Name of the specified report指定されたレポートの名前	`getReportName()`
HitCount	Integer	Number of times the specified report has been accessed指定されたレポートがアクセスされた回数	`getHitCount()`
FormatCode	String	Format code of the specified report	指定されたレポートのフォーマットコード	`getFormatCodegetFormatCode()`
BinaryData	String	Base64 encoded binary chunk of XLSXLSのBase64エンコードバイナリーチャンク	`getBinaryData()`
ContentType	String	MIME Content Type of this object. Value will be “textこのオブジェクトのMIMEコンテンツタイプ。値は「text/tab-separated-values”values」です。	`getContentType()`

Expand

title	RTF

The RTF request runs a specified report and returns it in RTF form. The following code will accomplish this:RTFリクエストは指定されたレポートを実行し、レポートをRTF形式で返します。これを実行するコードは以下の通りです。

Code Block

ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organization
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("RTF");
rsr.setReportId(12345);

rs = ReportService.remoteAdministrationCall(rsr);

The returned ReportServiceResponse object consists of:

返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。

応答要素	データ型	説明	取得コード	Response Element	Data Type
ReportId	Integer	ID of the specified report指定されたレポートのID	`getReportId()`
ReportName	String	Name of the specified report指定されたレポートの名前	`getReportName()`
HitCount	Integer	Number of times the specified report has been accessed		指定されたレポートがアクセスされた回数	`getHitCount(getHitCount()`
FormatCode	String	Format code of the specified report指定されたレポートのフォーマットコード	`getFormatCode()`
BinaryData	String	Base64 encoded binary chunk of XLSXLSのBase64エンコードバイナリーチャンク	`getBinaryData()`
ContentType	StringMIME	Content Type of this object. Value will be “application/rtf”このオブジェクトのMIMEコンテンツタイプ。値は「application/rtf」です。	`getContentType()`

Expand

title	DOC

The DOC request runs a specified report and returns it in DOC form. The following code will accomplish this:DOCリクエストは指定されたレポートを実行し、それをDOC形式で返します。これを実行するコードは以下の通りです。

Code Block

ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organization
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("DOC");
rsr.setReportId(12345);

rs = ReportService.remoteAdministrationCall(rsr);

The returned ReportServiceResponse object consists of:

返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。

応答要素	データ型	説明	取得コード	Response Element
ReportId	Integer	ID of the specified report指定されたレポートのID	`getReportId()`
ReportName	String	Name of the specified report	指定されたレポートの名前	`getReportNamegetReportName()`
HitCount	Integer	Number of times the specified report has been accessed指定されたレポートがアクセスされた回数	`getHitCount()`
FormatCode	String	Format code of the specified report指定されたレポートのフォーマットコード	`getFormatCode()`
BinaryData	String	Base64 encoded binary chunk of XLSXLSのBase64エンコードバイナリーチャンク	`getBinaryData()`
ContentType	String	MIME Content Type of this object. Value will be “applicationこのオブジェクトのMIMEコンテンツタイプ。値は「application/vnd.ms-word”word」です。	`getContentType()`

Expand

title	SCHEMA

The SCHEMA request returns schematic information of the specified report, which includes metadata for report columns and filters as well. The following code will accomplish this:SCHEMAリクエストは、指定されたレポートについて、レポートのカラムおよびフィルターのメタデータも含むスキーマ情報を返します。これを実行するコードは以下の通りです。

Code Block

ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organization
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("SCHEMA");
rsr.setReportId(12345);
// This is the report's web service name. If ReportId is set, this is not needed
rsr.setObjectName("MYREPORT");

rs = ReportService.remoteAdministrationCall(rsr);

The returned ReportServiceResponse object consists of:

返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。

応答要素	データ型	説明	取得コード	Response Element	Data Type	Description	Retrieval Code
ReportId	Integer	ID of the specified report指定されたレポートのID	`getReportId()`
StatusCode	String	Status of the web service requestWebサービスリクエストのステータス	`getStatusCode()`
FormatCode	String	Format code of the specified report指定されたレポートのフォーマットコード	`getFormatCode()`
ReportType	String	Report type of the specified report指定されたレポートのレポートタイプ	`getReportType()`
LastRunStatus	String	Status code of last report run最後のレポート実行のステータスコード	`getLastRunStatus()`
LastRunTime	Decimal	Last report run time in the format of YYYYMMDDHHMMSSYYYYMMDDHHMMSS形式で示されるレポートの最終実行時間	`getLastRunTime()`
ReportName	String	Name of the specified report指定されたレポートの名前	`getReportName()`
BinaryData	String	Base64 encoded binary chunk of image, HTML, CSV, or PDFイメージ、HTML、CSV、またはPDFのBase64エンコードバイナリーチャンク	`getBinaryData()`
ViewName	String	Name of view that the report depends onレポートが依存するビューの名前	`getViewName()`
HitCount	Integer	Number of times the specified report has been accessed指定されたレポートがアクセスされた回数	`getHitCount()`
DrillCode	String	Drill type if available on the reportドリルタイプ（レポートで使用可能な場合）	`getDrillCode()`
Private		Determines if the report is a private or a public oneレポートが個人用または共有のいずれであるかを判別します。	`getPrivate()`
Results	Array (ReportRow)	Array（ReportRow）	レポート結果セットの結果が含まれる、ReportRowオブジェクトの配列（ReportRowを参照）Array of ReportRow objects that contain results in the report result set (see Report Service)	`getResults()`
ContentType	String	返されたオブジェクトのMIMEコンテンツタイプ。可能な値は以下の通りです。「text/html」「text MIME ContentType of the returned object. Possible values include: “text/html” “text/comma-separated-values”values」 “image「image/png”png」 “application「application/pdf”pdf」	`getContentType()`
Messages	Array（String）	レポートがサーバー上で実行されるときにデバッグ情報を示す文字列の配列。エラーのデバッグおよび追跡に使用します。	`getMessages()`
Charts	Array (String)	Array of Strings that show debug information as the report is run on the server. Used for debugging and tracing errors	`getMessages()`	ReportChart)	HTMLレポート応答に付加される、複数のグラフビットマップを含むReportChartオブジェクトの配列（ReportChartを参照）	Charts	Array (ReportChart)	Array of ReportChart objects that contains multiple chart bitmaps when attached to a HTML report response (see Report Service)	`getCharts()`
Columns	Array (ReportSchema)Array of ReportSchema objects that contain information on each column in the report result set, and whether the report requires user prompt filter data to be passed to it (see Report Service	)レポート結果セットの各カラムの情報、およびユーザープロンプトフィルターデータをレポートに渡す必要があるかどうかを示す情報が含まれるReportSchemaオブジェクトの配列（ReportSchemaを参照）	`getColumns()`

Expand

title	HTML / HTMLCHARTONLY / HTMLTABLEONLY

HTMLリクエストは、レポートをHTMLで表現したものを返します。HTMLドキュメントはBase64でエンコードされ、グラフとイメージがCharts配列フィールドに格納されます。これらのアーティファクトはクライアントシステムにより手動でデコードする必要があります。また、Base64イメージのデコード用に、URLリクエスト文字列を使用してHTML内にURLが埋め込まれます。

これを実行するコードは以下の通りです。

The HTML request will return a HTML representation of the report. The HTML document will be Base64 encoded, with the charts/images being stored in the Charts array field. These artefacts will need to be manually decoded by the client system, and the URL request string is used to embed the URL within the HTML for decoding the Base64 images.

The following code will accomplish this:

Code Block

ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organization
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("HTML");
rsr.setReportId(12345);
// This is the report's web service name. If ReportId is set, this is not needed
rsr.setObjectName("MYREPORT");

rs = ReportService.remoteAdministrationCall(rsr);

The returned ReportServiceResponse object consists of:

返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。

応答要素	データ型	説明	取得コード	Response Element	Data Type	Description
Chart	Array (ReportChart)Array of ReportChart objects that contains multiple chart bitmaps when attached to a HTML report response (see Report Service)	HTMLレポート応答に付加される、複数のグラフビットマップを含むReportChartオブジェクトの配列（ReportChartを参照）	`getCharts()`
ReportBinaryObject	Array (ReportBinaryObject)Array of ReportBinaryObject objects that contain BLOBs and CLOBs (see Report Service)	BLOBおよびCLOBを含むReportBinaryObjectオブジェクトの配列（ReportBinaryObjectを参照）	`getBinaryObjects()`
ReportStyles	String	CSS stylesCSSスタイル	`getReportStyles()`
Breadcrumbs	Array (Breadcrumb)	Array（Breadcrumb）	Breadcrumbオブジェクトの配列Array of Breadcrumb objects	`getBreadcrumbs()`
SeriesSelection	Array (SeriesSelection)	Array（SeriesSelection）	SeriesSelectionオブジェクトの配列Array of SeriesSelection objects	`getSeriesSelections()`
TimeAggregationSelection	Array (TimeAggregationSelection)	Array（TimeAggregationSelection）	TimeAggregationSelectionオブジェクトの配列Array of TimeAggregationSelection objects	`getTimeAggregationSelection()`
ReportTabSelection	Array (ReportTabSelection)	Array（ReportTabSelection）	ReportTabSelectionオブジェクトの配列Array of ReportTabSelection objects	`getReportTabSelection()`
ReportPageSelection	Array (ReportPageSelection)	Array of ReportPageSelection objects	Array（ReportPageSelection）	ReportPageSelectionオブジェクトの配列	`getReportPageSelection()`
TimeSliderSelection	Array (TimeSliderSelection)	Array（TimeSliderSelection）	TimeSliderSelectionオブジェクトの配列Array of TimeSliderSelection objects	`getTimeSliderSelection()`
SortableColumns	Array (SortableTableColumn)	Array（SortableTableColumn）	SortableTableColumnオブジェクトの配列Array of SortableTableColumn objects	`getSortableColumns()`
SelectedSortColumn	Integer	Column used for sorting. The index here applies to the column index within the report並べかえに使用するカラム。このインデックスは、レポート内のカラムインデックスに適用されます。	`getSelectedSortColumn()`
SelectedSortOrder	Integer	The sort order of the column used for sorting (0 for ascending and 1 for descending)並べかえに使用するカラムの並べかえ順序（0が昇順、1が降順）	`getSelectedSortOrder()`
DrillCode	String	Drill type if available on the reportドリルタイプ（レポートで使用可能な場合）	`getDrillCode()`
RelatedReports	Array（RelatedReport）	RelatedReportオブジェクトの配列。これは、メインレポートにマルチ表示（タブ化）されるレポートです。	`getRelatedReports`Array `(`RelatedReport`)`	Array of RelatedReport objects. These are reports that are tabbed/codisplayed to the main report	`getRelatedReports()`
BinaryData	String	HTMLドキュメントのBase64エンコードバイナリーチャンク	BinaryData	String	Base64 encoded binary chunk of the HTML document	`getBinaryData()`
Private		Determines if the report is a private or a public oneレポートが個人用または共有のいずれであるかを判別します。	`getPrivate()`
ContentType	StringMIME	ContentType of the returned object. Value will be “text/html”返されたオブジェクトのMIMEコンテンツタイプ。値は「text/html」です。	`getContentType()`
CanDrill	Boolean	If the report is able to drill or notレポートがドリル可能かどうか	`getCanDrill()`
GoogleMaps	Array (GMap)	Array（GMap）	GMapオブジェクトの配列Array of GMap objects	`getGoogleMaps()`

Expand

title	FILTEROPTIONS

FILTEROPTIONSリクエストは、特定のレポートのフィルターで使用可能なフィルター値を返します。

これを実行するコードは以下の通りです。

Code Block

The FILTEROPTIONS request will return the filter values available for a particular report’s filter.

The following code will accomplish this:

Code Block

ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organization
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("FILTEROPTIONS");
// This is the Report ID
rsr.setReportId(12345);
// This is the Filter ID
rsr.setObjectName("11111");

rs = ReportService.remoteAdministrationCall(rsr);

The returned ReportServiceResponse object consists of:

返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。

応答要素	データ型	説明	取得コード	Response Element	Data Type	Description	Retrieval Code
Results	Array (ReportRow)	Array of ReportRow objects that contain filter values (see Report Service)	`getResults()`	フィルター値を含むReportRowオブジェクトの配列（ReportRowを参照）	`getResults()`

Expand

title	RESULTSET

RESULTSETリクエストは、特定のレポートの結果データセットを返します。この結果はReportRowオブジェクトの配列に格納され、各ReportRowオブジェクトがレポートデータセットの1つのロウを表します。ReportRowオブジェクトは、データセットの各カラムのデータを表す文字列の配列でも構成されます。

このデータを文字列表現から特定のカラムのデータ型に変換するのは、Webサービスクライアントの役割です。各カラムのデータ型は、SCHEMAリクエスト関数呼び出しにより取得できます。

これを実行するコードは以下の通りです。

Expand

title	RESULTSET

The RESULTSET request will return the result data set for a particular report. This result will be stored in an array of ReportRow objects, with each ReportRow object representing a row in the report data set. The ReportRow object will also consist of an array of strings that represents the data in each column in the data set.

It is up to the web services client to convert this data from the string representation into the data type for each particular column. The data types for each column can be obtained with the SCHEMA request function call.

The following code will accomplish this:

Code Block

ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organization
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("RESULTSET");
// This is the Report ID
rsr.setReportId(12345);

rs = ReportService.remoteAdministrationCall(rsr);

The returned ReportServiceResponse object consists of:

返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。

応答要素	データ型	説明	取得コード	Response Element	Data Type	Description	Retrieval Code
Results	Array (ReportRow)Array of ReportRow objects that contain results in the report result set (see Report Service)	レポート結果セットの結果が含まれる、ReportRowオブジェクトの配列（ReportRowを参照）	`getResults()`

Expand

title	EXPIRESESSION		EXPIRESESSION

EXPIRESESSIONリクエストは、指定されたYellowfinセッションを期限切れにします。

これを実行するコードは以下の通りです。

The EXPIRESESSION request will cause a specified Yellowfin session to expire.

The following code will accomplish this:

Code Block

ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organization
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("EXPIRESESSION");
// This is the Session ID
rsr.setSessionId("5361781d-c3aa-4c97-bc13-883210ff8a6e");

rs = ReportService.remoteAdministrationCall(rsr);

Expand

title	GETCOMMENTS

GETCOMMENTSリクエストは、特定のレポートについてすべてのコメントを取得します。

これを実行するコードは以下の通りです。

The GETCOMMENTS request will retrieve all comments for a particular report.

The following code will accomplish this:

Code Block

ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organization
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("GETCOMMENTS");
// This is the Report ID
rsr.setReportId(12345);

rs = ReportService.remoteAdministrationCall(rsr);

The returned ReportServiceResponse object consists of:

返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。

応答要素	データ型	説明	取得コード
コメント
Response Element	Data Type	Description	Retrieval Code
Comments	Array (ReportComment)Array of ReportComment objects that contain the report’s comments (see Report Service)	レポートのコメントを含むReportCommentオブジェクトの配列（ReportCommentを参照）	`getComments()`

Expand

title	LEAVECOMMENT

LEAVECOMMENTリクエストは、特定のレポートにコメントまたはコメントに対する応答を作成します。

これを実行するコードは以下の通りです。

The LEAVECOMMENT request will create a comment/response to a comment in a particular report.

The following code will accomplish this:

Code Block

ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
ReportComment comment = new ReportComment();

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organization
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("LEAVECOMMENT");

comment.setComment("This is my comment");
comment.setAuthorId(5);
// If this is a response to a comment, then specify the parent comment ID
comment.setParentCommentId(702);
rsr.setReportComment(comment);

rs = ReportService.remoteAdministrationCall(rsr);

Expand

title	DELETECOMMENT

DELETECOMMENTリクエストは、レポートから特定のコメントを削除します。

これを実行するコードは以下の通りです。

The DELETECOMMENT request will delete the particular comment from a report.

The following code with accomplish this:

Code Block

ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
ReportComment comment = new ReportComment();

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organization
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("DELETECOMMENT");

comment.setCommentId(702);
rsr.setReportComment(comment);

rs = ReportService.remoteAdministrationCall(rsr);

Expand

title	COMMENTSTATUS

COMMENTSTATUSリクエストは、特定のコメントのステータスを設定します。

これを実行するコードは以下の通りです。

The COMMENTSTATUS request will set the status of a particular comment.

The following code will accomplish this:

Code Block

ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
ReportComment comment = new ReportComment();

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organization
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("COMMENTSTATUS");

comment.setCommentId(702);
// The available status codes are OPEN, RESOLVED, or DELETED
comment.setStatusCode("OPEN");
rsr.setReportComment(comment);

rs = ReportService.remoteAdministrationCall(rsr);

Expand

title	DISTRIBUTEINBOX

DISTRIBUTEINBOXリクエストは、一覧に含まれる受信者の受信トレイにレポートを配信します。

これを実行するコードは以下の通りです。

The DISTRIBUTEINBOX request will distribute a report to the inboxes of a list of recipients.

The following code will accomplish this:

Code Block

ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
// Specify the Person ID values for your list of recipients
String[] reportoptions = { "11111", "5", "10101"};

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organization
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("DISTRIBUTEINBOX");
rsr.setReportOptions(reportoptions);
rsr.setReportId(12345);
// This is an optional distribution text for all recipients
rsr.setDistributionText("A message for recipients");

rs = ReportService.remoteAdministrationCall(rsr);

Expand

GETDISPLAYEDREPORTID

title		GETDISPLAYEDREPORTID

GETDISPLAYEDREPORTIDリクエストは、現在表示されているレポートのレポートIDを返します。

これを実行するコードは以下の通りです。

The GETDISPLAYEDREPORTID request will return the report ID of the currently displayed report.

The following code will accomplish this:

Code Block

ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organization
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("GETDISPLAYEDREPORTID");

rs = ReportService.remoteAdministrationCall(rsr);

The returned ReportServiceResponse object consists of:

返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。

応答要素	データ型	説明	取得コード	Response Element	Data Type	Description	Retrieval Code
DisplayedReportId	Integer	Report ID of the currently displayed report現在表示されているレポートのレポートID	`getDisplayedReportId()`

Expand

title	GETKPI

GETKPIリクエストは、特定のKPIレポートについてKPIオブジェクトを返します。この関数リクエストは通常、モバイルアプリケーション内で利用されます。

これを実行するコードは以下の通りです。

The GETKPI request will return you the KPI object for a particular KPI report. This function request is usually utilised within the mobile application.

The following code will accomplish this:

Code Block

ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organization
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("GETKPI");
rsr.setReportId(12345);

rs = ReportService.remoteAdministrationCall(rsr);

The returned ReportServiceResponse object consists of:

返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。

応答要素	データ型	説明	取得コード	Response Element	Data Type	Description	Retrieval Code
KPI	KPI object	KPIオブジェクト	特定のKPIメトリック（数値）について、実績、目標、および差異の値を保持するカスタムKPIオブジェクト（KPIを参照）This is a custom KPI object which holds the actual, target, and variance values for a particular KPI metric (see Report Service)	`getKPI()`

Expand

title	GETDRILLANYWHEREMENU

GETDRILLANYWHEREMENUリクエストは、選択されたレポートカラムで使用できる「ドリルエニウェア」メニューを返します。この関数リクエストは通常、モバイルアプリケーション内で利用されます。

これを実行するコードは以下の通りです。

The GETDRILLANYWHEREMENU request will return you the Drill Anywhere menu that is available for the selected report column. This function request is usually utilized within the mobile application.

The following code will accomplish this:

Code Block

ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organization
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("GETDRILLANYWHEREMENU");
rsr.setReportId(12345);
// This is an integer field which is the Field ID of the selected column
rsr.setDrillAnywhereFieldId(3);
// This is the actual value of the column
rsr.setDrillAnywhereCellValue("5000");

rs = ReportService.remoteAdministrationCall(rsr);

The returned ReportServiceResponse object consists of:

返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。

応答要素	データ型	説明	取得コード
DrillAnywhereCategories	Array（String）	文字列の配列
Response Element	Data Type	Description	Retrieval Code
DrillAnywhereCategories	Array (String)	Array of Strings	`getDrillAnywhereCategories()`
DrillAnywhereTargets	Array (DrillAnywhereTarget)Array of DrillAnywhereTarget objects that lists the drill anywhere targets for a drill anywhere category (see Report Service)	ドリルエニウェアカテゴリーのドリルエニウェア目標を一覧表示するDrillAnywhereTargetオブジェクトの配列（DrillAnywhereTargetを参照）	`getDrillAnywhereTargets()`

Expand

title	SUBSCRIBEDETAILS

SUBSCRIBEDETAILSリクエストは、特定のレポートのスケジュールレコードを返します。

これを実行するコードは以下の通りです。

The SUBSCRIBEDETAILS request will return the schedule record for a particular report.

The following code will accomplish this:

Code Block

ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
ScheduleRecord sr = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organization
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("SUBSCRIBEDETAILS");
rsr.setReportId(12345):
// This is the ID of the user to be subscribed
rsr.setReportUserId(19090);

rs = ReportService.remoteAdministrationCall(rsr);
sr = rs.getSchedule();

The returned ReportServiceResponse object consists of:

返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。

応答要素	データ型	説明	取得コード
ScheduleRecord	ScheduleRecordオブジェクト	購読詳細と条件を含むScheduleRecordオブジェクト（ScheduleRecordを参照）
Response Element	Data Type	Description	Retrieval Code
ScheduleRecord	ScheduleRecord object	ScheduleRecord object which contains subscription details and conditions (see Report Service)	`getSchedule()`

Expand

title	SUBSCRIBE

SUBSCRIBEリクエストは、指定されたユーザーの指定のレポートに対する購読を作成/変更します。この関数リクエストは通常、まず現在の購読を取得するために、SUBSCRIBEDETAILSのあとに呼び出されます。そうでない場合、この関数呼び出しのために、ScheduleRecordオブジェクトを作成して適切なデータを投入する必要があります（ScheduleRecordを参照）。

これを実行するコードは以下の通りです。

The SUBSCRIBE request will create/modify a subscription to a specified report for a specified user. This function request is usually called after SUBSCRIBEDETAILS to retrieve a current subscription first, otherwise a ScheduleRecord object must be created and populated appropriately (refer to Report Service) for this function call.

The following code will accomplish this:

Code Block

ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
// Either retrieve a current ScheduleRecord beforehand or create a new one. A new one is created in this example
ScheduleRecord sr = new ScheduleRecord();

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organization
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("SUBSCRIBE");
rsr.setReportId(12345):
// This is the ID of the user to be subscribed
rsr.setReportUserId(19090);

// Refer to the ScheduleRecord schema definition for all possible variables
sr.setRecipient(19090);
sr.setFormat("PDF");
sr.setSubject("Athlete Analysis");
sr.getBodyText("Pay attention to the data in October");
sr.setFrequencyTypeCode("FORTNIGHTLY");
sr.setFrequencyCode("ONE");
sr.setFrequencyUnit(1);
sr.setAdvancedTimezoneCode("AUSTRALIA/SYDNEY");
// total of seconds from 12am - the example below is set for 5.30pm
sr.setAdvancedTime(63000);

rs = ReportService.remoteAdministrationCall(rsr);

Expand

title	UNSUBSCRIBE

UNSUBSCRIBEリクエストは、指定のレポートから指定されたユーザーの購読を取り消します。

これを実行するコードは以下の通りです。

The UNSUBSCRIBE request will unsubscribe a specified user from a specified report.

The following code will accomplish this:

Code Block

ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organization
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("UNSUBSCRIBE");
rsr.setReportId(12345):
// This is the ID of the user to be subscribed
rsr.setReportUserId(19090);

rs = ReportService.remoteAdministrationCall(rsr);

Expand

title	LOADDASHBOARDTAB

LOADDASHBOARDTABリクエストは、指定されたダッシュボードタブとそのメタデータをロードします。

これを実行するコードは以下の通りです。

The LOADDASHBOARDTAB request will load a specified dashboard tab and its metadata.

The following code will accomplish this:

Code Block

ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
DashboardDefinition dd = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organization
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("LOADDASHBOARDTAB");
// This is the ID of the dashboard tab
rsr.setDashboardTabId(11111);

rs = ReportService.remoteAdministrationCall(rsr);
dd = rs.getDashboard();

The returned ReportServiceResponse object consists of:

返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。

応答要素	データ型	説明	取得コード	Response Element	Data Type	Description	Retrieval Code
DashboardDefinitionDashboardDefinition object	DashboardDefinitionオブジェクトDashboardDefinition	object which contains dashboard tab metadata (see Report Service)ダッシュボードタブのメタデータを含むDashboardDefinitionオブジェクト（DashboardDefinitionを参照）	`getDashboard()`

Expand

title	APPLYDASHBOARDFILTERS

The following code will accomplish this:これを実行するコードは以下の通りです。

Code Block

ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
DashboardFilter[] dfarray = null;
DashboardFilter df = new DashboardFilter();

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organization
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("APPLYDASHBOARDFILTERS");
// This is the ID of the dashboard tab
rsr.setDashboardTabId(11111);

df.setTabId(11111);
df.setReportId(12121);
df.setFilterId(33333);
df.setFilterType("BETWEEN");
df.setFilterValue("120|150");
dfarray[0] = df;
rsr.setDashboardFilters(dfarray);

rs = ReportService.remoteAdministrationCall(rsr);

Expand

title	GETDASHBOARDREPORTFILTERVALUES

GETDASHBOARDREPORTFILTERVALUESリクエストは、ダッシュボードタブの特定のレポートに対するフィルターメタデータを返します。

これを実行するコードは以下の通りです。

The GETDASHBOARDREPORTFILTERVALUES request will return filter metadata for a particular report on a dashboard tab.

The following code will accomplish this:

Code Block

ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
ReportFilter[] rf = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organization
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("GETDASHBOARDREPORTFILTERVALUES");
// This is the ID of the dashboard tab
rsr.setDashboardTabId(11111);
rs.getReportId(22222);

rs = ReportService.remoteAdministrationCall(rsr);
rf = rs.getReportFilters();

The returned ReportServiceResponse object consists of:

返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。

応答要素	データ型	説明	取得コード	Response Element	Data Type	Description	Retrieval Code
ReportFilters	Array (ReportFilter)Array of Filter objects containing metadata for each filter (see Report Service)	各フィルターのメタデータを含むFilterオブジェクトの配列（ReportFilterを参照）	`getReportFilters()`

Expand

title	RUNDASHBOARDREPORT

RUNDASHBOARDREPORTリクエストは、ダッシュボードタブの指定されたレポートを実行し、エクスポートします。応答には、グラフ、GISマップ、およびCSSスタイルを含む、Base64エンコードで生成されたHTMLが含まれます。

これを実行するコードは以下の通りです。

The RUNDASHBOARDREPORT request will run and export a specified report on a dashboard tab. The response will include Base64 encoded generated html, including charts, GIS maps, and CSS styles.

The following code will accomplish this:

Code Block

ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organization
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("RUNDASHBOARDREPORT");
// This is the ID of the dashboard tab
rsr.setDashboardTabId(11111);
rs.getReportId(22222);

rs = ReportService.remoteAdministrationCall(rsr);

The returned ReportServiceResponse object consists of:

返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。

応答要素	データ型	説明	取得コード	Response Element
BinaryData	String	Base64 encoded binary chunk of HTMLHTMLのBase64エンコードバイナリーチャンク	`getBinaryData()`
Charts	Array (ReportChart)Array of ReportChart objects (see Report Service)	ReportChartオブジェクトの配列（ReportChartを参照）	`getCharts()`
ReportStyle	String	CSS stylesCSSスタイル	`GetReportStyle()`
Breadcrumbs	Array (Breadcrumb)	Array（Breadcrumb）	Breadcrumbオブジェクトの配列Array of Breadcrumb objects	`getBreadcrumbs()`
GoogleMaps	Array (GMap)	Array（GMap）	GoogleMapsオブジェクトの配列（レポートのグラフで使用されている場合）Array of GoogleMaps objects if the report’s chart uses it	`getGoogleMaps()`
GisMap	Array (GISMap)	Array of GISMap objects if the report’s chart uses it	`getGisMap()`

...

Array（GISMap）

GISMapオブジェクトの配列（レポートのグラフで使用されている場合）

Array（GISMap）

オブジェクト定義

Styleclass

Class	topLink

Report Service ページトップ

Anchor

	ReportComment
	ReportComment

Expand

title	ReportComment

ReportComment ElementReportComment要素	Data Typeデータ型	Description説明	Retrieval Code取得コード
CommentId	Integer	ID of commentコメントのID	`getCommentId()`
AuthorId	Integer	ID of comment authorコメント作成者のID	`getAuthorId()`
Comment	String	Comment valueコメントの値	`getComment()`
ReportId	Integer	Report ID of which the comment resides onコメントが存在するレポートのID	`getReportId()`
ParentCommentId	Integer	Main ID of comment it is connected to. This applies if the particular comment is a reply to a parent commentコメントが関連付けられているメインID。ある特定のコメントが親コメントへの返信である場合に、これが適用されます。	`getParentCommentId()`
StatusCode	String	Comment statusコメントのステータス	`getStatusCode()`
CommentDate	DateTime	Date and time value for comment creationコメントが作成された日時の値	`getCommentDate()`
LastActivityDate	DateTime	Date and time value for the most current update to that particular commentその特定のコメントが最後に更新された日時の値	`getLastActivityDate()`

Anchor

	ReportRow
	ReportRow

Expand

title	ReportRow

ReportRow ElementReportRow要素	Data Typeデータ型	Description説明	Retrieval Code取得コード
DataValue	Array (String)	Array（String）	レポート結果セットの各カラムのデータを含む文字列の配列Array of Strings with data for each column in the report result set	`getDataValue()`

Anchor

	ReportChart
	ReportChart

Expand

title	ReportChart

ReportChart ElementReportChart要素	Data Typeデータ型	Description説明	Retrieval Code取得コード
ReportIndex	Integer	Index of image in the embedded delivered HTML配信された埋め込みHTML内のイメージのインデックス	`getReportIndex()`
Content Type	String	このグラフのMIMEコンテンツタイプ。可能な値は以下の通りです。「image/png」「image/jpg」 MIME Content Type of this chart. Possible values include: “image/png” “image/jpg”	`getContentType()`
Data	String	Base64 binary image dataBase64のバイナリーイメージデータ	`getData()`
Filename	String	Filename of embedded file in HTMLHTMLに埋め込まれているファイルのファイル名	`getFilename()`

Anchor

	ReportSchema
	ReportSchema

Expand

title	ReportSchema

ReportSchema ElementReportSchema要素	Data Typeデータ型	Description説明	Retrieval Code取得コード
ColumnName	String	Column Nameカラム名	`getColumnName()`
DisplayName	String	Display name of columnカラムの表示名	`getDisplayName()`
FieldId	Integer	Field Id of columnカラムのフィールドID	`getFieldId()`
DataType	String	Data type of columnカラムのデータ型	`getDataType()`
ColumnLength	String	Column lengthカラム長	`getColumnLength()`
Hidden	Boolean	Whether the column is displayed in the report or notカラムがレポートに表示されるかどうか	`getHidden()`
Prompt	Boolean	Whether the column is a prompt field or notカラムがプロンプトフィールドかどうか	`getPrompt()`
FilterId	Integer	Filter Id if the column is a filterフィルターID（カラムがフィルターの場合）	`getFilterId()`
FilterType	String	Determines the filter type and what data would have to be posted to engage the promptフィルタータイプおよびプロンプトへの応答として投稿する必要があるデータを決定します。	`getFilterType()`
AllowPrompt	Boolean		`getAllowPrompt()`
FilterOmittable	Boolean		`getFilterOmittable()`
ParentFilterId	Integer	Filter Id of parent filter if a filter dependency is in place親フィルターのフィルターID（フィルターの従属関係が設定されている場合）	`getParentId()`
DefaultValue1			フィルターの最初のデフォルト値（設定されている場合）First default value for filter if set	`getDefaultValue1()`
DefaultValue2		Second default value for filter if setフィルターの2番目のデフォルト値（設定されている場合）	`getDefaultValue2()`
ValueUnitCode		Time units for the filter if setフィルターの時間単位（設定されている場合）	`getValueUnitCode()`
FilterDisplayType		Filter Display Type if the column is a filterフィルター表示タイプ（カラムがフィルターの場合）	`getFilterDisplayType()`
MinimumValue		Minimum value for filter if setフィルターの最小値（設定されている場合）	`getMinimumValue()`
MaximumValue		Maximum value for filter if setフィルターの最大値（設定されている場合）	`getMaximumValue()`

Anchor

	ReportBinaryObject
	ReportBinaryObject

Expand

title	ReportBinaryObject

ReportBinaryObject ElementReportBinaryObject要素	Data Typeデータ型	Description説明	Retrieval Code取得コード
ContentType	String	MIME Content TypeMIMEコンテンツタイプ	`getContentType()`
Data	String	Base64 binary dataBase64バイナリーデータ	`getData()`
Key	String	Key of the ReportBinaryObject objectReportBinaryObjectオブジェクトのキー	`getKey()`

Anchor

	KPI
	KPI

Expand

title	KPI

KPI ElementKPI要素	Data Typeデータ型	Description説明	Retrieval Code取得コード
Actual	String	String	KPIメトリック（数値）の実績値The actual value for a KPI metric	`getActual()`
Target	String	The target value for a KPI metricKPIメトリック（数値）の目標値	`getTarget()`
Variance	String	The variance value for a KPI metricKPIメトリック（数値）の差異値	`getVariance()`

Anchor

	DrillAnywhereTarget
	DrillAnywhereTarget

Expand

title	DrillAnywhereTarget

DrillAnywhereTarget ElementDrillAnywhereTarget要素	Data Typeデータ型	Description説明	Retrieval Code取得コード
ParentCategory	String	Parent Category value親カテゴリーの値	`getParentCategory()`
Targets	Array (String)	Array（String）	特定の親カテゴリーの目標である文字列値の配列Array of String values which are the targets for a particular parent category	`getTargets()`

Anchor

	ScheduleRecord
	ScheduleRecord

Expand

title	ScheduleRecord

ScheduleRecord ElementScheduleRecord要素	Data Typeデータ型	Description説明	Retrieval Code取得コード
Recipient	Integer	ID of recipient of the subscription購読の受信者のID	`getRecipient()`
Subject	String	Subscription subject購読の件名	`getSubject()`
BodyText	String	Subscription message購読のメッセージ	`getBodyText()`
FrequencyTypeCode	String	Subscription frequency. Values include:購読の頻度。次の値があります。 MINUTES DAILY WEEKLY FORTNIGHTLY MONTHLY QUARTERLY BIANNUAL ANNUAL ENDOFMONTH	`getFrequencyTypeCode()`
FrequencyCode	String	Additional frequency codes depending on the frequency type code頻度タイプコードに応じた追加の頻度コード	`getFrequencyCode()`
FrequencyUnit	String	Additional frequency units depending on the frequency type code頻度タイプコードに応じた追加の頻度単位	`getFrequencyCode()`
Format	String	Subscription File Type. Values include:購読ファイルタイプ。次の値があります。 PDF HTML CSV DOC XLS RTF	`getFormat()`
ConditionList	Array (Condition)	Array（Condition）	配信ルールを格納するConditionオブジェクトの配列（Conditionを参照）Array of Condition objects that store delivery rules (see Report Service)	`getConditionList()`
AdvancedTimezoneCode	String	Timezone in which the subscription happens購読が行われるタイムゾーン	`getAdvancedTimezoneCode()`
AdvancedTime	Integer	Local run time for the subscription購読のローカル実行時間	`getAdvancedTime()`

Anchor

	Condition
	Condition

Expand

title	Condition

Condition ElementCondition要素	Data Typeデータ型	Description説明	Retrieval Code取得コード
Operator	String	Filter operator for the column(s). Values include:カラムのフィルター演算子。次の値があります。 BETWEEN NOTBETWEEN EQUAL NOTEQUAL GREATER GREATEREQUAL INLIST NOTINLIST ISNULL ISNOTNULL LESS LESSEQUAL STARTSWITH NOTSTARTSWITH CONTAINS NOTCONTAINS ENDSWITH NOTENDSWITH	`getOperator()`
FieldId	Integer	Field Id of columnカラムのフィールドID	`getFieldId()`
Value1	String	First conditional value最初の条件値	`getValue1()`
Value2	String	Second conditional value. This is needed if the operators are BETWEEN, NOTBETWEEN, etc.2番目の条件値。演算子がBETWEENやNOTBETWEENなどの場合に必要です。	`getValue2()`

Anchor

	DashboardDefinition
	DashboardDefinition

Expand

title	DashboardDefinition

DashboardDefinition ElementDashboardDefinition要素	Data Typeデータ型	Description説明	Retrieval Code取得コード
TabId	Integer	ID of the dashboard tabダッシュボードタブのID	`getTabId()`
GroupTypeCode	String	Type of dashboard tab. Values include:ダッシュボードタブのタイプ。次の値があります。 ANALYTIC KPI STANDARD	`getGroupTypeCode()`
Owner	Integer	ID of dashboard ownerダッシュボード所有者のID	`getOwner()`
OwnerTypeCode	String	Type of dashboard owner. Value defaults to ORGANISATIONダッシュボード所有者のタイプ。値はデフォルトでORGANISATIONに設定されます。	`getOwnerTypeCode()`
AccessCode	String	Security level of the dashboard tabダッシュボードタブのセキュリティレベル	`getAccessCode()`
StartDate	DateCreation Date	作成日	`getStartDate()`
EndDate	DateEnd Date (if applicable)	終了日（適用される場合）	`getEndDate()`
StatusCode	String	Status of the dashboard tabダッシュボードタブのステータス	`getStatusCode()`
ShortDescription	String	Name of the dashboard tabダッシュボードタブの名前	`getShortDescription()`
LongDescription	String	Business description of the dashboard tabダッシュボードタブの説明	`getLongDescription()`
LanguageCode	String	Two letter language code2文字の言語コード	`getLanguageCode()`
StyleCode	String	Layout code. Values include:レイアウトコード。次の値があります。 SINGLE TWO THREE WIDENARROW NARROWWIDE	`getStyleCode()`
Audience	String	Audience description対象者の説明	`getAudience()`
ParentGroupId	Integer	If the dashboard tab is in draft mode, the original tab ID is saved into this columnダッシュボードタブがドラフト（編集中）モードの場合、元のタブIDがこのカラムに保存されます。	`getParentGroupId()`
Elements	Array (DashboardElement)	A DashboardElement object contains portlet information for reports that reside within the dashboard tab (See Report Service)	`getElements()`	ダッシュボードタブ内に存在するレポートのポートレット情報を含むDashboardElementオブジェクト（DashboardElementを参照）	`getElements()`
Filters	Array (DashboardFilterDefinition)	ダッシュボードタブ、分析フィルター、およびフィルターグループに関するフォーマットレコードを含むDashboardFilterDefinitionオブジェクト（DashboardFilterDefinitionを参照）	Filters	Array (DashboardFilterDefinition)	A DashboardFilterDefinition object contains format records pertaining the dashboard tab, analytic filters, and filter groups (See Report Service)	`getFilters()`
Fields	Array (DashboardFieldDefinition)	A DashboardFieldDefinition object contains format records pertaining fields being displayed as drilldowns on the dashboard tabダッシュボードタブにドリルダウンとして表示されるフィールドに関するフォーマットレコードを含むDashboardFieldDefinitionオブジェクト	`getFields()`

Anchor

	DashboardElement
	DashboardElement

Expand

title	DashboardElement

DashboardElement ElementDashboardElement要素	Data Typeデータ型	Description説明	Retrieval Code取得コード
TabId	Integer	ID of the dashboard tabダッシュボードタブのID	`getTabId()`
EntityId	Integer	ID of the portlet, which also happens to be the Report IDポートレットのID。レポートIDでもある場合があります。	`getEntityId()`
EntityTypeCode	String	Portlet entity type. Value defaults to REPORTポートレットのエンティティタイプ。値はデフォルトでREPORTに設定されます。	`getEntityTypeCode()`
ColumnNumber	Integer		Integer	カラム方向でのポートレットの位置を示します。最初のカラムは値1から始まります。Indicating where the portlet is column-wise. The first column starts at the value 1	`getColumnNumber()`
RowNumber	Integer	Indicating where the portlet is row-wise. The first row starts at the value 1ロウ方向でのポートレットの位置を示します。最初のロウは値1から始まります。	`getRowNumber()`
SequenceNumber	Integer	Portlet loading sequence within the dashboard tabダッシュボードタブ内のポートレットロード順序	`getSequenceNumber()`
StartDate	DateDate the portlet was added	ポートレットが追加された日付	`getStartDate()`
PortletStatus	String	Portlet statusポートレットのステータス	`getPortletStatus()`
PortletHeight	Integer	Portlet height in pixelsピクセル単位で示すポートレットの高さ	`getPortletHeight()`

Anchor

	DashboardFieldDefinition
	DashboardFieldDefinition

Expand

title	DashboardFieldDefinition

DashboardFieldDefinition ElementDashboardFieldDefinition要素	Data Typeデータ型	Description説明	Retrieval Code取得コード
TabId	Integer	ID of the dashboard tabダッシュボードタブのID	`getTabId()`
FieldId	Integer	Field ID of columnカラムのフィールドID	`getFieldId()`
FieldType	String	Field data type. Values include:フィールドのデータ型。次の値があります。 BOOLEAN DATE GISGEOMETRY GISMULTIPOLY GISPOINT NUMERIC TEXT TIMESTAMP	`getFieldType()`
ReportId	Integer	ID of reportレポートのID	`getReportId()`
TemplateId	Integer	対応するフィールドテンプレートレコードのIDID of corresponding field template record	`getTemplateId()`
FieldName	String	Column nameカラム名	`getFieldName()`
FieldDescription	String	Column nameカラム名	`getFieldDescription()`

Anchor

	DashboardFilterDefinition
	DashboardFilterDefinition

Expand

title	DashboardFilterDefinition

DashboardFilterDefinition ElementDashboardFilterDefinition要素	Data Typeデータ型	Description説明	Retrieval Code取得コード
GroupId	Integer	ID of the dashboard tabダッシュボードタブのID	`getGroupId()`
ComponentId	Integer	Numeric ID for the component based on the component type要素タイプに基づく要素の数値ID	`getComponentId()`
ComponentTypeCode	String	DashboardFilterDefinitionオブジェクトの要素タイプには、以下のものがあります。 FILTER（個別の分析フィルター） FILTERGROUP（分析フィルターグループ） NULL（一般的なダッシュボードタブ） Component types for a DashboardFilterDefinition object include: FILTER (individual analytic filter) FILTERGROUP (analytic filter group) NULL (general dashboard tab)	`getComponentTypeCode()`
EntityId	Integer		`getEntityId()`		`getEntityId()`
EntityTypeCode	String	DashboardFilterDefinitionオブジェクトのエンティティタイプには、以下のものがあります。 REPORT（分析フィルター） REPORTGROUP（一般的なダッシュボードタブ）	EntityTypeCode	String	Entity types for a DashboardFilterDefinition object include: REPORT (analytic filters) REPORTGROUP (general dashboard tab)	`getEntityTypeCode()`
FormatKey	String	Format Codeフォーマットコード	`getFormatKey()`
FormatValue	String	Format Valueフォーマット値	`getFormatValue()`

Anchor

	ReportFilter
	ReportFilter

Expand

title	ReportFilter

ReportFilter ElementReportFilter要素	Data Typeデータ型	Description説明	Retrieval Code取得コード
FilterId	Integer	ID of the filterフィルターのID	`getFilterId()`
IsOmitted	Boolean	If the filter is omitted by defaultフィルターをデフォルトで省略するかどうか	`getIsOmitted()`
DataValue	String	Filter values for a particular filter. If there are two values (i.e if the filter operator is BETWEEN, etc) then they are concatenated with a pipe value特定のフィルターのフィルター値。値が2つある場合（たとえば、フィルター演算子がBETWEENの場合）、値はパイプ値で連結されます。	`getDataValue()`

Anchor

	DashboardFilter
	DashboardFilter

Expand

title	DashboardFilter

DashboardFilter ElementDashboardFilter要素	Data Typeデータ型	Description説明	Retrieval Code取得コード
ReportId	Integer	ID of the report that the filter belongs toフィルターが属するレポートのID	`getReportId()`
FilterType	String	Filter operatorフィルター演算子	`getFilterType()`
FilterId	Integer	ID of the filterフィルターのID	`getFilterId()`
TabId	Integer	ID of the dashboard tab that the reportレポートがあるダッシュボードタブのID	`getTabId()`
FilterValue	String	Filter values for a particular filter. If the filter operator involves the usage of two values (i.e BETWEEN, etc) then both values are concatenated with a pipe value特定のフィルターのフィルター値。フィルター演算子で2つの値を必要とする場合（たとえば、BETWEEN）、それらの値はパイプ値で連結されます。	`getFilterValue()`
TemplateId	Integer	ID of the field template record. This applies if the Filter Type is DRILL, etcフィールドテンプレートレコードのID。フィルタータイプがDRILLなどの場合に適用されます。	`getTemplateId()`

horizontalrule

Styleclass

Class	topLink

Report Service ページトップ

Content

Space Tools

Page History

Versions Compared

Old Version 4

New Version Current

Key

関数

オブジェクト定義