...
関数
注意：こちらに掲載されているすべてのコードは、「疑似コード」です。実際に使用するコードは、ユーザーの使用環境により異なります。こちらの例は、あくまで参照目的でご利用ください。
| Expand |
|---|
|
PDFリクエストは指定されたレポートを実行し、それをPDF形式で返します。これを実行するコードは以下の通りです。PDFリクエストは、指定されたレポートを実行し、それをPDF形式で返します。これを実行するコードは、以下の通りです。 | Code Block |
|---|
ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
ReportService rss = new ReportService();
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 = rssReportService.remoteReportCall(rsr);
|
返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。返される「ReportServiceResponse」オブジェクトは、以下の項目で構成されます。 | 応答要素 | データ型 | 説明 | 取得コード | ReportId | Integer | 指定されたレポートのID指定されたレポートのIDです。 | getReportId()
| ReportName | String | 指定されたレポートの名前指定されたレポートの名前です。 | getReportName()
| HitCount | Integer | 指定されたレポートがアクセスされた回数指定されたレポートがアクセスされた回数です。 | getHitCount()
| FormatCode | String | 指定されたレポートのフォーマットコード指定されたレポートの書式コードです。 | getFormatCode()
| BinaryData | StringPDFのBase64エンコードバイナリーチャンク | Base64でエンコードされたPDFのバイナリーチャンクです。 | getBinaryData()
| ContentType | String | このオブジェクトのMIMEコンテンツタイプ。値は「applicationこのオブジェクトのMIMEコンテンツタイプです。値は「application/pdf」です。pdf」です。 | getContentType()
|
|
| Expand |
|---|
|
CSVリクエストは指定されたレポートを実行し、それをCSV形式で返します。これを実行するコードは以下の通りです。CSVリクエストは、指定されたレポートを実行し、それをCSV形式で返します。これを実行するコードは、以下の通りです。 | Code Block |
|---|
ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
ReportService rss = new ReportService();
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 = rssReportService.remoteReportCall(rsr);
|
返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。返される「ReportServiceResponse」オブジェクトは、以下の項目で構成されます。 | 応答要素 | データ型 | 説明 | 取得コード | ReportId | Integer | 指定されたレポートのID指定されたレポートのIDです。 | getReportId()
| ReportName | String | 指定されたレポートの名前指定されたレポートの名前です。 | getReportName()
| HitCount | Integer | 指定されたレポートがアクセスされた回数指定されたレポートがアクセスされた回数です。 | getHitCount()
| FormatCode | String | 指定されたレポートのフォーマットコード指定されたレポートの書式コードです。 | getFormatCode()
| BinaryData | StringCSVのBase64エンコードバイナリーチャンク | Base64でエンコードされたCSVのバイナリーチャンクです。 | getBinaryData()
| ContentType | String | このオブジェクトのMIMEコンテンツタイプ。値は「textこのオブジェクトのMIMEコンテンツタイプです。値は「text/comma-separated-values」です。values」です。 | getContentType()
|
|
| Expand |
|---|
|
XLSリクエストは指定されたレポートを実行し、それをXLS形式で返します。これを実行するコードは以下の通りです。XLSリクエストは、指定されたレポートを実行し、それをXLS形式で返します。これを実行するコードは、以下の通りです。 | Code Block |
|---|
ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
ReportService rss = new ReportService();
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 = rssReportService.remoteReportCall(rsr);
|
返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。返される「ReportServiceResponse」オブジェクトは、以下の項目で構成されます。 | 応答要素 | データ型 | 説明 | 取得コード | ReportId | Integer | 指定されたレポートのID指定されたレポートのIDです。 | getReportId()
| ReportName | String | 指定されたレポートの名前指定されたレポートの名前です。 | getReportName()
| HitCount | Integer | 指定されたレポートがアクセスされた回数指定されたレポートがアクセスされた回数です。 | getHitCount()
| FormatCode | String | 指定されたレポートのフォーマットコード指定されたレポートの書式コードです。 | getFormatCode()
| BinaryData | StringXLSのBase64エンコードバイナリーチャンク | Base64でエンコードされたXLSのバイナリーチャンクです。 | getBinaryData()
| ContentType | String | このオブジェクトのMIMEコンテンツタイプ。値は「applicationこのオブジェクトのMIMEコンテンツタイプです。値は「application/xls」です。xls」です。 | getContentType()
|
|
| Expand |
|---|
|
TEXTリクエストは指定されたレポートを実行し、それをTEXT形式で返します。これを実行するコードは以下の通りです。TEXTリクエストは、指定されたレポートを実行し、それをTEXT形式で返します。これを実行するコードは、以下の通りです。 | Code Block |
|---|
ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
ReportService rss = new ReportService();
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 = rssReportService.remoteReportCall(rsr);
|
返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。返される「ReportServiceResponse」オブジェクトは、以下の項目で構成されます。 | 応答要素 | データ型 | 説明 | 取得コード | ReportId | Integer | 指定されたレポートのID指定されたレポートのIDです。 | getReportId()
| ReportName | String | 指定されたレポートの名前指定されたレポートの名前です。 | getReportName()
| HitCount | Integer | 指定されたレポートがアクセスされた回数指定されたレポートがアクセスされた回数です。 | getHitCount()
| FormatCode | String | 指定されたレポートのフォーマットコード指定されたレポートの書式コードです。 | getFormatCode()
| BinaryData | StringXLSのBase64エンコードバイナリーチャンク | Base64でエンコードされたXLSのバイナリーチャンクです。 | getBinaryData()
| ContentType | String | このオブジェクトのMIMEコンテンツタイプ。値は「textこのオブジェクトのMIMEコンテンツタイプです。値は「text/tab-separated-values」です。values」です。 | getContentType()
|
|
| Expand |
|---|
|
RTFリクエストは指定されたレポートを実行し、レポートをRTF形式で返します。これを実行するコードは以下の通りです。RTFリクエストは、指定されたレポートを実行し、レポートをRTF形式で返します。これを実行するコードは、以下の通りです。 | Code Block |
|---|
ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
ReportService rss = new ReportService();
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 = rssReportService.remoteReportCall(rsr);
|
返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。返される「ReportServiceResponse」オブジェクトは、以下の項目で構成されます。 | 応答要素 | データ型 | 説明 | 取得コード | ReportId | Integer | 指定されたレポートのID指定されたレポートのIDです。 | getReportId()
| ReportName | String | 指定されたレポートの名前指定されたレポートの名前です。 | getReportName()
| HitCount | Integer | 指定されたレポートがアクセスされた回数指定されたレポートがアクセスされた回数です。 | getHitCount()
| FormatCode | String | 指定されたレポートのフォーマットコード指定されたレポートの書式コードです。 | getFormatCode()
| BinaryData | String | XLSのBase64エンコードバイナリーチャンクBase64でエンコードされたRTFのバイナリーチャンクです。 | getBinaryData()
| ContentType | String | このオブジェクトのMIMEコンテンツタイプ。値は「applicationこのオブジェクトのMIMEコンテンツタイプです。値は「application/rtf」です。rtf」です。 | getContentType()
|
|
| Expand |
|---|
|
DOCリクエストは指定されたレポートを実行し、それをDOC形式で返します。これを実行するコードは以下の通りです。DOCリクエストは、指定されたレポートを実行し、それをDOC形式で返します。これを実行するコードは、以下の通りです。 | Code Block |
|---|
ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
ReportService rss = new ReportService();
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 = rssReportService.remoteReportCall(rsr);
|
返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。返される「ReportServiceResponse」オブジェクトは、以下の項目で構成されます。 | 応答要素 | データ型 | 説明 | 取得コード取得データ | ReportId | Integer | 指定されたレポートのID指定されたレポートのIDです。 | getReportId()
| ReportName | String | 指定されたレポートの名前指定されたレポートの名前です。 | getReportName()
| HitCount | Integer | 指定されたレポートがアクセスされた回数指定されたレポートがアクセスされた回数です。 | getHitCount()
| FormatCode | String | 指定されたレポートのフォーマットコード指定されたレポートの書式コードです。 | getFormatCode()
| BinaryData | String | XLSのBase64エンコードバイナリーチャンクBase64でエンコードされたDOCのバイナリーチャンクです。 | getBinaryData()
| ContentType | String | このオブジェクトのMIMEコンテンツタイプ。値は「applicationこのオブジェクトのMIMEコンテンツタイプです。値は「application/vnd.ms-word」です。word」です。 | getContentType()
|
|
| Expand |
|---|
|
SCHEMAリクエストは、指定されたレポートについて、レポートのカラムおよびフィルターのメタデータも含むスキーマ情報を返します。これを実行するコードは以下の通りです。SCHEMAリクエストは、指定されたレポートについて、レポートのカラム（列）、およびフィルターのメタデータも含むスキーマ情報を返します。これを実行するコードは、以下の通りです。 | Code Block |
|---|
ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
ReportService rss = new ReportService();
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 = rssReportService.remoteReportCall(rsr);
|
返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。返される「ReportServiceResponse」オブジェクトは、以下の項目で構成されます。 | 応答要素 | データ型 | 説明 | 取得コード | ReportId | Integer | 指定されたレポートのID指定されたレポートのIDです。 | getReportId()
| StatusCode | String | WebサービスリクエストのステータスWebサービスリクエストのステータスです。 | getStatusCode()
| FormatCode | String | 指定されたレポートのフォーマットコード指定されたレポートの書式コードです。 | getFormatCode()
| ReportType | String | 指定されたレポートのレポートタイプ指定されたレポートのレポートタイプです。 | getReportType()
| LastRunStatus | String | 最後のレポート実行のステータスコード最後レポート実行のステータスコードです。 | getLastRunStatus()
| LastRunTime | DecimalYYYYMMDDHHMMSS形式で示されるレポートの最終実行時間 | 「YYYYMMDDHHMMSS」形式で示されるレポートの最終実行時間です。 | getLastRunTime()
| ReportName | String | 指定されたレポートの名前指定されたレポートの名前です。 | getReportName()
| BinaryData | Stringイメージ、HTML、CSV、またはPDFのBase64エンコードバイナリーチャンク | Base64でエンコードされた、イメージ、HTML、CSV、PDFのバイナリーチャンクです。 | getBinaryData()
| ViewName | String | レポートが依存するビューの名前レポートが依存するビューの名前です。 | getViewName()
| HitCount | Integer | 指定されたレポートがアクセスされた回数指定されたレポートがアクセスされた回数です。 | getHitCount()
| DrillCode | Stringドリルタイプ（レポートで使用可能な場合） | レポートで使用可能な場合の、ドリルタイプです。 | getDrillCode()
| Private | | レポートが個人用または共有のいずれであるかを判別します。レポートが個人用、または共有のどちらであるかを定義します。 | getPrivate()
| Results | Array（ReportRow） | レポート結果セットの結果が含まれる、ReportRowオブジェクトの配列（レポート結果セットの結果が含まれる、「ReportRow」オブジェクトの配列です（ReportRowを参照）を参照してください）。 | getResults()
| ContentType | String | 返されたオブジェクトのMIMEコンテンツタイプ。可能な値は以下の通りです。返されたオブジェクトのMIMEコンテンツタイプです。値の選択肢は、以下の通りです。 - 「text/html」
- 「text/comma-separated-values」
- 「image/png」
- 「application/pdf」
| getContentType()
| Messages | Array（String） | レポートがサーバー上で実行されるときにデバッグ情報を示す文字列の配列。エラーのデバッグおよび追跡に使用します。レポートがサーバー上で実行されるときにデバッグ情報を示す文字列の配列です。エラーのデバッグ、および追跡に使用します。 | getMessages()
| Charts | Array (ReportChart)HTMLレポート応答に付加される、複数のグラフビットマップを含むReportChartオブジェクトの配列（ | HTMLレポート応答に付加される、複数のグラフビットマップを含む「ReportChart」オブジェクトの配列です（ReportChartを参照）を参照してください）。 | getCharts()
| Columns | Array (ReportSchema)レポート結果セットの各カラムの情報、およびユーザープロンプトフィルターデータをレポートに渡す必要があるかどうかを示す情報が含まれるReportSchemaオブジェクトの配列（ | レポート結果セットの各カラム（列）の情報、およびユーザープロンプトフィルターデータをレポートに渡す必要があるかどうかを示す情報が含まれる「ReportSchema」オブジェクトの配列です（ReportSchemaを参照）を参照してください）。 | getColumns()
|
|
| Expand |
|---|
| title | HTML / HTMLCHARTONLY / HTMLTABLEONLY |
|---|
|
HTMLリクエストは、レポートをHTMLで表現したものを返します。HTMLドキュメントはBase64でエンコードされ、グラフとイメージがCharts配列フィールドに格納されます。これらのアーティファクトはクライアントシステムにより手動でデコードする必要があります。また、Base64イメージのデコード用に、URLリクエスト文字列を使用してHTML内にURLが埋め込まれます。HTMLリクエストは、レポートをHTMLで表現したものを返します。HTMLドキュメントはBase64でエンコードされ、グラフとイメージがCharts配列フィールドに格納されます。これらのアーティファクトはクライアントシステムにより手動でデコードする必要があります。また、Base64イメージのデコード用に、URLリクエスト文字列を使用して、HTML内にURLが埋め込まれます。 これを実行するコードは以下の通りです。これを実行するコードは、以下の通りです。 | Code Block |
|---|
ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
ReportService rss = new ReportService();
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 = rssReportService.remoteReportCall(rsr);
|
返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。返される「ReportServiceResponse」オブジェクトは、以下の項目で構成されます。 | 応答要素 | データ型 | 説明 | 取得コード | Chart | Array (ReportChart)HTMLレポート応答に付加される、複数のグラフビットマップを含むReportChartオブジェクトの配列（ | HTMLレポート応答に付加される、複数のグラフビットマップを含む「ReportChart」オブジェクトの配列です（ReportChartを参照）を参照してください）。 | getCharts()
| ReportBinaryObject | Array (ReportBinaryObject)BLOBおよびCLOBを含むReportBinaryObjectオブジェクトの配列（ | BLOB、およびCLOBを含む、「ReportBinaryObject」オブジェクトの配列です（ReportBinaryObjectを参照）を参照してください）。 | getBinaryObjects()
| ReportStyles | String | CSSスタイルCSSスタイルです。 | getReportStyles()
| Breadcrumbs | Array（Breadcrumb）Breadcrumbオブジェクトの配列 | 「Breadcrumb」オブジェクトの配列です。 | getBreadcrumbs()
| SeriesSelection | Array（SeriesSelection）SeriesSelectionオブジェクトの配列 | 「SeriesSelection」オブジェクトの配列です。 | getSeriesSelections()
| TimeAggregationSelection | Array（TimeAggregationSelection）TimeAggregationSelectionオブジェクトの配列 | 「TimeAggregationSelection」オブジェクトの配列です。 | getTimeAggregationSelection()
| ReportTabSelection | Array（ReportTabSelection）ReportTabSelectionオブジェクトの配列 | 「ReportTabSelection」オブジェクトの配列です。 | getReportTabSelection()
| ReportPageSelection | Array（ReportPageSelection）ReportPageSelectionオブジェクトの配列 | 「ReportPageSelection」オブジェクトの配列です。 | getReportPageSelection()
| TimeSliderSelection | Array（TimeSliderSelection）TimeSliderSelectionオブジェクトの配列 | 「TimeSliderSelection」オブジェクトの配列です。 | getTimeSliderSelection()
| SortableColumns | Array（SortableTableColumn）SortableTableColumnオブジェクトの配列 | 「SortableTableColumn」オブジェクトの配列です。 | getSortableColumns()
| SelectedSortColumn | Integer | 並べかえに使用するカラム。このインデックスは、レポート内のカラムインデックスに適用されます。並べかえに使用するカラム（列）です。このインデックスは、レポート内のカラム（列）インデックスに適用されます。 | getSelectedSortColumn()
| SelectedSortOrder | Integer | 並べかえに使用するカラムの並べかえ順序（0が昇順、1が降順）並べかえに使用するカラム（列）の並べかえ順序です（0が昇順、1が降順です）。 | getSelectedSortOrder()
| DrillCode | Stringドリルタイプ（レポートで使用可能な場合） | レポートで使用可能な場合の、ドリルタイプです。 | getDrillCode()
| RelatedReports | Array（RelatedReport）RelatedReportオブジェクトの配列。これは、メインレポートにマルチ表示（タブ化）されるレポートです。 | 「RelatedReport」オブジェクトの配列です。これは、メインレポートにマルチ表示（タブ化）されるレポートです。 | getRelatedReports()
| BinaryData | StringHTMLドキュメントのBase64エンコードバイナリーチャンク | Base64でエンコードされた、HTMLドキュメントのバイナリーチャンクです。 | getBinaryData()
| Private | | レポートが個人用または共有のいずれであるかを判別します。レポートが個人用、または共有のどちらであるかを定義します。 | getPrivate()
| ContentType | String | 返されたオブジェクトのMIMEコンテンツタイプ。値は「text返されたオブジェクトのMIMEコンテンツタイプです。値は「text/html」です。html」です。 | getContentType()
| CanDrill | Boolean | レポートがドリル可能かどうかレポートドリル可否です。 | getCanDrill()
| GoogleMaps | Array（GMap）GMapオブジェクトの配列 | 「GMap」オブジェクトの配列です。 | getGoogleMaps()
|
|
| Expand |
|---|
|
FILTEROPTIONSリクエストは、特定のレポートのフィルターで使用可能なフィルター値を返します。 これを実行するコードは以下の通りです。これを実行するコードは、以下の通りです。 | Code Block |
|---|
ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
ReportService rss = new ReportService();
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 = rssReportService.remoteReportCall(rsr);
|
返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。返される「ReportServiceResponse」オブジェクトは、以下の項目で構成されます。 | 応答要素 | データ型 | 説明 | 取得コード | Results | Array (ReportRow)フィルター値を含むReportRowオブジェクトの配列（ | フィルター値を含む「ReportRow」オブジェクトの配列です（ReportRowを参照）を参照してください）。 | getResults()
|
|
| Expand |
|---|
|
RESULTSETリクエストは、特定のレポートの結果データセットを返します。この結果はReportRowオブジェクトの配列に格納され、各ReportRowオブジェクトがレポートデータセットの1つのロウを表します。ReportRowオブジェクトは、データセットの各カラムのデータを表す文字列の配列でも構成されます。RESULTSETリクエストは、特定のレポートの結果データセットを返します。この結果は、「ReportRow」オブジェクトの配列に格納され、各「ReportRow」オブジェクトは、レポートデータセットの1つのロウ（行）を表します。「ReportRow」オブジェクトは、データセットの各カラム（列）のデータを表す文字列の配列でも構成されます。 このデータを文字列表現から特定のカラムのデータ型に変換するのは、Webサービスクライアントの役割です。各カラムのデータ型は、SCHEMAリクエスト関数呼び出しにより取得できます。このデータを、文字列表現から、各特定のカラム（列）のデータ型に変換するのが、Webサービスクライアントの役割です。各カラム（列）のデータ型は、SCHEMAリクエスト関数呼び出しにより取得できます。 これを実行するコードは以下の通りです。これを実行するコードは、以下の通りです。 | Code Block |
|---|
ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
ReportService rss = new ReportService();
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 = rssReportService.remoteReportCall(rsr);
|
返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。返される「ReportServiceResponse」オブジェクトは、以下の項目で構成されます。 | 応答要素 | データ型 | 説明 | 取得コード | Results | Array (ReportRow)レポート結果セットの結果が含まれる、ReportRowオブジェクトの配列（ | レポート結果セットの結果が含まれる、「ReportRow」オブジェクトの配列です（ReportRowを参照）を参照してください）。 | getResults()
|
|
| Expand |
|---|
|
EXPIRESESSIONリクエストは、指定されたYellowfinセッションを期限切れにします。 これを実行するコードは以下の通りです。これを実行するコードは、以下の通りです。 | Code Block |
|---|
ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
ReportService rss = new ReportService();
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 = rssReportService.remoteReportCall(rsr);
|
|
| Expand |
|---|
|
GETCOMMENTSリクエストは、特定のレポートについてすべてのコメントを取得します。GETCOMMENTSリクエストは、特定のレポートのすべてのコメントを取得します。 これを実行するコードは以下の通りです。これを実行するコードは、以下の通りです。 | Code Block |
|---|
ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
ReportService rss = new ReportService();
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 = rssReportService.remoteReportCall(rsr);
|
返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。返される「ReportServiceResponse」オブジェクトは、以下の項目で構成されます。 | 応答要素 | データ型 | 説明 | 取得コード | コメントComments | Array (ReportComment)レポートのコメントを含むReportCommentオブジェクトの配列（ | レポートのコメントを含む「ReportComment」オブジェクトの配列です（ReportCommentを参照）を参照してください）。 | getComments()
|
|
| Expand |
|---|
|
LEAVECOMMENTリクエストは、特定のレポートにコメントまたはコメントに対する応答を作成します。LEAVECOMMENTリクエストは、特定のレポートにコメント、またはコメントに対する応答を作成します。 これを実行するコードは以下の通りです。これを実行するコードは、以下の通りです。 | Code Block |
|---|
ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
ReportComment comment = new ReportComment();
ReportService rss = new ReportService();
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 = rssReportService.remoteReportCall(rsr);
|
|
| Expand |
|---|
|
DELETECOMMENTリクエストは、レポートから特定のコメントを削除します。 これを実行するコードは以下の通りです。これを実行するコードは、以下の通りです。 | Code Block |
|---|
ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
ReportComment comment = new ReportComment();
ReportService rss = new ReportService();
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 = rssReportService.remoteReportCall(rsr);
|
|
| Expand |
|---|
|
COMMENTSTATUSリクエストは、特定のコメントのステータスを設定します。 これを実行するコードは以下の通りです。これを実行するコードは、以下の通りです。 | Code Block |
|---|
ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
ReportComment comment = new ReportComment();
ReportService rss = new ReportService();
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 = rssReportService.remoteReportCall(rsr);
|
|
| Expand |
|---|
|
DISTRIBUTEINBOXリクエストは、一覧に含まれる受信者の受信トレイにレポートを配信します。 これを実行するコードは以下の通りです。これを実行するコードは、以下の通りです。 | Code Block |
|---|
ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
ReportService rss = new ReportService();
// 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 = rssReportService.remoteReportCall(rsr);
|
|
| Expand |
|---|
| title | GETDISPLAYEDREPORTID |
|---|
|
GETDISPLAYEDREPORTIDリクエストは、現在表示されているレポートのレポートIDを返します。 これを実行するコードは以下の通りです。これを実行するコードは、以下の通りです。 | Code Block |
|---|
ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
ReportService rss = new ReportService();
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organization
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("GETDISPLAYEDREPORTID");
rs = rssReportService.remoteReportCall(rsr);
|
返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。返される「ReportServiceResponse」オブジェクトは、以下の項目で構成されます。 | 応答要素 | データ型 | 説明 | 取得コード取得データ | DisplayedReportId | Integer | 現在表示されているレポートのレポートID現在表示されているレポートのレポートIDです。 | getDisplayedReportId()
|
|
| Expand |
|---|
|
GETKPIリクエストは、特定のKPIレポートについてKPIオブジェクトを返します。この関数リクエストは通常、モバイルアプリケーション内で利用されます。GETKPIリクエストは、特定のKPIレポートについてKPIオブジェクトを返します。こちらの関数リクエストは通常、モバイルアプリケーション内で利用されます。 これを実行するコードは以下の通りです。これを実行するコードは、以下の通りです。 | Code Block |
|---|
ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
ReportService rss = new ReportService();
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 = rssReportService.remoteReportCall(rsr);
|
返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。返される「ReportServiceResponse」オブジェクトは、以下の項目で構成されます。 | 応答要素 | データ型 | 説明 | 取得コード | KPI | KPIオブジェクト | 特定のKPIメトリック（数値）について、実績、目標、および差異の値を保持するカスタムKPIオブジェクト（特定のKPIメトリック（数値）について、実績、目標、および差異の値を保持するカスタムKPIオブジェクトです。（KPIを参照）を参照してください）。 | getKPI()
|
|
| Expand |
|---|
| title | GETDRILLANYWHEREMENU |
|---|
|
GETDRILLANYWHEREMENUリクエストは、選択されたレポートカラムで使用できる「ドリルエニウェア」メニューを返します。この関数リクエストは通常、モバイルアプリケーション内で利用されます。GETDRILLANYWHEREMENUリクエストは、選択されたレポートカラム（列）で使用できる「ドリルエニウェア」メニューを返します。こちらの関数リクエストは通常、モバイルアプリケーション内で利用されます。 これを実行するコードは以下の通りです。これを実行するコードは、以下の通りです。 | Code Block |
|---|
ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
ReportService rss = new ReportService();
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 = rssReportService.remoteReportCall(rsr);
|
返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。返される「ReportServiceResponse」オブジェクトは、以下の項目で構成されます。 | 応答要素 | データ型 | 説明 | 取得コード | DrillAnywhereCategories | Array（String） | 文字列の配列文字列の配列です。 | getDrillAnywhereCategories()
| DrillAnywhereTargets | Array (DrillAnywhereTarget)ドリルエニウェアカテゴリーのドリルエニウェア目標を一覧表示するDrillAnywhereTargetオブジェクトの配列（DrillAnywhereTarget | を参照）ドリルエニウェアカテゴリーのドリルエニウェア目標を一覧表示する「DrillAnywhereTarget」オブジェクトの配列です（DrillAnywhereTargetを参照してください）。 | getDrillAnywhereTargets()
|
|
| Expand |
|---|
|
SUBSCRIBEDETAILSリクエストは、特定のレポートのスケジュールレコードを返します。 これを実行するコードは以下の通りです。これを実行するコードは、以下の通りです。 | Code Block |
|---|
ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
ScheduleRecord sr = null;
ReportService rss = new ReportService();
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 = rssReportService.remoteReportCall(rsr);
sr = rs.getSchedule();
|
返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。返される「ReportServiceResponse」オブジェクトは、以下の項目で構成されます。 | 応答要素 | データ型 | 説明 | 取得コード | ScheduleRecord | ScheduleRecordオブジェクト | 購読詳細と条件を含むScheduleRecordオブジェクト（購読詳細と条件を含む「ScheduleRecord」オブジェクト（ScheduleRecordを参照）を参照してください）。 | getSchedule()
|
|
| Expand |
|---|
|
SUBSCRIBEリクエストは、指定されたユーザーの指定のレポートに対する購読を作成SUBSCRIBEリクエストは、指定されたユーザーの指定されたレポートに対する購読を作成/変更します。この関数リクエストは通常、まず現在の購読を取得するために、SUBSCRIBEDETAILSのあとに呼び出されます。そうでない場合、この関数呼び出しのために、ScheduleRecordオブジェクトを作成して適切なデータを投入する必要があります（変更します。こちらの関数リクエストは通常、まず現在の購読を取得するために、SUBSCRIBEDETAILSのあとに呼び出されます。そうでない場合、こちらの関数呼び出しのために、「ScheduleRecord」オブジェクトを作成して適切なデータを投入する必要があります（ScheduleRecordを参照）。を参照してください）。 これを実行するコードは以下の通りです。これを実行するコードは、以下の通りです。 | Code Block |
|---|
ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
ReportService rss = new ReportService();
// 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 = rssReportService.remoteReportCall(rsr);
|
|
| Expand |
|---|
|
UNSUBSCRIBEリクエストは、指定のレポートから指定されたユーザーの購読を取り消します。UNSUBSCRIBEリクエストは、指定されたレポートから、指定されたユーザーの購読を取り消します。 これを実行するコードは以下の通りです。これを実行するコードは、以下の通りです。 | Code Block |
|---|
ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
ReportService rss = new ReportService();
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 = rssReportService.remoteReportCall(rsr);
|
|
| Expand |
|---|
|
LOADDASHBOARDTABリクエストは、指定されたダッシュボードタブとそのメタデータをロードします。 これを実行するコードは以下の通りです。これを実行するコードは、以下の通りです。 | Code Block |
|---|
ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
DashboardDefinition dd = null;
ReportService rss = new ReportService();
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 = rssReportService.remoteReportCall(rsr);
dd = rs.getDashboard();
|
返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。返される「ReportServiceResponse」オブジェクトは、以下の項目で構成されます。 | 応答要素 | データ型 | 説明 | 取得コード | DashboardDefinition | DashboardDefinitionオブジェクト | ダッシュボードタブのメタデータを含むDashboardDefinitionオブジェクト（ダッシュボードタブのメタデータを含む「DashboardDefinition」オブジェクトです（DashboardDefinitionを参照）を参照してください）。 | getDashboard()
|
|
| Expand |
|---|
| title | APPLYDASHBOARDFILTERS |
|---|
|
これを実行するコードは以下の通りです。これを実行するコードは、以下の通りです。 | Code Block |
|---|
ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
DashboardFilter[] dfarray = null;
DashboardFilter df = new DashboardFilter();
ReportService rss = new ReportService();
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 = rssReportService.remoteReportCall(rsr);
|
|
| Expand |
|---|
| title | GETDASHBOARDREPORTFILTERVALUES |
|---|
|
GETDASHBOARDREPORTFILTERVALUESリクエストは、ダッシュボードタブの特定のレポートに対するフィルターメタデータを返します。 これを実行するコードは以下の通りです。これを実行するコードは、以下の通りです。 | Code Block |
|---|
ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
ReportFilter[] rf = null;
ReportService rss = new ReportService();
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 = rssReportService.remoteReportCall(rsr);
rf = rs.getReportFilters();
|
返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。返される「ReportServiceResponse」オブジェクトは、以下の項目で構成されます。 応答要素 | データ型 | 説明 | 取得コード | ReportFilters | Array (ReportFilter)各フィルターのメタデータを含むFilterオブジェクトの配列（ | 各フィルターのメタデータを含む「Filter」オブジェクトの配列です（ReportFilterを参照）を参照してください）。 | getReportFilters()
|
|
| Expand |
|---|
|
RUNDASHBOARDREPORTリクエストは、ダッシュボードタブの指定されたレポートを実行し、エクスポートします。応答には、グラフ、GISマップ、およびCSSスタイルを含む、Base64エンコードで生成されたHTMLが含まれます。RUNDASHBOARDREPORTリクエストは、ダッシュボードタブの指定されたレポートを実行し、エクスポートします。応答には、グラフ、GISマップ、およびCSSスタイルを含む、生成されたBase64でエンコードされたHTMLが含まれます。 これを実行するコードは以下の通りです。これを実行するコードは、以下の通りです。 | Code Block |
|---|
ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
ReportService rss = new ReportService();
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 = rssReportService.remoteReportCall(rsr);
|
返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。返される「ReportServiceResponse」オブジェクトは、以下の項目で構成されます。 応答要素 | データ型 | 説明 | 取得コード | BinaryData | StringHTMLのBase64エンコードバイナリーチャンク | Base64でエンコードされたHTMLのバイナリーチャンクです。 | getBinaryData()
| Charts | Array (ReportChart) | ReportChartオブジェクトの配列（ReportChartオブジェクトの配列です（ReportChartを参照）を参照してください）。 | getCharts()
| ReportStyle | String | CSSスタイルCSSスタイルです。 | GetReportStyle()
| Breadcrumbs | Array（Breadcrumb） | Breadcrumbオブジェクトの配列「Breadcrumb」オブジェクトの配列です。 | getBreadcrumbs()
| GoogleMaps | Array（GMap）GoogleMapsオブジェクトの配列（レポートのグラフで使用されている場合） | レポートのグラフが使用している場合の、「GoogleMaps」オブジェクトの配列です。 | getGoogleMaps()
| GisMap | Array（GISMap）GISMapオブジェクトの配列（レポートのグラフで使用されている場合） | レポートのグラフで使用されている場合の、「GISMap」オブジェクトの配列です。 | Array（GISMap） |
|
オブジェクト定義
| Anchor |
|---|
| ReportComment |
|---|
| ReportComment |
|---|
|
...