Versions Compared

Version Old Version 4 New Version 5
Changes made by

Yellowfin Admin

Yellowfin Admin

Saved on

Key

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

...

Table of Contents
classcontents

...

関数

Retrieval Code

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

Expand
titlePDF

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

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

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

rs = ReportService.remoteAdministrationCall(rsr);

The returned ReportServiceResponse object consists of:

Response Element

Data Type

Description

応答要素

データ型

説明

取得コード

ReportId

Integer

ID of the specified report指定されたレポートのID

getReportId()

ReportName

String

Name of the specified report指定されたレポートの名前

getReportName()

HitCount

Integer

Number of times the specified report has been accessed指定されたレポートがアクセスされた回数

getHitCount()

FormatCode

String

Format code of the specified report指定されたレポートのフォーマットコード

getFormatCode()

BinaryData

String

Base64 encoded binary chunk of PDFPDFのBase64エンコードバイナリーチャンク

getBinaryData()

ContentType

String

MIME Content Type of this object. Value will be “application/pdf”

getContentType(

このオブジェクトのMIMEコンテンツタイプ。値は「application/pdf」です。

getContentType()

Retrieval Code

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

Expand
titleCSV

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

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

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

rs = ReportService.remoteAdministrationCall(rsr);

The returned ReportServiceResponse object consists of:

Response Element

Data Type

Description

応答要素

データ型

説明

取得コード

ReportId

Integer

ID of the specified report指定されたレポートのID

getReportId()

ReportName

String

Name of the specified report指定されたレポートの名前

getReportName()

HitCount

Integer

Number of times the specified report has been accessed指定されたレポートがアクセスされた回数

getHitCount()

FormatCode

String

Format code of the specified report指定されたレポートのフォーマットコード

getFormatCode()

BinaryData

String

Base64 encoded binary chunk of CSVCSVのBase64エンコードバイナリーチャンク

getBinaryData()

ContentType

String

MIME Content Type of this object. Value will be “textこのオブジェクトのMIMEコンテンツタイプ。値は「text/comma-separated-values”values」です。

getContentType()

Retrieval Code

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

Expand
titleXLS

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

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

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

rs = ReportService.remoteAdministrationCall(rsr);

The returned ReportServiceResponse object consists of:

Response Element

Data Type

Description

応答要素

データ型

説明

取得コード

ReportId

Integer

ID of the specified report指定されたレポートのID

getReportId()

ReportName

String

Name of the specified report指定されたレポートの名前

getReportName()

HitCount

Integer

Number of times the specified report has been accessed指定されたレポートがアクセスされた回数

getHitCount()

FormatCode

String

Format code of the specified report指定されたレポートのフォーマットコード

getFormatCode()

BinaryData

String

Base64 encoded binary chunk of XLSXLSのBase64エンコードバイナリーチャンク

getBinaryData()

ContentType

StringMIME

Content Type of this object. Value will be “application/xls”このオブジェクトのMIMEコンテンツタイプ。値は「application/xls」です。

getContentType()

Retrieval Code

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

Expand
titleTEXT

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

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

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

rs = ReportService.remoteAdministrationCall(rsr);

The returned ReportServiceResponse object consists of:

Response Element

Data Type

Description

応答要素

データ型

説明

取得コード

ReportId

Integer

ID of the specified report指定されたレポートのID

getReportId()

ReportName

String

Name of the specified report指定されたレポートの名前

getReportName()

HitCount

Integer

Number of times the specified report has been accessed指定されたレポートがアクセスされた回数

getHitCount()

FormatCode

String

Format code of the specified report指定されたレポートのフォーマットコード

getFormatCode()

BinaryData

String

Base64 encoded binary chunk of XLSXLSのBase64エンコードバイナリーチャンク

getBinaryData()

ContentType

String

MIME Content Type of this object. Value will be “textこのオブジェクトのMIMEコンテンツタイプ。値は「text/tab-separated-values”values」です。

getContentType()

Retrieval Code

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

Expand
titleRTF

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

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

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

rs = ReportService.remoteAdministrationCall(rsr);

The returned ReportServiceResponse object consists of:

Response Element

Data Type

Description

応答要素

データ型

説明

取得コード

ReportId

Integer

ID of the specified report指定されたレポートのID

getReportId()

ReportName

String

Name of the specified report指定されたレポートの名前

getReportName()

HitCount

Integer

Number of times the specified report has been accessed指定されたレポートがアクセスされた回数

getHitCount()

FormatCode

String

Format code of the specified report指定されたレポートのフォーマットコード

getFormatCode()

BinaryData

String

Base64 encoded binary chunk of XLS

getBinaryDataXLSのBase64エンコードバイナリーチャンク

getBinaryData()

ContentType

StringMIME

Content Type of this object. Value will be “application/rtf”このオブジェクトのMIMEコンテンツタイプ。値は「application/rtf」です。

getContentType()

Retrieval Code

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

Expand
titleDOC

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

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

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

rs = ReportService.remoteAdministrationCall(rsr);

The returned ReportServiceResponse object consists of:

Response Element

Data Type

Description

応答要素

データ型

説明

取得コード

ReportId

Integer

ID of the specified report指定されたレポートのID

getReportId()

ReportName

String

Name of the specified report指定されたレポートの名前

getReportName()

HitCount

Integer

Number of times the specified report has been accessed指定されたレポートがアクセスされた回数

getHitCount()

FormatCode

String

Format code of the specified report指定されたレポートのフォーマットコード

getFormatCode()

BinaryData

String

Base64 encoded binary chunk of XLSXLSのBase64エンコードバイナリーチャンク

getBinaryData()

ContentType

String

MIME Content Type of this object. Value will be “applicationこのオブジェクトのMIMEコンテンツタイプ。値は「application/vnd.ms-word”word」です。

getContentType()

Retrieval Code

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

Expand
titleSCHEMA

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

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

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

rs = ReportService.remoteAdministrationCall(rsr);

The returned ReportServiceResponse object consists of:

Response Element

Data Type

Description

応答要素

データ型

説明

取得コード

ReportId

Integer

ID of the specified report指定されたレポートのID

getReportId()

StatusCode

String

Status of the web service requestWebサービスリクエストのステータス

getStatusCode()

FormatCode

String

Format code of the specified report指定されたレポートのフォーマットコード

getFormatCode()

ReportType

String

Report type of the specified report指定されたレポートのレポートタイプ

getReportType()

LastRunStatus

String

Status code of last report run最後のレポート実行のステータスコード

getLastRunStatus()

LastRunTime

Decimal

Last report run time in the format of YYYYMMDDHHMMSSYYYYMMDDHHMMSS形式で示されるレポートの最終実行時間

getLastRunTime()

ReportName

String

Name of the specified report指定されたレポートの名前

getReportName()

BinaryData

String

Base64 encoded binary chunk of image, HTML, CSV, or PDFイメージ、HTML、CSV、またはPDFのBase64エンコードバイナリーチャンク

getBinaryData()

ViewName

String

Name of view that the report depends onレポートが依存するビューの名前

getViewName()

HitCount

Integer

Number of times the specified report has been accessed指定されたレポートがアクセスされた回数

getHitCount()

DrillCode

String

Drill type if available on the reportドリルタイプ（レポートで使用可能な場合）

getDrillCode()

Private

 

Determines if the report is a private or a public oneレポートが個人用または共有のいずれであるかを判別します。

getPrivate()

Results

Array（ReportRow）

Array (レポート結果セットの結果が含まれる、ReportRowオブジェクトの配列（ReportRow)

Array of ReportRow objects that contain results in the report result set (see Report Service)

を参照）

getResults()

ContentType

String

MIME ContentType of the returned object. Possible values include:

  • “text/html”
    • “text

    返されたオブジェクトのMIMEコンテンツタイプ。可能な値は以下の通りです。

    • 「text/html」
    • 「text/comma-separated-values”values」
    • “image「image/png”png」
    • “application「application/pdf”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 errorsArray（String）

    レポートがサーバー上で実行されるときにデバッグ情報を示す文字列の配列。エラーのデバッグおよび追跡に使用します。

    getMessages()

    Charts

    Array (ReportChart)

    Array of ReportChart objects that contains multiple chart bitmaps when attached to a HTML report response (see Report Service)

    getCharts()

    Columns

    HTMLレポート応答に付加される、複数のグラフビットマップを含む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 Report Service

    )レポート結果セットの各カラムの情報、およびユーザープロンプトフィルターデータをレポートに渡す必要があるかどうかを示す情報が含まれるReportSchemaオブジェクトの配列（ReportSchemaを参照）

    getColumns()

    ReportServiceRequest rsr = new ReportServiceRequest();

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

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

    Expand
    titleHTML / 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 Block
    Code Block
    ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;

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

