...
関数
注意:こちらに掲載されているすべてのコードは、「疑似コード」です。実際に使用するコードは、ユーザーの使用環境により異なります。こちらの例は、あくまで参照目的でご利用ください。
Expand |
---|
|
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 = ReportService.remoteReportCall(rsr);
|
返される「ReportServiceResponse」オブジェクトは、以下の項目で構成されます。 応答要素 | データ型 | 説明 | 取得コード | ReportId | Integer | 指定されたレポートのIDです。 | getReportId()
| ReportName | String | 指定されたレポートの名前です。 | getReportName()
| HitCount | Integer | 指定されたレポートがアクセスされた回数です。 | getHitCount()
| FormatCode | String | 指定されたレポートの書式コードです。 | getFormatCode()
| BinaryData | String | Base64でエンコードされたPDFのバイナリーチャンクです。 | getBinaryData()
| ContentType | String | このオブジェクトのMIMEコンテンツタイプです。値は「application/pdf」です。 | getContentType()
|
|
Expand |
---|
|
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 = ReportService.remoteReportCall(rsr);
|
返される「ReportServiceResponse」オブジェクトは、以下の項目で構成されます。 応答要素 | データ型 | 説明 | 取得コード | ReportId | Integer | 指定されたレポートのIDです。 | getReportId()
| ReportName | String | 指定されたレポートの名前です。 | getReportName()
| HitCount | Integer | 指定されたレポートがアクセスされた回数です。 | getHitCount()
| FormatCode | String | 指定されたレポートの書式コードです。 | getFormatCode()
| BinaryData | String | Base64でエンコードされたCSVのバイナリーチャンクです。 | getBinaryData()
| ContentType | String | このオブジェクトのMIMEコンテンツタイプです。値は「text/comma-separated-values」です。 | getContentType()
|
|
Expand |
---|
|
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 = ReportService.remoteReportCall(rsr);
|
返される「ReportServiceResponse」オブジェクトは、以下の項目で構成されます。 応答要素 | データ型 | 説明 | 取得コード | ReportId | Integer | 指定されたレポートのIDです。 | getReportId()
| ReportName | String | 指定されたレポートの名前です。 | getReportName()
| HitCount | Integer | 指定されたレポートがアクセスされた回数です。 | getHitCount()
| FormatCode | String | 指定されたレポートの書式コードです。 | getFormatCode()
| BinaryData | String | Base64でエンコードされたXLSのバイナリーチャンクです。 | getBinaryData()
| ContentType | String | このオブジェクトのMIMEコンテンツタイプです。値は「application/xls」です。 | getContentType()
|
|
Expand |
---|
|
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 = ReportService.remoteReportCall(rsr);
|
返される「ReportServiceResponse」オブジェクトは、以下の項目で構成されます。 応答要素 | データ型 | 説明 | 取得コード | ReportId | Integer | 指定されたレポートのIDです。 | getReportId()
| ReportName | String | 指定されたレポートの名前です。 | getReportName()
| HitCount | Integer | 指定されたレポートがアクセスされた回数です。 | getHitCount()
| FormatCode | String | 指定されたレポートの書式コードです。 | getFormatCode()
| BinaryData | String | Base64でエンコードされたXLSのバイナリーチャンクです。 | getBinaryData()
| ContentType | String | このオブジェクトのMIMEコンテンツタイプです。値は「text/tab-separated-values」です。 | getContentType()
|
|
Expand |
---|
|
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 = ReportService.remoteReportCall(rsr);
|
返される「ReportServiceResponse」オブジェクトは、以下の項目で構成されます。 応答要素 | データ型 | 説明 | 取得コード | ReportId | Integer | 指定されたレポートのIDです。 | getReportId()
| ReportName | String | 指定されたレポートの名前です。 | getReportName()
| HitCount | Integer | 指定されたレポートがアクセスされた回数です。 | getHitCount()
| FormatCode | String | 指定されたレポートの書式コードです。 | getFormatCode()
| BinaryData | String | Base64でエンコードされたRTFのバイナリーチャンクです。 | getBinaryData()
| ContentType | String | このオブジェクトのMIMEコンテンツタイプです。値は「application/rtf」です。 | getContentType()
|
|
Expand |
---|
|
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 = ReportService.remoteReportCall(rsr);
|
返される「ReportServiceResponse」オブジェクトは、以下の項目で構成されます。 応答要素 | データ型 | 説明 | 取得データ | ReportId | Integer | 指定されたレポートのIDです。 | getReportId()
| ReportName | String | 指定されたレポートの名前です。 | getReportName()
| HitCount | Integer | 指定されたレポートがアクセスされた回数です。 | getHitCount()
| FormatCode | String | 指定されたレポートの書式コードです。 | getFormatCode()
| BinaryData | String | Base64でエンコードされたDOCのバイナリーチャンクです。 | getBinaryData()
| ContentType | String | このオブジェクトのMIMEコンテンツタイプです。値は「application/vnd.ms-word」です。 | getContentType()
|
|
Expand |
---|
|
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 = ReportService.remoteReportCall(rsr);
|
返される「ReportServiceResponse」オブジェクトは、以下の項目で構成されます。 応答要素 | データ型 | 説明 | 取得コード | ReportId | Integer | 指定されたレポートのIDです。 | getReportId()
| StatusCode | String | Webサービスリクエストのステータスです。 | getStatusCode()
| FormatCode | String | 指定されたレポートの書式コードです。 | getFormatCode()
| ReportType | String | 指定されたレポートのレポートタイプです。 | getReportType()
| LastRunStatus | String | 最後レポート実行のステータスコードです。 | getLastRunStatus()
| LastRunTime | Decimal | 「YYYYMMDDHHMMSS」形式で示されるレポートの最終実行時間です。 | getLastRunTime()
| ReportName | String | 指定されたレポートの名前です。 | getReportName()
| BinaryData | String | Base64でエンコードされた、イメージ、HTML、CSV、PDFのバイナリーチャンクです。 | getBinaryData()
| ViewName | String | レポートが依存するビューの名前です。 | getViewName()
| HitCount | Integer | 指定されたレポートがアクセスされた回数です。 | getHitCount()
| DrillCode | String | レポートで使用可能な場合の、ドリルタイプです。 | getDrillCode()
| Private | | レポートが個人用、または共有のどちらであるかを定義します。 | getPrivate()
| Results | Array(ReportRow) | レポート結果セットの結果が含まれる、「ReportRow」オブジェクトの配列です(ReportRowを参照してください)。 | getResults()
| ContentType | String | 返されたオブジェクトのMIMEコンテンツタイプです。値の選択肢は、以下の通りです。 - 「text/html」
- 「text/comma-separated-values」
- 「image/png」
- 「application/pdf」
| getContentType()
| Messages | Array(String) | レポートがサーバー上で実行されるときにデバッグ情報を示す文字列の配列です。エラーのデバッグ、および追跡に使用します。 | getMessages()
| Charts | Array (ReportChart) | HTMLレポート応答に付加される、複数のグラフビットマップを含む「ReportChart」オブジェクトの配列です(ReportChartを参照してください)。 | getCharts()
| Columns | Array (ReportSchema) | レポート結果セットの各カラム(列)の情報、およびユーザープロンプトフィルターデータをレポートに渡す必要があるかどうかを示す情報が含まれる「ReportSchema」オブジェクトの配列です(ReportSchemaを参照してください)。 | getColumns()
|
|
Expand |
---|
title | HTML / HTMLCHARTONLY / HTMLTABLEONLY |
---|
|
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 = ReportService.remoteReportCall(rsr);
|
返される「ReportServiceResponse」オブジェクトは、以下の項目で構成されます。 応答要素 | データ型 | 説明 | 取得コード | Chart | Array (ReportChart) | HTMLレポート応答に付加される、複数のグラフビットマップを含む「ReportChart」オブジェクトの配列です(ReportChartを参照してください)。 | getCharts()
| ReportBinaryObject | Array (ReportBinaryObject) | BLOB、およびCLOBを含む、「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 | Base64でエンコードされた、HTMLドキュメントのバイナリーチャンクです。 | getBinaryData()
| Private | | レポートが個人用、または共有のどちらであるかを定義します。 | getPrivate()
| ContentType | String | 返されたオブジェクトのMIMEコンテンツタイプです。値は「text/html」です。 | getContentType()
| CanDrill | Boolean | レポートドリル可否です。 | getCanDrill()
| GoogleMaps | Array(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 = ReportService.remoteReportCall(rsr);
|
返される「ReportServiceResponse」オブジェクトは、以下の項目で構成されます。 応答要素 | データ型 | 説明 | 取得コード | Results | Array (ReportRow) | フィルター値を含む「ReportRow」オブジェクトの配列です(ReportRowを参照してください)。 | getResults()
|
|
Expand |
---|
|
RESULTSETリクエストは、特定のレポートの結果データセットを返します。この結果は、「ReportRow」オブジェクトの配列に格納され、各「ReportRow」オブジェクトは、レポートデータセットの1つのロウ(行)を表します。「ReportRow」オブジェクトは、データセットの各カラム(列)のデータを表す文字列の配列でも構成されます。 このデータを、文字列表現から、各特定のカラム(列)のデータ型に変換するのが、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 = ReportService.remoteReportCall(rsr);
|
返される「ReportServiceResponse」オブジェクトは、以下の項目で構成されます。 応答要素 | データ型 | 説明 | 取得コード | Results | Array (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 = ReportService.remoteReportCall(rsr);
|
|
Expand |
---|
|
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 = ReportService.remoteReportCall(rsr);
|
返される「ReportServiceResponse」オブジェクトは、以下の項目で構成されます。 応答要素 | データ型 | 説明 | 取得コード | Comments | Array (ReportComment) | レポートのコメントを含む「ReportComment」オブジェクトの配列です(ReportCommentを参照してください)。 | getComments()
|
|
Expand |
---|
|
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 = ReportService.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 = ReportService.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 = ReportService.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 = ReportService.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 = ReportService.remoteReportCall(rsr);
|
返される「ReportServiceResponse」オブジェクトは、以下の項目で構成されます。 応答要素 | データ型 | 説明 | 取得データ | DisplayedReportId | Integer | 現在表示されているレポートのレポートIDです。 | getDisplayedReportId()
|
|
Expand |
---|
|
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 = ReportService.remoteReportCall(rsr);
|
返される「ReportServiceResponse」オブジェクトは、以下の項目で構成されます。 応答要素 | データ型 | 説明 | 取得コード | KPI | KPIオブジェクト | 特定のKPIメトリック(数値)について、実績、目標、および差異の値を保持するカスタムKPIオブジェクトです。(KPIを参照してください)。 | getKPI()
|
|
Expand |
---|
title | 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 = ReportService.remoteReportCall(rsr);
|
返される「ReportServiceResponse」オブジェクトは、以下の項目で構成されます。 応答要素 | データ型 | 説明 | 取得コード | DrillAnywhereCategories | Array(String) | 文字列の配列です。 | getDrillAnywhereCategories()
| DrillAnywhereTargets | Array (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 = ReportService.remoteReportCall(rsr);
sr = rs.getSchedule();
|
返される「ReportServiceResponse」オブジェクトは、以下の項目で構成されます。 応答要素 | データ型 | 説明 | 取得コード | ScheduleRecord | ScheduleRecordオブジェクト | 購読詳細と条件を含む「ScheduleRecord」オブジェクト(ScheduleRecordを参照してください)。 | getSchedule()
|
|
Expand |
---|
|
SUBSCRIBEリクエストは、指定されたユーザーの指定されたレポートに対する購読を作成/変更します。こちらの関数リクエストは通常、まず現在の購読を取得するために、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 = ReportService.remoteReportCall(rsr);
|
|
Expand |
---|
|
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 = ReportService.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 = ReportService.remoteReportCall(rsr);
dd = rs.getDashboard();
|
返される「ReportServiceResponse」オブジェクトは、以下の項目で構成されます。 応答要素 | データ型 | 説明 | 取得コード | 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 = ReportService.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 = ReportService.remoteReportCall(rsr);
rf = rs.getReportFilters();
|
返される「ReportServiceResponse」オブジェクトは、以下の項目で構成されます。 応答要素 | データ型 | 説明 | 取得コード | ReportFilters | Array (ReportFilter) | 各フィルターのメタデータを含む「Filter」オブジェクトの配列です(ReportFilterを参照してください)。 | getReportFilters()
|
|
Expand |
---|
|
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 = ReportService.remoteReportCall(rsr);
|
返される「ReportServiceResponse」オブジェクトは、以下の項目で構成されます。 応答要素 | データ型 | 説明 | 取得コード | BinaryData | String | Base64でエンコードされたHTMLのバイナリーチャンクです。 | getBinaryData()
| Charts | Array (ReportChart) | ReportChartオブジェクトの配列です(ReportChartを参照してください)。 | getCharts()
| ReportStyle | String | CSSスタイルです。 | GetReportStyle()
| Breadcrumbs | Array(Breadcrumb) | 「Breadcrumb」オブジェクトの配列です。 | getBreadcrumbs()
| GoogleMaps | Array(GMap) | レポートのグラフが使用している場合の、「GoogleMaps」オブジェクトの配列です。 | getGoogleMaps()
| GisMap | Array(GISMap) | レポートのグラフで使用されている場合の、「GISMap」オブジェクトの配列です。 | Array(GISMap) |
|
オブジェクト定義
...
Expand |
---|
|
ReportComment要素 | データ型 | 説明 | 取得コード | CommentId | Integer | コメントのIDです。 | getCommentId()
| AuthorId | Integer | コメント作成者のIDです。 | getAuthorId()
| Comment | String | コメントの値です。 | getComment()
| ReportId | Integer | コメントが存在するレポートのIDです。 | getReportId()
| ParentCommentId | Integer | コメントが関連付けられているメインIDです。ある特定のコメントが、親コメントへの返信である場合に、こちらが適用されます。 | getParentCommentId()
| StatusCode | String | コメントのステータスです。 | getStatusCode()
| CommentDate | DateTime | コメントが作成された日時の値です。 | getCommentDate()
| LastActivityDate | DateTime | 特定のコメントが最後に更新された日時の値です。 | getLastActivityDate()
|
|
...
Expand |
---|
|
ReportComment要素 | データ型 | 説明 | 取得コード | DataValue | Array(String) | レポート結果セットの各カラムのデータを含む文字列の配列です。 | getDataValue()
|
|
...
Expand |
---|
|
ReportChart要素 | データ型 | 説明 | 取得コード | ReportIndex | Integer | 配信された埋め込みHTML内のイメージのインデックスです。 | getReportIndex()
| Content Type | String | このグラフのMIMEコンテンツタイプです。値の選択肢は、以下の通りです。 | getContentType()
| Data | String | Base64のバイナリーイメージデータです。 | getData()
| Filename | String | HTMLに埋め込まれているファイルのファイル名です。 | getFilename()
|
|
...
Expand |
---|
|
ReportSchema要素 | データ型 | 説明 | 取得コード | ColumnName | String | カラム(列)名です。 | getColumnName()
| DisplayName | String | カラム(列)の表示名です。 | getDisplayName()
| FieldId | Integer | カラム(列)のフィールドIDです。 | getFieldId()
| DataType | String | カラム(列)のデータ型です。 | getDataType()
| ColumnLength | String | カラム(列)の長さです。 | getColumnLength()
| Hidden | Boolean | カラム(列)がレポートに表示されるかどうか | getHidden()
| Prompt | Boolean | カラム(列)がプロンプトフィールドかどうか | getPrompt()
| FilterId | Integer | カラム(列)がフィルターの場合の、フィルターIDです。 | getFilterId()
| FilterType | String | フィルタータイプ、およびプロンプトへの応答として投稿する必要があるデータを決定します。 | getFilterType()
| AllowPrompt | Boolean | | getAllowPrompt()
| FilterOmittable | Boolean | | getFilterOmittable()
| ParentFilterId | Integer | フィルターの従属関係が設定されている場合の、親フィルターのフィルターIDです。 | getParentId()
| DefaultValue1 | | 設定されている場合の、フィルターの最初のデフォルト値です。 | getDefaultValue1()
| DefaultValue2 | | 設定されている場合の、フィルターの二番目のデフォルト値です。 | getDefaultValue2()
| ValueUnitCode | | 設定されている場合の、フィルターの時間単位です。 | getValueUnitCode()
| FilterDisplayType | | カラム(列)がフィルターの場合の、フィルター表示タイプです。 | getFilterDisplayType()
| MinimumValue | | 設定されている場合の、フィルターの最小値です。 | getMinimumValue()
| MaximumValue | | 設定されている場合の、フィルターの最大値です。 | getMaximumValue()
|
|
...
Expand |
---|
|
ReportBinaryObject要素 | データ型 | 説明 | 取得コード | ContentType | String | MIMEコンテンツタイプです。 | getContentType()
| Data | String | Base64バイナリーデータです。 | getData()
| Key | String | 「ReportBinaryObject」オブジェクトのキーです。 | getKey()
|
|
...
Expand |
---|
|
KPI要素 | データ型 | 説明 | 取得コード | Actual | String | KPIメトリック(数値)の実績値です。 | getActual()
| Target | String | KPIメトリック(数値)の目標値です。 | getTarget()
| Variance | String | KPIメトリック(数値)の差異値です。 | getVariance()
|
|
...
Expand |
---|
|
DrillAnywhereTarget要素 | データ型 | 説明 | 取得データ | ParentCategory | String | 親カテゴリーの値です。 | getParentCategory()
| Targets | Array(String) | 特定の親カテゴリーの目標である文字列値の配列です。 | getTargets()
|
|
...
Expand |
---|
|
ScheduleRecord要素 | データ型 | 説明 | 取得コード | Recipient | Integer | 購読の受信者のIDです。 | getRecipient()
| Subject | String | 購読の件名です。 | getSubject()
| BodyText | String | 購読のメッセージです。 | getBodyText()
| FrequencyTypeCode | String | 購読の頻度です。値の選択肢は、以下の通りです。 - MINUTES
- DAILY
- WEEKLY
- FORTNIGHTLY
- MONTHLY
- QUARTERLY
- BIANNUAL
- ANNUAL
- ENDOFMONTH
| getFrequencyTypeCode()
| FrequencyCode | String | 頻度タイプコードに応じた、追加の頻度コードです。 | getFrequencyCode()
| FrequencyUnit | String | 頻度タイプコードに応じた、追加の頻度単位です。 | getFrequencyCode()
| Format | String | 購読ファイルタイプです。値の選択肢は、以下の通りです。 | getFormat()
| ConditionList | Array(Condition) | 配信ルールを格納する「Condition」オブジェクトの配列です(Conditionを参照してください)。 | getConditionList()
| AdvancedTimezoneCode | String | 購読が行われる地域のタイムゾーンです。 | getAdvancedTimezoneCode()
| AdvancedTime | Integer | 購読の現地実行時間です。 | getAdvancedTime()
|
|
...
Expand |
---|
|
Condition要素 | データ型 | 説明 | 取得データ | Operator | String | カラム(列)フィルター演算子です。値の選択肢は、以下の通りです。 - BETWEEN
- NOTBETWEEN
- EQUAL
- NOTEQUAL
- GREATER
- GREATEREQUAL
- INLIST
- NOTINLIST
- ISNULL
- ISNOTNULL
- LESS
- LESSEQUAL
- STARTSWITH
- NOTSTARTSWITH
- CONTAINS
- NOTCONTAINS
- ENDSWITH
- NOTENDSWITH
| getOperator()
| FieldId | Integer | カラム(列)のフィールドIDです。 | getFieldId()
| Value1 | String | 最初の条件値です。 | getValue1()
| Value2 | String | 二番目の条件値です。演算子が、「の間(〜)」や「の間でない」などの場合に必要です。 | getValue2()
|
|
...
Expand |
---|
|
DashboardDefinition要素 | データ型 | 説明 | 取得コード | TabId | Integer | ダッシュボードタブのIDです。 | getTabId()
| GroupTypeCode | String | ダッシュボードタブのタイプです。値の選択肢は、以下の通りです。 | getGroupTypeCode()
| Owner | Integer | ダッシュボード所有者のIDです。 | getOwner()
| OwnerTypeCode | String | ダッシュボード所有者のタイプです。デフォルトでは、「ORGANISATION」に設定されています。 | getOwnerTypeCode()
| AccessCode | String | ダッシュボードタブのセキュリティレベルです。 | getAccessCode()
| StartDate | Date | 作成日です。 | getStartDate()
| EndDate | Date | 適用される場合の、終了日です。 | getEndDate()
| StatusCode | String | ダッシュボードタブのステータスです。 | getStatusCode()
| ShortDescription | String | ダッシュボードタブの名前です。 | getShortDescription()
| LongDescription | String | ダッシュボードタブの説明です。 | getLongDescription()
| LanguageCode | String | 二文字の言語コードです。 | getLanguageCode()
| StyleCode | String | レイアウトコードです。値の選択肢は、以下の通りです。 - SINGLE
- TWO
- THREE
- WIDENARROW
- NARROWWIDE
| getStyleCode()
| Audience | String | 対象者の説明です。 | getAudience()
| ParentGroupId | Integer | ダッシュボードタブがドラフト(編集中)モードの場合、元のタブIDは、こちらのカラム(列)に保存されます。 | getParentGroupId()
| Elements | Array (DashboardElement) | ダッシュボードタブ内に存在するレポートのポートレット情報を含む「DashboardElement」オブジェクトです(DashboardElementを参照してください)。 | getElements()
| Filters | Array (DashboardFilterDefinition) | ダッシュボードタブ、分析フィルター、およびフィルターグループに関する書式レコードを含む「DashboardFilterDefinition」オブジェクトです(DashboardFilterDefinitionを参照してください)。 | getFilters()
| Fields | Array (DashboardFieldDefinition) | ダッシュボードタブにドリルダウンとして表示されるフィールドに関する書式レコードを含む「DashboardFieldDefinition」オブジェクトです。 | getFields()
|
|
...
Expand |
---|
|
DashboardElement要素 | データ型 | 説明 | 取得コード | TabId | Integer | ダッシュボードタブのIDです。 | getTabId()
| EntityId | Integer | ポートレットのIDです。これは、レポートIDである場合もあります。 | getEntityId()
| EntityTypeCode | String | ポートレットのエンティティタイプです。デフォルトでは、「REPORT」に設定されています。 | getEntityTypeCode()
| ColumnNumber | Integer | カラム(列)方向でのポートレットの位置を示します。最初のカラム(列)は、値1から始まります。 | getColumnNumber()
| RowNumber | Integer | ロウ(行)方向でのポートレットの位置を示します。最初のロウ(行)は、値1から始まります。 | getRowNumber()
| SequenceNumber | Integer | ダッシュボードタブ内のポートレットロード順序です。 | getSequenceNumber()
| StartDate | Date | ポートレットが追加された日付です。 | getStartDate()
| PortletStatus | String | ポートレットのステータスです。 | getPortletStatus()
| PortletHeight | Integer | ポートレットの高さをピクセル単位で示します。 | getPortletHeight()
|
|
...
Expand |
---|
title | DashboardFieldDefinition |
---|
|
DashboardFieldDefinition要素 | データ型 | 説明 | 取得コード | TabId | Integer | ダッシュボードタブのIDです。 | getTabId()
| FieldId | Integer | カラム(列)のフィールドIDです。 | getFieldId()
| FieldType | String | フィールドのデータ型です。値の選択肢は、以下の通りです。 - BOOLEAN
- DATE
- GISGEOMETRY
- GISMULTIPOLY
- GISPOINT
- NUMERIC
- TEXT
- TIMESTAMP
| getFieldType()
| ReportId | Integer | レポートのIDです。 | getReportId()
| TemplateId | Integer | 対応するフィールドテンプレートレコードのIDです。 | getTemplateId()
| FieldName | String | カラム(列)名です。 | getFieldName()
| FieldDescription | String | カラム(列)名です。 | getFieldDescription()
|
|
...
Expand |
---|
title | DashboardFilterDefinition |
---|
|
DashboardFilterDefinition要素 | データ型 | 説明 | 取得データ | GroupId | Integer | ダッシュボードタブのIDです。 | getGroupId()
| ComponentId | Integer | コンポーネントタイプに基づくコンポーネントの数値IDです。 | getComponentId()
| ComponentTypeCode | String | 「DashboardFilterDefinition」オブジェクトのコンポーネントタイプは、以下の通りです。 - FILTER(個別の分析フィルター)
- FILTERGROUP(分析フィルターグループ)
- NULL(一般的なダッシュボードタブ)
| getComponentTypeCode()
| EntityId | Integer | | getEntityId()
| EntityTypeCode | String | 「DashboardFilterDefinition」オブジェクトのエンティティタイプは、以下の通りです。 - REPORT(分析フィルター)
- REPORTGROUP(一般的なダッシュボードタブ)
| getEntityTypeCode()
| FormatKey | String | 書式コードです。 | getFormatKey()
| FormatValue | String | 書式値です。 | getFormatValue()
|
|
...
Expand |
---|
|
ReportFilter要素 | データ型 | 説明 | 取得コード | FilterId | Integer | フィルターのIDです。 | getFilterId()
| IsOmitted | Boolean | デフォルトでフィルターを省略するかどうか | getIsOmitted()
| DataValue | String | 特定のフィルターのフィルター値です。値が2つある場合(例:フィルター演算子が、「の間(〜)」の場合)、値はパイプ値で連結されます。 | getDataValue()
|
|
...
Expand |
---|
|
DashboardFilter要素 | データ型 | 説明 | 取得コード | ReportId | Integer | フィルターが属するレポートのIDです。 | getReportId()
| FilterType | String | フィルター演算子です。 | getFilterType()
| FilterId | Integer | フィルターのIDです。 | getFilterId()
| TabId | Integer | レポートがあるダッシュボードタブのIDです。 | getTabId()
| FilterValue | String | 特定のフィルターのフィルター値です。フィルター演算子が、2つの値を必要とする場合(例:フィルター演算子が、「の間(〜)」の場合)、値はパイプ値で連結されます。 | getFilterValue()
| TemplateId | Integer | フィールドテンプレートレコードのIDです。フィルタータイプが、「DRILL」などの場合に適用されます。 | getTemplateId()
|
|