Page Comparison

{anchor:top}
{toc: class=contents}

h2. Functions関数
{styleclass: Class=topLink}[topページトップ|#top]{styleclass}

h4. {expand:title=PDF}
The PDF request runs a specified report and returns it in PDF form. The following code will accomplish this:
{codePDFリクエストは指定されたレポートを実行し、それをPDF形式で返します。これを実行するコードは以下の通りです。
{code}
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);
{code}
The返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。
returned|| ReportServiceResponse応答要素 object|| consistsデータ型 of:
||Response 説明 Element||Data Type||Description 取得コード ||Retrieval
Code|| |ReportId | Integer |ID of指定されたレポートのID the| specified report|{{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 encodedPDFのBase64エンコードバイナリーチャンク binary chunk of PDF|| {{getBinaryData()}} |
| ContentType | String |MIME Content Type of this object. Value will be "application/pdf"|このオブジェクトのMIMEコンテンツタイプ。値は「application/pdf」です。 | {{getContentType()}} |
{expand}

h4. {expand:title=CSV}CSVリクエストは指定されたレポートを実行し、それをCSV形式で返します。これを実行するコードは以下の通りです。
The{code}
CSVReportServiceRequest requestrsr runs= a specified report and returns it in CSV form. The following code will accomplish this:
{code}
ReportServiceRequest rsr = new ReportServiceRequest(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);
{code}
The返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。
returned|| ReportServiceResponse応答要素 object|| consistsデータ型 of:
||Response 説明 Element||Data 取得コード Type||Description||Retrieval
Code|| |ReportId | Integer |ID of指定されたレポートのID the specified| report|{{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 encodedCSVのBase64エンコードバイナリーチャンク binary chunk of CSV|| {{getBinaryData()}} |
| ContentType | String |MIME Content Type of this object. Value will be "text このオブジェクトのMIMEコンテンツタイプ。値は「text/comma-separated-values"values」です。 | {{getContentType()}} |
{expand}

h4. {expand:title=XLS}XLSリクエストは指定されたレポートを実行し、それをXLS形式で返します。これを実行するコードは以下の通りです。
The{code}
XLSReportServiceRequest requestrsr runs= a specified report and returns it in XLS form. The following code will accomplish this:
{code}
ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;

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);
{code}
The返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。
returned|| ReportServiceResponse応答要素 object|| consistsデータ型 of:
||Response 説明 Element||Data 取得コード Type||Description||Retrieval
Code|| |ReportId | Integer |ID of指定されたレポートのID the specified| report|{{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 encodedXLSのBase64エンコードバイナリーチャンク binary chunk of XLS|| {{getBinaryData()}} |
| ContentType | String |MIME Content Type of this object. Value will be "application/xls"|このオブジェクトのMIMEコンテンツタイプ。値は「application/xls」です。 | {{getContentType()}} |
{expand}

h4. {expand:title=TEXT}TEXTリクエストは指定されたレポートを実行し、それをTEXT形式で返します。これを実行するコードは以下の通りです。
The{code}
TEXTReportServiceRequest requestrsr runs= a specified report and returns it in TEXT form. The following code will accomplish this:
{code}
ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;

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);
{code}
The返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。
returned|| ReportServiceResponse応答要素 object|| consistsデータ型 of:
||Response 説明 Element||Data 取得コード Type||Description||Retrieval
Code|| |ReportId | Integer |ID of指定されたレポートのID the specified| report|{{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 encodedXLSのBase64エンコードバイナリーチャンク binary chunk of XLS|| {{getBinaryData()}} |
| ContentType | String |MIME Content Type of this object. Value will be "text このオブジェクトのMIMEコンテンツタイプ。値は「text/tab-separated-values"values」です。 | {{getContentType()}} |
{expand}

h4. {expand:title=RTF}RTFリクエストは指定されたレポートを実行し、それをRTF形式で返します。これを実行するコードは以下の通りです。
The{code}
RTFReportServiceRequest requestrsr runs= a specified report and returns it in RTF form. The following code will accomplish this:
{code}
ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;

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);
{code}
The返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。
returned|| ReportServiceResponse応答要素 object|| consistsデータ型 of:
||Response 説明 Element||Data 取得コード Type||Description||Retrieval
Code|| |ReportId | Integer |ID of指定されたレポートのID the specified| report|{{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 encodedXLSのBase64エンコードバイナリーチャンク binary chunk of XLS|| {{getBinaryData()}} |
| ContentType | String |MIME Content Type of this object. Value will be "application/rtf"|このオブジェクトのMIMEコンテンツタイプ。値は「application/rtf」です。 | {{getContentType()}} |
{expand}

h4. {expand:title=DOC}DOCリクエストは指定されたレポートを実行し、それをDOC形式で返します。これを実行するコードは以下の通りです。
The{code}
DOCReportServiceRequest requestrsr runs= a specified report and returns it in DOC form. The following code will accomplish this:
{code}
ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;

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);
{code}
The返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。
returned|| ReportServiceResponse応答要素 object|| consistsデータ型 of:
||Response 説明 Element||Data 取得コード Type||Description||Retrieval
Code|| |ReportId | Integer |ID of指定されたレポートのID the specified| report|{{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 encodedXLSのBase64エンコードバイナリーチャンク binary chunk of XLS|| {{getBinaryData()}} |
| ContentType | String |MIME Content Type of this object. Value will be "application このオブジェクトのMIMEコンテンツタイプ。値は「application/vnd.ms-word"word」です。 | {{getContentType()}} |
{expand}

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

rsrnew 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);
{code}
The返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。
returned|| ReportServiceResponse応答要素 object|| consistsデータ型 of:
||Response 説明 Element||Data Type||Description 取得コード ||Retrieval
Code|| |ReportId | Integer |ID of指定されたレポートのID the specified| report|{{getReportId()}} |
| StatusCode | String |Status ofWebサービスリクエストのステータス the web service request|| {{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 reportYYYYMMDDHHMMSS形式で示されるレポートの最終実行時間 run time in the format of YYYYMMDDHHMMSS|| {{getLastRunTime()}} |
| ReportName | String |Name of指定されたレポートの名前 the specified| report|{{getReportName()}} |
| BinaryData | String |Base64 encodedイメージ、HTML、CSV、またはPDFのBase64エンコードバイナリーチャンク binary chunk of image, HTML, CSV, or PDF|{{getBinaryData(| {{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 of ReportRow objects that contain results in the report result set (see レポート結果セットの結果が含まれる、ReportRowオブジェクトの配列（ [ReportRow|#ReportRow]) を参照） | {{getResults()}} |
|ContentType|String|MIME ContentType of| theString returned object. Possible values include:
* "text/html"| 返されたオブジェクトのMIMEコンテンツタイプ。可能な値は以下の通りです。
* 「text/html」
* "text「text/comma-separated-values"values」
* "image「image/png"png」
* "application/pdf"|「application/pdf」 | {{getContentType()}} |
| Messages | Array (String) |Array ofレポートがサーバー上で実行されるときにデバッグ情報を示す文字列の配列。エラーのデバッグおよび追跡に使用します。 Strings that show debug information as the report is run on the server. Used for debugging and tracing errors|{{getMessages()}}|
|Charts|Array (ReportChart)|Array of ReportChart objects that contains multiple chart bitmaps when attached to a HTML report response (see [ReportChart|#ReportChart])|{{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 [ReportSchema|#ReportSchema])|{{getColumns()}}|
{expand}

h4. {expand:title=HTML / HTMLCHARTONLY / HTMLTABLEONLY}
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}
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);
{code}
The returned ReportServiceResponse object consists of:
||Response Element||Data Type||Description||Retrieval Code||
|Chart|Array (ReportChart)|Array of ReportChart objects that contains multiple chart bitmaps when attached to a HTML report response (see [ReportChart|#ReportChart])|{{getCharts()}}|
|ReportBinaryObject|Array (ReportBinaryObject)|Array of ReportBinaryObject objects that contain BLOBs and CLOBs (see [ReportBinaryObject|#ReportBinaryObject])|{{getBinaryObjects()}}|
|ReportStyles|String|CSS styles|{{getReportStyles()}}|
|Breadcrumbs|Array (Breadcrumb)|Array of Breadcrumb objects|{{getBreadcrumbs()}}|
|SeriesSelection|Array (SeriesSelection)|Array of SeriesSelection objects|{{getSeriesSelections()}}|
|TimeAggregationSelection|Array (TimeAggregationSelection)|Array of TimeAggregationSelection objects|{{getTimeAggregationSelection()}}|
|ReportTabSelection|Array (ReportTabSelection)|Array of ReportTabSelection objects|{{getReportTabSelection()}}|
|ReportPageSelection|Array (ReportPageSelection)|Array of ReportPageSelection objects|{{getReportPageSelection()}}|
|TimeSliderSelection|Array (TimeSliderSelection)|Array of TimeSliderSelection objects|{{getTimeSliderSelection()}}|
|SortableColumns|Array (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)|{{getSelectedSortOrder()}}|
|DrillCode|String|Drill type if available on the report|{{getDrillCode()}}|
|RelatedReports|Array (RelatedReport)|Array of RelatedReport objects. These are reports that are tabbed/codisplayed to the main report|{{getRelatedReports()}}|
|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|String|MIME ContentType of the returned object. Value will be "text/html"|{{getContentType()}}|
|CanDrill|Boolean|If the report is able to drill or not|{{getCanDrill()}}|
|GoogleMaps|Array (GMap)|Array of GMap objects|{{getGoogleMaps()}}|
| {{getMessages()}} |
| Charts | Array (ReportChart) | HTMLレポート応答に付加される、複数のグラフビットマップを含むReportChartオブジェクトの配列 （ [ReportChart|#ReportChart]を参照） | {{getCharts()}} |
| Columns | Array (ReportSchema) | レポート結果セットの各カラムの情報、およびユーザープロンプトフィルターデータをレポートに渡す必要があるかどうかを示す情報が含まれるReportSchemaオブジェクトの配列（[ReportSchema|#ReportSchema]を参照） | {{getColumns()}} |{expand}

h4. {expand:title=HTML / HTMLCHARTONLY / HTMLTABLEONLY}HTMLリクエストは、レポートをHTMLで表現したものを返します。HTMLドキュメントはBase64でエンコードされ、グラフとイメージがCharts配列フィールドに格納されます。これらのアーティファクトはクライアントシステムにより手動でデコードする必要があります。また、Base64イメージのデコード用に、URLリクエスト文字列を使用してHTML内にURLが埋め込まれます。
これを実行するコードは以下の通りです。
{code}
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);
{code}
返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。
|| 応答要素 || データ型 || 説明 || 取得コード ||
| Chart | Array (ReportChart) | HTMLレポート応答に付加される、複数のグラフビットマップを含むReportChartオブジェクトの配列 （[ReportChart|#ReportChart]を参照） | {{getCharts()}} |
| ReportBinaryObject | Array (ReportBinaryObject) | BLOBおよびCLOBを含むReportBinaryObjectオブジェクトの配列 （[ReportBinaryObject|#ReportBinaryObject]を参照） | {{getBinaryObjects()}} |
| ReportStyles | String | CSSスタイル | {{getReportStyles()}} |
| Breadcrumbs | Array (Breadcrumb) | Breadcrumbオブジェクトの配列 | {{getBreadcrumbs()}} |
| SeriesSelection | Array (SeriesSelection) | SeriesSelectionオブジェクトの配列 | {{getSeriesSelections()}} |
| TimeAggregationSelection | Array (TimeAggregationSelection) | TimeAggregationSelectionオブジェクトの配列 | {{getTimeAggregationSelection()}} |
| ReportTabSelection | Array (ReportTabSelection) | ReportTabSelectionオブジェクトの配列 | {{getReportTabSelection()}} |
| ReportPageSelection | Array (ReportPageSelection) | ReportPageSelectionオブジェクトの配列 | {{getReportPageSelection()}} |
| TimeSliderSelection | Array (TimeSliderSelection) | TimeSliderSelectionオブジェクトの配列 | {{getTimeSliderSelection()}} |
| SortableColumns | Array (SortableTableColumn) | SortableTableColumnオブジェクトの配列 | {{getSortableColumns()}} |
| SelectedSortColumn | Integer | 並べかえに使用するカラム。このインデックスは、レポート内のカラムインデックスに適用されます。 | {{getSelectedSortColumn()}} |
| SelectedSortOrder | Integer | 並べかえに使用するカラムの並べかえ順序（0が昇順、1が降順） | {{getSelectedSortOrder()}} |
| DrillCode | String | ドリルタイプ（レポートで使用可能な場合） | {{getDrillCode()}} |
| RelatedReports | Array (RelatedReport) | RelatedReportオブジェクトの配列。これは、メインレポートにマルチ表示（タブ化）されるレポートです。| {{getRelatedReports()}} |
| BinaryData | String | HTMLドキュメントのBase64エンコードバイナリーチャンク | {{getBinaryData()}} |
| Private | | レポートが個人用または共有のいずれであるかを判別します。 | {{getPrivate()}} |
| ContentType | String | 返されたオブジェクトのMIMEコンテンツタイプ。値は「text/html」です。 | {{getContentType()}} |
| CanDrill | Boolean | レポートがドリル可能かどうか | {{getCanDrill()}} |
| GoogleMaps | Array (GMap) | GMapオブジェクトの配列 | {{getGoogleMaps()}} |{expand}

h4. {expand:title=FILTEROPTIONS}FILTEROPTIONSリクエストは、特定のレポートのフィルターで使用可能なフィルター値を返します。
これを実行するコードは以下の通りです。
{code}
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);
{code}
返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。
|| 応答要素 || データ型 || 説明 || 取得コード ||
| Results | Array (ReportRow) | フィルター値を含むReportRowオブジェクトの配列（[ReportRow|#ReportRow]を参照） | {{getResults()}} |{expand}

h4. {expand:title=RESULTSET}RESULTSETリクエストは、特定のレポートの結果データセットを返します。この結果はReportRowオブジェクトの配列に格納され、各ReportRowオブジェクトがレポートデータセットの1つのロウを表します。ReportRowオブジェクトは、データセットの各カラムのデータを表す文字列の配列でも構成されます。
このデータを文字列表現から特定のカラムのデータ型に変換するのは、Webサービスクライアントの役割です。各カラムのデータ型は、SCHEMAリクエスト関数呼び出しにより取得できます。
これを実行するコードは以下の通りです。
{code}
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);
{code}
返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。
|| 応答要素 || データ型 || 説明 || 取得コード ||
| Results | Array (ReportRow) | レポート結果セットの結果が含まれる、ReportRowオブジェクトの配列（[ReportRow|#ReportRow]を参照） | {{getResults()}} |{expand}

h4. {expand:title=FILTEROPTIONSEXPIRESESSION}EXPIRESESSIONリクエストは、指定されたYellowfinセッションを期限切れにします。
Theこれを実行するコードは以下の通りです。
FILTEROPTIONS{code}
request will return the filter values available for a particular report's filter.

The following code will accomplish this:
{code}
ReportServiceRequest rsr 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("FILTEROPTIONSEXPIRESESSION");
// This is the ReportSession ID
rsr.setReportId(12345);
// This is the Filter ID
rsr.setObjectName("11111setSessionId("5361781d-c3aa-4c97-bc13-883210ff8a6e");

rs = ReportService.remoteAdministrationCall(rsr);
{code}{expand}
The
returned ReportServiceResponse object consists of:
||Response Element||Data Type||Description||Retrieval Code||
|Results|Array (ReportRow)|Array of ReportRow objects that contain filter values (see [ReportRow|#ReportRow])|{{getResults()}}|
{expand}

h4. {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}
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);
{code}
The returned ReportServiceResponse object consists of:
||Response Element||Data Type||Description||Retrieval Code||
|Results|Array (ReportRow)|Array of ReportRow objects that contain results in the report result set (see [ReportRow|#ReportRow])|{{getResults()}}|
{expand}

h4. {expand:title=EXPIRESESSION}
The EXPIRESESSION request will cause a specified Yellowfin session to expire.

The following code will accomplish this:
{code}
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);
{code}
{expand}

h4. {expand:title=GETCOMMENTS}
The GETCOMMENTS request will retrieve all comments for a particular report.

The following code will accomplish this:
{code}
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);
{code}
The returned ReportServiceResponse object consists of:
||Response Element||Data Type||Description||Retrieval Code||
|Comments|Array (ReportComment)|Array of ReportComment objects that contain the report's comments (see [ReportComment|#ReportComment])|{{getComments()}}|
{expand}

h4. {expand:title=LEAVECOMMENT}
The LEAVECOMMENT request will create a comment/response to a comment in a particular report.

The following code will accomplish this:
{code}
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);
{code}
{expand}

h4. {expand:title=DELETECOMMENT}
The DELETECOMMENT request will delete the particular comment from a report.

The following code with accomplish this:
{code}
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);
{code}
{expand}

h4. {expand:title=COMMENTSTATUS}
The COMMENTSTATUS request will set the status of a particular comment.

The following code will accomplish this:
{code}
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);
{code}
{expand}

h4. {expand:title=DISTRIBUTEINBOX}
The DISTRIBUTEINBOX request will distribute a report to the inboxes of a list of recipients.

The following code will accomplish this:
{code}
ReportServiceRequest rsr h4. {expand:title=GETCOMMENTS}GETCOMMENTSリクエストは、特定のレポートについてすべてのコメントを取得します。
これを実行するコードは以下の通りです。
{code}
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(reportoptionssetOrgId(new Integer(1));
rsr.setReportIdsetReportRequest(12345"GETCOMMENTS");
// This is anthe optionalReport distribution text for all recipients
ID
rsr.setDistributionText("A message for recipients"setReportId(12345);

rs = ReportService.remoteAdministrationCall(rsr);
{code}
{expand}返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。
|| h4. {expand:title=GETDISPLAYEDREPORTID}
The GETDISPLAYEDREPORTID request will return the report ID of the currently displayed report.

The following code will accomplish this:
応答要素 || データ型 || 説明 || 取得コード ||
| Comments | Array (ReportComment) | レポートのコメントを含むReportCommentオブジェクトの配列（[ReportComment|#ReportComment]を参照) | {{getComments()}} |{expand}

h4. {expand:title=LEAVECOMMENT}LEAVECOMMENTリクエストは、特定のレポートにコメントまたはコメントに対する応答を作成します。
これを実行するコードは以下の通りです。
{code}
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)) 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.setReportRequestsetReportComment("GETDISPLAYEDREPORTID"comment);

rs = ReportService.remoteAdministrationCall(rsr);
{code}
The returned ReportServiceResponse object consists of:
||Response Element||Data Type||Description||Retrieval Code||
|DisplayedReportId|Integer|Report ID of the currently displayed report|{{getDisplayedReportId()}}|
{expand}

h4. {expand:title=GETKPI}
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:DELETECOMMENT}DELETECOMMENTリクエストは、レポートから特定のコメントを削除します。
これを実行するコードは以下の通りです。
{code}
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);
{code}{expand}

h4. {expand:title=COMMENTSTATUS}COMMENTSTATUSリクエストは、特定のコメントのステータスを設定します。
これを実行するコードは以下の通りです。
{code}
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("GETKPI");
rsr.setReportId(12345COMMENTSTATUS");

rs = ReportService.remoteAdministrationCall(rsrcomment.setCommentId(702);
{code}// The returnedavailable ReportServiceResponsestatus objectcodes consistsare of:
||Response Element||Data Type||Description||Retrieval Code||
|KPI|KPI object|This is a custom KPI object which holds the actual, target, and variance values for a particular KPI metric (see [KPI|#KPI])|{{getKPI()}}|
OPEN, RESOLVED, or DELETED
comment.setStatusCode("OPEN");
rsr.setReportComment(comment);

rs = ReportService.remoteAdministrationCall(rsr);
{code}{expand}

h4. {expand:title=GETDRILLANYWHEREMENUDISTRIBUTEINBOX}DISTRIBUTEINBOXリクエストは、一覧に含まれる受信者の受信トレイにレポートを配信します。
Theこれを実行するコードは以下の通りです。
GETDRILLANYWHEREMENU{code}
requestReportServiceRequest willrsr 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}
ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = nullnew 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("GETDRILLANYWHEREMENUDISTRIBUTEINBOX");
rsr.setReportOptions(reportoptions);
rsr.setReportId(12345);
// This is an integeroptional fielddistribution whichtext isfor theall Field ID of the selected column
recipients
rsr.setDrillAnywhereFieldId(3);
// This is the actual value of the column
rsr.setDrillAnywhereCellValue("5000"setDistributionText("A message for recipients");

rs = ReportService.remoteAdministrationCall(rsr);
{code}{expand}
The returned ReportServiceResponse object consists of:
||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 [DrillAnywhereTarget|#DrillAnywhereTarget])|{{getDrillAnywhereTargets()}}|
{expand}

h4. {expand:title=SUBSCRIBEDETAILS}
The SUBSCRIBEDETAILS request will return the schedule record for a particular report.

The following code will accomplish this:

h4. {expand:title=GETDISPLAYEDREPORTID}GETDISPLAYEDREPORTIDリクエストは、現在表示されているレポートのレポートIDを返します。
これを実行するコードは以下の通りです。
{code}
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);
{code}
返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。
|| 応答要素 || データ型 || 説明 || 取得コード ||
| DisplayedReportId | Integer | 現在表示されているレポートのレポートID | {{getDisplayedReportId()}} |{expand}

h4. {expand:title=GETKPI}GETKPIリクエストは、特定のKPIレポートについてKPIオブジェクトを返します。この関数リクエストは通常、モバイルアプリケーション内で利用されます。
これを実行するコードは以下の通りです。
{code}
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("SUBSCRIBEDETAILSGETKPI");
rsr.setReportId(12345):
// This is the ID of the user to be subscribed
rsr.setReportUserId(19090);

rs = ReportService.remoteAdministrationCall(rsr);
sr = rs.getSchedule();
{code}
The returned ReportServiceResponse object consists of:
||Response Element||Data Type||Description||Retrieval Code||
|ScheduleRecord|ScheduleRecord object|ScheduleRecord object which contains subscription details and conditions (see [ScheduleRecord|#ScheduleRecord])|{{getSchedule()}}|
{expand}

h4. {expand:title=SUBSCRIBE}
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 [ScheduleRecord|#ScheduleRecord]) for this function call.

The following code will accomplish this:;

rs = ReportService.remoteAdministrationCall(rsr);
{code}
返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。
|| 応答要素 || データ型 || 説明 || 取得コード ||
| KPI | KPI object | 特定のKPIメトリック（数値）について、実績、目標、および差異の値を保持するカスタムKPIオブジェクト（[KPI|#KPI]を参照） | {{getKPI()}} |{expand}

h4. {expand:title=GETDRILLANYWHEREMENU}GETDRILLANYWHEREMENUリクエストは、選択されたレポートカラムで使用できる「ドリルエニウェア」メニューを返します。この関数リクエストは通常、モバイルアプリケーション内で利用されます。
これを実行するコードは以下の通りです。
{code}
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);
{code}
返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。
|| 応答要素 || データ型 || 説明 || 取得コード ||
| DrillAnywhereCategories | Array (String) | 文字列の配列 | {{getDrillAnywhereCategories()}} |
| DrillAnywhereTargets | Array (DrillAnywhereTarget) | ドリルエニウェアカテゴリーのドリルエニウェア目標を一覧表示するDrillAnywhereTargetオブジェクトの配列（[DrillAnywhereTarget|#DrillAnywhereTarget]を参照） | {{getDrillAnywhereTargets()}} |{expand}

h4. {expand:title=SUBSCRIBEDETAILS}SUBSCRIBEDETAILSリクエストは、特定のレポートのスケジュールレコードを返します。
これを実行するコードは以下の通りです。
{code}
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);
{code}
{expand}

h4. {expand:title=UNSUBSCRIBE}
The UNSUBSCRIBE request will unsubscribe a specified user from a specified report.

The following code will accomplish this:
{code}
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(19090ScheduleRecord 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();
{code}
返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。
|| 応答要素 || データ型 || 説明 || 取得コード ||
| ScheduleRecord | ScheduleRecord object | 購読詳細と条件を含むScheduleRecordオブジェクト（[ScheduleRecord|#ScheduleRecord]を参照） | {{getSchedule()}} |{expand}

h4. {expand:title=SUBSCRIBE}SUBSCRIBEリクエストは、指定されたユーザーの指定のレポートに対する購読を作成/変更します。この関数リクエストは通常、まず現在の購読を取得するために、SUBSCRIBEDETAILSのあとに呼び出されます。そうでない場合、この関数呼び出しのために、ScheduleRecordオブジェクトを作成して適切なデータを投入する必要があります（[ScheduleRecord|#ScheduleRecord]を参照）。
これを実行するコードは以下の通りです。
{code}
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);
{code}
{expand}

h4. {expand:title=LOADDASHBOARDTABUNSUBSCRIBE}
The LOADDASHBOARDTAB request will load a specified dashboard tab and its metadata.

The following code will accomplish this:
UNSUBSCRIBEリクエストは、指定のレポートから指定されたユーザーの購読を取り消します。
これを実行するコードは以下の通りです。
{code}
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();
{code}
The returned ReportServiceResponse object consists of:
||Response Element||Data Type||Description||Retrieval Code||
|DashboardDefinition|DashboardDefinition object|DashboardDefinition object which contains dashboard tab metadata (see [DashboardDefinition|#DashboardDefinition])|{{getDashboard()}}|
{expand}

h4. {expand:title=APPLYDASHBOARDFILTERS}
The following code will accomplish this:UNSUBSCRIBE");
rsr.setReportId(12345):
// This is the ID of the user to be subscribed
rsr.setReportUserId(19090);

rs = ReportService.remoteAdministrationCall(rsr);
{code}{expand}

h4. {expand:title=LOADDASHBOARDTAB}LOADDASHBOARDTABリクエストは、指定されたダッシュボードタブとそのメタデータをロードします。
これを実行するコードは以下の通りです。
{code}
ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
DashboardFilter[]DashboardDefinition dfarraydd = 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("APPLYDASHBOARDFILTERSLOADDASHBOARDTAB");
// 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;ダッシュボードタブのID
rsr.setDashboardFilterssetDashboardTabId(dfarray11111);

rs = ReportService.remoteAdministrationCall(rsr);
{code}
{expand}

h4. {expand:title=GETDASHBOARDREPORTFILTERVALUES}
The GETDASHBOARDREPORTFILTERVALUES request will return filter metadata for a particular report on a dashboard tab.

The following code will accomplish this:dd = rs.getDashboard();
{code}
返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。
|| 応答要素 || データ型 || 説明 || 取得コード ||
| DashboardDefinition | DashboardDefinition object | ダッシュボードタブのメタデータを含むDashboardDefinitionオブジェクト（[DashboardDefinition|#DashboardDefinition]を参照） | {{getDashboard()}} |{expand}

h4. {expand:title=APPLYDASHBOARDFILTERS}これを実行するコードは以下の通りです。
{code}
ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
ReportFilter[] rfDashboardFilter[] dfarray = null;
DashboardFilter df = nullnew DashboardFilter();

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

rs = ReportService.remoteAdministrationCall(rsr);
rf = rs.getReportFilters();
{code}
The returned ReportServiceResponse object consists of:
||Response Element||Data Type||Description||Retrieval Code||
|ReportFilters|Array (ReportFilter)|Array of Filter objects containing metadata for each filter (see [ReportFilter|#ReportFilter])|{{getReportFilters()}}|
{expand}

h4. {expand:title=RUNDASHBOARDREPORT}
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: ダッシュボードタブのID
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);
{code}{expand}

h4. {expand:title=GETDASHBOARDREPORTFILTERVALUES}GETDASHBOARDREPORTFILTERVALUESリクエストは、ダッシュボードタブの特定のレポートに対するフィルターメタデータを返します。
これを実行するコードは以下の通りです。
{code}
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
rsr.setDashboardTabId(11111);
rs.getReportId(22222);

rs = ReportService.remoteAdministrationCall(rsr);
rf = rs.getReportFilters();
{code}
返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。
|| 応答要素 || データ型 || 説明 || 取得コード ||
| ReportFilters | Array (ReportFilter) | 各フィルターのメタデータを含むFilterオブジェクトの配列（[ReportFilter|#ReportFilter]を参照） | {{getReportFilters()}} |{expand}

h4. {expand:title=RUNDASHBOARDREPORT}RUNDASHBOARDREPORTリクエストは、ダッシュボードタブの指定されたレポートを実行し、エクスポートします。応答には、グラフ、GISマップ、およびCSSスタイルを含む、Base64エンコードで生成されたHTMLが含まれます。
これを実行するコードは以下の通りです。
{code}
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
ダッシュボードタブのID
rsr.setDashboardTabId(11111);
rs.getReportId(22222);

rs = ReportService.remoteAdministrationCall(rsr);
{code}
The返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。
returned|| ReportServiceResponse応答要素 object consists of:|| データ型 ||Response 説明 Element||Data Type||Description||Retrieval Code 取得コード ||
|BinaryData|String|Base64 encoded binary chunk of HTML|| BinaryData | String | HTMLのBase64エンコードバイナリーチャンク | {{getBinaryData()}} |
| Charts | Array (ReportChart) |Array of ReportChart objects (see  ReportChartオブジェクトの配列（[ReportChart|#ReportChart])を参照） | {{getCharts()}} |
| ReportStyle | String |CSS CSSスタイル styles| {{GetReportStyle()}} |
| Breadcrumbs | Array (Breadcrumb) |Array ofBreadcrumbオブジェクトの配列 Breadcrumb| objects|{{getBreadcrumbs()}} |
| GoogleMaps | Array (GMap) |Array ofGoogleMapsオブジェクトの配列（レポートのグラフで使用されている場合） GoogleMaps objects if the report's chart uses it|| {{getGoogleMaps()}} |
| GisMap | Array (GISMap) |Array ofISMapオブジェクトの配列（レポートのグラフで使用されている場合） GISMap objects if the report's chart uses it|| {{getGisMap()}} |
{expand}


h2. Object Definitionsオブジェクト定義
{styleclass: Class=topLink}[topページトップ|#top]
{styleclass}

{anchor:ReportComment}

h4. {expand:title=ReportComment}

||ReportComment ReportComment要素 Element||Data データ型 Type||Description 説明 ||Retrieval 取得コード Code||
| CommentId | Integer |ID ofコメントのID comment| {{getCommentId()}} |
| AuthorId | Integer |ID ofコメント作成者のID comment| author|{{getAuthorId()}} |
| Comment | String |Comment コメントの値 value| {{getComment()}} |
| ReportId | Integer |Report IDコメントが存在するレポートのID of which the comment resides on|| {{getReportId()}}|
|ParentCommentId|Integer|Main ID of comment it is connected to. This applies if the particular comment is a reply to a parent comment|}} |
| ParentCommentId | Integer | コメントが関連付けられているメイン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()}} |
{expand}

{anchor:ReportRow}

h4. {expand:title=ReportRow}
|| ReportRow 要素 Element||Data Type||Description データ型 ||Retrieval Code||説明 |DataValue|Array (String)|Array of Strings with data for each column in the report result set| 取得コード ||
| DataValue | Array (String) | レポート結果セットの各カラムのデータを含む文字列の配列 | {{getDataValue()}} |
{expand}

{anchor:ReportChart}

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

{anchor:ReportSchema}

h4. {expand:title=ReportSchema}
||ReportSchema ReportSchema要素 Element||Data データ型 Type||Description 説明 ||Retrieval 取得コード Code||
| ColumnName | String |Column カラム名 Name| {{getColumnName()}} |
| DisplayName | String |Display nameカラムの表示名 of| column|{{getDisplayName()}} |
| FieldId | Integer |Field IdカラムのフィールドID of| column|{{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フィルターID（カラムがフィルターの場合） if the column is a filter|| {{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| | {{getFilterOmittable()}} |
| ParentFilterId | Integer | 親フィルターのフィルターID（フィルターの従属関係が設定されている場合） | {{getParentId()}} |
| DefaultValue1 | |First default value for filter if set|フィルターの最初のデフォルト値（設定されている場合） | {{getDefaultValue1()}} |
| DefaultValue2 | |Second defaultフィルターの2番目のデフォルト値（設定されている場合） value for filter if set|| {{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()}} |
{expand}

{anchor:ReportBinaryObject}

h4. {expand:title=ReportBinaryObject}
||ReportBinaryObject ReportBinaryObject要素 Element||Data データ型 Type||Description 説明 ||Retrieval 取得コード Code||
| ContentType | String |MIME ContentMIMEコンテンツタイプ Type| {{getContentType()}} |
| Data | String |Base64 binaryBase64バイナリーデータ data| {{getData()}} |
| Key | String |Key ofReportBinaryObjectオブジェクトのキー the ReportBinaryObject| object|{{getKey()}} |
{expand}

{anchor:KPI}

h4. {expand:title=KPI}
||KPI KPI要素 Element||Data データ型 Type||Description 説明 ||Retrieval 取得コード Code||
| Actual | String |The actualKPIメトリック（数値）の実績値 value for a KPI metric|| {{getActual()}} |
| Target|String|The target value for a KPI metric| | String | KPIメトリック（数値）の目標値 | {{getTarget()}} |
| Variance | String |The variance value for a KPI metric|KPIメトリック（数値）の差異値 | {{getVariance()}} |
{expand}

{anchor:DrillAnywhereTarget}

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

{anchor:ScheduleRecord}

h4. {expand:title=ScheduleRecord}
||ScheduleRecord ScheduleRecord要素 Element||Data データ型 Type||Description 説明 ||Retrieval 取得コード Code||
| Recipient|Integer |ID ofInteger recipient| of購読の受信者のID the| subscription|{{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 of Condition objects that store delivery rules (see  配信ルールを格納するConditionオブジェクトの配列（[Condition|#Condition])	を参照） | {{getConditionList()}} |
| AdvancedTimezoneCode | String |Timezone in購読が行われるタイムゾーン which the subscription happens|| {{getAdvancedTimezoneCode()}} |
| AdvancedTime | Integer |Local run購読のローカル実行時間 time for the subscription|| {{getAdvancedTime()}} |
{expand}

{anchor:Condition}

h4. {expand:title=Condition}
||Condition Condition要素 Element||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カラムのフィールドID of| column|{{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()}} |
{expand}

{anchor:DashboardDefinition}

h4. {expand:title=DashboardDefinition}
||DashboardDefinition DashboardDefinition要素 Element||Data データ型 Type||Description 説明 ||Retrieval 取得コード Code||
| TabId | Integer |ID ofダッシュボードタブのID the dashboard| tab|{{getTabId()}} |
| GroupTypeCode | String |Type of dashboard tab. Values include:
ダッシュボードタブのタイプ。次の値があります。
* ANALYTIC
* KPI
* STANDARD | {{getGroupTypeCode()}} |
| Owner | Integer|ID of| dashboardダッシュボード所有者のID owner| {{getOwner()}} |
| OwnerTypeCode | String |Type of dashboard owner. Value defaults to ORGANISATION|ダッシュボード所有者のタイプ。値はデフォルトでORGANISATIONに設定されます。 | {{getOwnerTypeCode()}} |
| AccessCode | String |Security levelダッシュボードタブのセキュリティレベル of the dashboard tab|| {{getAccessCode()}} |
| StartDate | Date |Creation 作成日 Date| {{getStartDate()}} |
| EndDate | Date |End 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 letter2文字の言語コード language| code|{{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) | ダッシュボードタブ内に存在するレポートのポートレット情報を含むDashboardElementオブジェクト（ [DashboardElement|#DashboardElement])を参照） | {{getElements()}} |
| Filters | Array (DashboardFilterDefinition) |A DashboardFilterDefinition object contains format records pertaining the dashboard tab, analytic filters, and filter groups (See  ダッシュボードタブ、分析フィルター、およびフィルターグループに関するフォーマットレコードを含むDashboardFilterDefinitionオブジェクト（ [DashboardFilterDefinition|#DashboardFilterDefinition])を参照） | {{getFilters()}} |
| Fields | Array (DashboardFieldDefinition) |A DashboardFieldDefinition object contains format records pertaining fields being displayed as drilldowns on the dashboard tab|ダッシュボードタブにドリルダウンとして表示されるフィールドに関するフォーマットレコードを含むDashboardFieldDefinitionオブジェクト | {{getFields()}} |
{expand}

{anchor:DashboardElement}

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

{anchor:DashboardFieldDefinition}

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

{anchor:DashboardFilterDefinition}

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

{anchor:ReportFilter}

h4. {expand:title=ReportFilter}
||ReportFilter ReportFilter要素 Element||Data データ型 Type||Description 説明 ||Retrieval 取得コード Code||
| FilterId | Integer |ID ofフィルターのID the| filter|{{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|フィルターをデフォルトで省略するかどうか | {{getIsOmitted()}} |
| DataValue | String | 特定のフィルターのフィルター値。値が2つある場合（たとえば、フィルター演算子がBETWEENの場合）、値はパイプ値で連結されます。 | {{getDataValue()}} |
{expand}

{anchor:DashboardFilter}

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

\\
\\
{horizontalrule}
{styleclass: Class=topLink}[topページトップ|#top]
{styleclass}