rs = ReportService.remoteAdministrationCall(rsr);

    The returned ReportServiceResponse object consists of:

    Response Element

    Data Type

    Description

    Retrieval Code

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

    応答要素

    データ型

    説明

    取得コード

    Chart

    Array (ReportChart)Array of ReportChart objects that contains multiple chart bitmaps when attached to a HTML report response (see Report Service)

    HTMLレポート応答に付加される、複数のグラフビットマップを含むReportChartオブジェクトの配列（ReportChartを参照）

    getCharts()

    ReportBinaryObject

    Array (ReportBinaryObject)Array of ReportBinaryObject objects that contain BLOBs and CLOBs (see Report Service)

    BLOBおよびCLOBを含むReportBinaryObjectオブジェクトの配列（ReportBinaryObjectを参照）

    getBinaryObjects()

    ReportStyles

    String

    CSS stylesCSSスタイル

    getReportStyles()

    Breadcrumbs

    Array (Breadcrumb)

    Array of Breadcrumb objectsArray（Breadcrumb）

    Breadcrumbオブジェクトの配列

    getBreadcrumbs()

    SeriesSelection

    Array (SeriesSelection)

    Array of SeriesSelection objectsArray（SeriesSelection）

    SeriesSelectionオブジェクトの配列

    getSeriesSelections()

    TimeAggregationSelection

    Array (TimeAggregationSelection)

    Array of TimeAggregationSelection objectsArray（TimeAggregationSelection）

    TimeAggregationSelectionオブジェクトの配列

    getTimeAggregationSelection()

    ReportTabSelection

    Array (ReportTabSelection)

    Array of ReportTabSelection objectsArray（ReportTabSelection）

    ReportTabSelectionオブジェクトの配列

    getReportTabSelection()

    ReportPageSelection

    Array（ReportPageSelection）

    Array ReportPageSelectionオブジェクトの配列

    getReportPageSelection(ReportPageSelection)

    Array of ReportPageSelection objects

    getReportPageSelection()

    TimeSliderSelection

    Array (TimeSliderSelection)

    Array of TimeSliderSelection objects

    TimeSliderSelection

    Array（TimeSliderSelection）

    TimeSliderSelectionオブジェクトの配列

    getTimeSliderSelection()

    SortableColumns

    Array (SortableTableColumn)

    Array of SortableTableColumn objectsArray（SortableTableColumn）

    SortableTableColumnオブジェクトの配列

    getSortableColumns()

    SelectedSortColumn

    Integer

    Column used for sorting. The index here applies to the column index within the report並べかえに使用するカラム。このインデックスは、レポート内のカラムインデックスに適用されます。

    getSelectedSortColumn()

    SelectedSortOrder

    Integer

    The sort order of the column used for sorting (0 for ascending and 1 for descending)並べかえに使用するカラムの並べかえ順序（0が昇順、1が降順）

    getSelectedSortOrder()

    DrillCode

    String

    Drill type if available on the reportドリルタイプ（レポートで使用可能な場合）

    getDrillCode()

    RelatedReports

    Array Array（RelatedReport）

    RelatedReportオブジェクトの配列。これは、メインレポートにマルチ表示（タブ化）されるレポートです。

    getRelatedReports(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

    BinaryData

    String

    HTMLドキュメントのBase64エンコードバイナリーチャンク

    getBinaryData()

    Private

     

    Determines if the report is a private or a public oneレポートが個人用または共有のいずれであるかを判別します。

    getPrivate()

    ContentType

    StringMIME

    ContentType of the returned object. Value will be “text/html”返されたオブジェクトのMIMEコンテンツタイプ。値は「text/html」です。

    getContentType()

    CanDrill

    Boolean

    If the report is able to drill or notレポートがドリル可能かどうか

    getCanDrill()

    GoogleMaps

    Array (GMap)

    Array of GMap objectsArray（GMap）

    GMapオブジェクトの配列

    getGoogleMaps()

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

    The following code will accomplish this:

    ReportServiceRequest Retrieval Code

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

    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:
    Expand
    titleFILTEROPTIONS
    Code Block

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

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

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

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

rs = ReportService.remoteAdministrationCall(rsr);

    The returned ReportServiceResponse object consists of:

    Response Element

    Data Type

    Description

    応答要素

    データ型

    説明

    取得コード

    Results

    Array (ReportRow)

    Array of ReportRow objects that contain filter values (see Report Service)

    getResults()

    Expand
    titleRESULTSET

    フィルター値を含むReportRowオブジェクトの配列（ReportRowを参照

    getResults()

    Retrieval Code

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

    Expand
    titleRESULTSET

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

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

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

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

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

rs = ReportService.remoteAdministrationCall(rsr);

    The returned ReportServiceResponse object consists of:

    Response Element

    Data Type

    Description

    応答要素

    データ型

    説明

    取得コード

    Results

    Array (ReportRow)Array of ReportRow objects that contain results in the report result set (see Report Service)

    レポート結果セットの結果が含まれる、ReportRowオブジェクトの配列（ReportRowを参照）

    getResults()

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

    The following code will accomplish this:
    Expand
    titleEXPIRESESSION
    EXPIRESESSION

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

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

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

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

rs = ReportService.remoteAdministrationCall(rsr);
    Comments

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

    Expand
    titleGETCOMMENTS

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

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

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

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

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

rs = ReportService.remoteAdministrationCall(rsr);

    The returned ReportServiceResponse object consists of:

    Response Element

    Data Type

    Description

    Retrieval Code

    応答要素

    データ型

    説明

    取得コード

    コメント

    Array (ReportComment)Array of ReportComment objects that contain the report’s comments (see Report Service)

    レポートのコメントを含むReportCommentオブジェクトの配列（ReportCommentを参照）

    getComments()

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

    The following code will accomplish this:
    Expand
    titleLEAVECOMMENT
    titleLEAVECOMMENT

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

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

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

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

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

rs = ReportService.remoteAdministrationCall(rsr);
    Expand
    titleDELETECOMMENT

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

    The following code with accomplish this:DELETECOMMENTリクエストは、レポートから特定のコメントを削除します。

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

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

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

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

rs = ReportService.remoteAdministrationCall(rsr);
    Expand
    titleCOMMENTSTATUS

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

    The following code will accomplish this:COMMENTSTATUSリクエストは、特定のコメントのステータスを設定します。

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

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

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

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

rs = ReportService.remoteAdministrationCall(rsr);
    Expand
    titleDISTRIBUTEINBOX

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

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

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

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

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

rs = ReportService.remoteAdministrationCall(rsr);

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

    The following code will accomplish this:Retrieval Code

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

    Expand
    titleGETDISPLAYEDREPORTID
    GETDISPLAYEDREPORTID

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

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

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

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

rs = ReportService.remoteAdministrationCall(rsr);

    The returned ReportServiceResponse object consists of:

    Response Element

    Data Type

    Description

    応答要素

    データ型

    説明

    取得コード

    DisplayedReportId

    Integer

    Report ID of the currently displayed report現在表示されているレポートのレポートID

    getDisplayedReportId()

    Retrieval Code
    Expand
    titleGETKPI

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

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

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

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

rs = ReportService.remoteAdministrationCall(rsr);

    The returned ReportServiceResponse object consists of:

    Response Element

    Data Type

    Description

    返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。
    応答要素
    データ型
    説明
    取得コード
    KPI
    KPI object
    This is a custom KPI object which holds the actual, target, and variance values for a particular KPI metric (see Report Service)KPIオブジェクト
    特定のKPIメトリック（数値）について、実績、目標、および差異の値を保持するカスタムKPIオブジェクト（KPIを参照）
    getKPI()
    Array of Strings
     Expand
    titleGETDRILLANYWHEREMENU
    The GETDRILLANYWHEREMENU request will return you the Drill Anywhere menu that is available for the selected report column. This function request is usually utilized within the mobile application.
    The following code will accomplish this:GETDRILLANYWHEREMENUリクエストは、選択されたレポートカラムで使用できる「ドリルエニウェア」メニューを返します。この関数リクエストは通常、モバイルアプリケーション内で利用されます。
    これを実行するコードは以下の通りです。
     Code Block
    ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;

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

rs = ReportService.remoteAdministrationCall(rsr);

    The returned ReportServiceResponse object consists of:
    Response Element
    Data Type
    Description
    Retrieval Code
    DrillAnywhereCategories
    Array (String)
    

    返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。
    応答要素
    データ型
    説明
    取得コード
    DrillAnywhereCategories
    Array（String）
    文字列の配列
    getDrillAnywhereCategories()
    DrillAnywhereTargets
    Array (DrillAnywhereTarget)Array of DrillAnywhereTarget objects that lists the drill anywhere targets for a drill anywhere category (see Report Service)
    ドリルエニウェアカテゴリーのドリルエニウェア目標を一覧表示するDrillAnywhereTargetオブジェクトの配列（DrillAnywhereTargetを参照）
    getDrillAnywhereTargets()
    Retrieval Code
    返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。
     Expand
    titleSUBSCRIBEDETAILS
    The SUBSCRIBEDETAILS request will return the schedule record for a particular report.
    The following code will accomplish this:SUBSCRIBEDETAILSリクエストは、特定のレポートのスケジュールレコードを返します。
    これを実行するコードは以下の通りです。
     Code Block
    ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
ScheduleRecord sr = null;

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

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

    The returned ReportServiceResponse object consists of:
    Response Element
    Data Type
    Description
    応答要素
    データ型
    説明
    取得コード
    ScheduleRecordScheduleRecord object
    ScheduleRecordオブジェクトScheduleRecord 
     object which contains subscription details and conditions (see Report Service)購読詳細と条件を含むScheduleRecordオブジェクト（ScheduleRecordを参照）
    getSchedule()
     Expand
    titleSUBSCRIBE
    The SUBSCRIBE request will create/modify a subscription to a specified report for a specified user. This function request is usually called after SUBSCRIBEDETAILS to retrieve a current subscription first, otherwise a ScheduleRecord object must be created and populated appropriately (refer to Report Service) for this function call.
    The following code will accomplish this:SUBSCRIBEリクエストは、指定されたユーザーの指定のレポートに対する購読を作成/変更します。この関数リクエストは通常、まず現在の購読を取得するために、SUBSCRIBEDETAILSのあとに呼び出されます。そうでない場合、この関数呼び出しのために、ScheduleRecordオブジェクトを作成して適切なデータを投入する必要があります（ScheduleRecordを参照）。
    これを実行するコードは以下の通りです。
     Code Block
    ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
// Either retrieve a current ScheduleRecord beforehand or create a new one. A new one is created in this example
ScheduleRecord sr = new ScheduleRecord();

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

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

rs = ReportService.remoteAdministrationCall(rsr);

    The UNSUBSCRIBE request will unsubscribe a specified user from a specified report.
    The following code will accomplish this:
     Expand
    titleUNSUBSCRIBE
    titleUNSUBSCRIBE
    UNSUBSCRIBEリクエストは、指定のレポートから指定されたユーザーの購読を取り消します。
    これを実行するコードは以下の通りです。
     Code Block
    ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;

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

rs = ReportService.remoteAdministrationCall(rsr);

    Retrieval Code
    返されるReportServiceResponseオブジェクトは、以下の項目で構成されます。
     Expand
    titleLOADDASHBOARDTAB
    The LOADDASHBOARDTAB request will load a specified dashboard tab and its metadata.
    The following code will accomplish this:LOADDASHBOARDTABリクエストは、指定されたダッシュボードタブとそのメタデータをロードします。
    これを実行するコードは以下の通りです。
     Code Block
    ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
DashboardDefinition dd = null;

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

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

    The returned ReportServiceResponse object consists of:
    Response Element
    Data Type
    Description
    応答要素
    データ型
    説明
    取得コード
    DashboardDefinitionDashboardDefinition object
    DashboardDefinitionオブジェクトDashboardDefinition 
     object which contains dashboard tab metadata (see Report Service)ダッシュボードタブのメタデータを含むDashboardDefinitionオブジェクト（DashboardDefinitionを参照
    getDashboard()
     Expand
    titleAPPLYDASHBOARDFILTERS
    The following code will accomplish this:
     Code Block
    ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
DashboardFilter[] dfarray = null;
DashboardFilter df = new DashboardFilter();

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

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

rs = ReportService.remoteAdministrationCall(rsr);

     Expand
    titleGETDASHBOARDREPORTFILTERVALUES
    The GETDASHBOARDREPORTFILTERVALUES request will return filter metadata for a particular report on a dashboard tab.
    The following code will accomplish this:
     Code Block
    ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
ReportFilter[] rf = null;

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

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

    The returned ReportServiceResponse object consists of:
    Response Element
    Data Type
    Description
    Retrieval Code
    ReportFilters
    Array (ReportFilter)
    Array of Filter objects containing metadata for each filter (see Report Service ReportFilter)
    getReportFilters()
     Expand
    titleRUNDASHBOARDREPORT
    The RUNDASHBOARDREPORT request will run and export a specified report on a dashboard tab. The response will include Base64 encoded generated html, including charts, GIS maps, and CSS styles.
    The following code will accomplish this:
     Code Block
    ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;

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

rs = ReportService.remoteAdministrationCall(rsr);

    The returned ReportServiceResponse object consists of:
    Response Element
    Data Type
    Description
    Retrieval Code
    BinaryData
    String
    Base64 encoded binary chunk of HTML
    getBinaryData()
    Charts
    Array (ReportChart)
    Array of ReportChart objects (see Report Service ReportChart)
    getCharts()
    ReportStyle
    String
    CSS styles
    GetReportStyle()
    Breadcrumbs
    Array (Breadcrumb)
    Array of Breadcrumb objects
    getBreadcrumbs()
    GoogleMaps
    Array (GMap)
    Array of GoogleMaps objects if the report’s chart uses it
    getGoogleMaps()
    GisMap
    Array (GISMap)
    Array of GISMap objects if the report’s chart uses it
    getGisMap()
    Object Definitions
     Anchor
    ReportComment
    ReportComment
    ...
     Expand
    titleScheduleRecord
    ScheduleRecord Element
    Data Type
    Description
    Retrieval Code
    Recipient
    Integer
    ID of recipient of 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 Report Service Condition)
    getConditionList()
    AdvancedTimezoneCode
    String
    Timezone in which the subscription happens
    getAdvancedTimezoneCode()
    AdvancedTime
    Integer
    Local run time for the subscription
    getAdvancedTime()
    ...
     Expand
    titleDashboardDefinition
    DashboardDefinition Element
    Data Type
    Description
    Retrieval Code
    TabId
    Integer
    ID of the dashboard tab
    getTabId()
    GroupTypeCode
    String
    Type of dashboard tab. Values include:
    • ANALYTIC
    • KPI
    • STANDARD
    getGroupTypeCode()
    Owner
    Integer
    ID of dashboard owner
    getOwner()
    OwnerTypeCode
    String
    Type of dashboard owner. Value defaults to 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 letter 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
    getParentGroupId()
    Elements
    Array (DashboardElement)
    A DashboardElement object contains portlet information for reports that reside within the dashboard tab (See Report Service DashboardElement)
    getElements()
    Filters
    Array (DashboardFilterDefinition)
    A DashboardFilterDefinition object contains format records pertaining the dashboard tab, analytic filters, and filter groups (See Report Service DashboardFilterDefinition)
    getFilters()
    Fields
    Array (DashboardFieldDefinition)
    A DashboardFieldDefinition object contains format records pertaining fields being displayed as drilldowns on the dashboard tab
    getFields()
    ...