レポートの実行
post
/services/rest/v1/reports/{reportPath}/run
パブリッシャにリクエストを送信して特定のレポートを実行します。リクエストは同期され、レスポンスにはレポート出力が含まれます。
リクエスト
サポートされているメディア・タイプ
- multipart/form-data
パス・パラメータ
- reportPath: string
URLエンコードされたレポート・パス。たとえば、レポート・パスが"/Sample Lite/Published Reporting/Reports/Balance Letter"の場合、エンコードされたレポート・パスは"%2FSample%20Lite%2FPublished%20Reporting%2FReports%2FBalance%20Letter"となります。エンコードされたスラッシュを渡すように構成されていないロード・バランサを介してBI PublisherにRESTリクエストを送信する場合は、二重にエンコードされたスラッシュを使用します。たとえば、レポート・パスがSample Lite/Published Reporting/Reports/Balance Letterの場合、エンコードされたレポート・パスはSample%20Lite%252FPublished%20Reporting%252FReports%252FBalance%20Letterとなります。
フォーム・パラメータ
- ReportData(optional): file
レポート・データ。"Content-Type: application/octet-stream"
- ReportRequest:
レポート・リクエスト。"Content-Type: application/json".レポート・パラメータの取得(/services/rest/v1/reports/{reportPath}/parameters)のReportRequestでJSON構造を確認します。
レスポンス
サポートされているメディア・タイプ
- multipart/form-data
200レスポンス
レポート出力を次の2つの部分を含むmultipart/form-dataとして返します。1) "Content-Type: application/json"を含むReportResponse。2) "Content-Type: application/octet-stream"を含むReportOutput。
ネストされたスキーマ: ReportResponseMetaData
型:
ソースを表示
object
- metaDataList(オプション): object MetaDataList
- reportContentType(オプション): string
レポートのコンテンツ・タイプ。指定可能な値: "text/html;charset=UTF-8""text/plain;charset=UTF-8" "application/pdf" "application/vnd.ms-powerpoint" "application/vnd.ms-excel" "application/msword" "application/x-shockwave-flash" "text/xml" "message/rfc822"
- reportLocale(オプション): string
レポートに対して選択されたロケール(fr_FRなど)。
ネストされたスキーマ: MetaDataList
型:
ソースを表示
object
- metaDataName(オプション): string
メタデータの名前。
- metaDataValue(オプション): string
メタデータのコンテンツ。
例
簡易なレポートの実行リクエストとレスポンス
この例は、簡易なレポートを実行するためのリクエスト構造を示しています。
--Boundary_1_1153447573_1465550731355 Content-Type: application/json Content-Disposition: form-data; name="ReportRequest" {"byPassCache":true,"flattenXML":false} --Boundary_1_1153447573_1465550731355--
この例は、レスポンスを示しています。
--Boundary_4_543972006_1465550732053 Content-Type: application/json Content-Disposition: form-data; name="ReportResponse" {"reportContentType":"application/pdf"} --Boundary_4_543972006_1465550732053 Content-Type: application/octet-stream Content-Disposition: form-data; filename="xmlp3001677868600512506tmp"; modification-date="Fri, 10 Jun 2017 09:25:32 GMT"; size=7638; name="ReportOutput" <Report output. For example PDF,HTML,EXCEL content> --Boundary_4_543972006_1465550732053--
カスタム・レポート・データを含むレポートを実行します。
この例は、カスタム・レポート・データを使用してレポートを実行するためのリクエスト構造を示しています。
--Boundary_3_384617262_1465550732541 Content-Type: application/json Content-Disposition: form-data; name="ReportRequest" {"byPassCache":true,"flattenXML":false} --Boundary_3_384617262_1465550732541 Content-Type: application/xml Content-Disposition: form-data; filename="Balance Letter.xml"; modification-date="Tue, 01 Jan 2000 07:35:28 GMT"; size=24700; name="ReportData" <Report XML Data Content> --Boundary_3_384617262_1465550732541--
この例は、レスポンスを示しています。
--Boundary_6_656616533_1465550732888 Content-Type: application/json Content-Disposition: form-data; name="ReportResponse" {"reportContentType":"application/pdf"} --Boundary_6_656616533_1465550732888 Content-Type: application/octet-stream Content-Disposition: form-data; filename="xmlp2661880851808387788tmp"; modification-date="Fri, 01 Jan 2000 09:25:32 GMT"; size=7647; name="ReportOutput" <Report output. For example PDF,HTML,EXCEL content> --Boundary_6_656616533_1465550732888--
パラメータ値を渡すことによるレポートの実行
この例は、パラメータ値を渡してレポートを実行するためのリクエスト構造を示しています。
curl -X POST -u Administrator:Administrator -o report_output.xml
-H "Content-Type:multipart/form-data"
-v -F 'ReportRequest={"attributeFormat":"xml",
"attributeTemplate":"Publisher Template",
"parameterNameValues":{"listOfParamNameValues":
{"item": [{"name": "dept","values": { "item": "10" }},
{"name": "emp","values": { "item": "*" }}]}}};
type=application/json'
http://host.com:9502/xmlpserver/services/rest/v1/reports/BalanceLetter/run
この例は、レスポンスを示しています。
POST /xmlpserver/services/rest/v1/reports/sal/run HTTP/1.1 Authorization: Basic QWRtaW5pc3RyYXRvcjpBZG1pbmlzdHJhdG9y User-Agent: curl/7.29.0 Host: host:9080 Accept: */* Content-Length: 393 Expect: 100-continue Content-Type:multipart/form-data; boundary=----------------------------70dcb3a85b79