Oracle Business Intelligence PublisherのREST API

レポートの作成

post

/services/rest/v1/reports

Oracle BI Publisherカタログでレポートを作成します。データ・モデルにパスを設定し、テンプレート・ファイルと翻訳(XLIFF)ファイルをレポート定義に指定できます。

リクエスト

サポートされているメディア・タイプ

multipart/form-data

フォーム・パラメータ

ReportRequest:

"Content-Type: application/json"を含むレポート・メタデータ。JSON構造の詳細は例のセクションを参照
TemplateData(optional): file

テンプレート・ファイル。"Content-Type: application/octet-stream"
XliffData(optional): file

翻訳ファイル(XLIFF)。"Content-Type: application/octet-stream"

先頭に戻る

レスポンス

201レスポンス

レポートが正常に作成されました。

400レスポンス

レポートの作成中にエラーが発生しました

先頭に戻る

例

簡易なレポート作成リクエスト

次の例は、レポート作成に使用するリクエスト構造を示しています。

--Boundary_1_1153447573_1465550157807
Content-Type: application/json
Content-Disposition: form-data; name="ReportRequest"

{"absolutePath":"FolderName/SubFolderName/","dataModelPath":"/Sample Lite/Published Reporting/Data Models/Balance Letter Datamodel.xdm","name":"ReportName","update":false}
--Boundary_1_1153447573_1465550157807--

変数の意味は次のとおりです。

name (string): レポートの名前。サフィックスに.xdoを付けないでください。たとえば、name="myreport" (not name="myreport.xdo")と指定します。
absolutePath (string): レポートを保存するフォルダへのパス。(例: xmlp/Reports/financials)。
dataModelPath (string): このレポートのデータ・ソースとして使用されるデータ・モデルへのパス。(例: xmlp/Reports/financials/Data Models/my data model.xdm)。
templateFileName(string): レポート定義を追加するテンプレートのファイル名。
xliffFileName (string): 翻訳XLIFFファイルのファイル名。次のロケールを追加します。
- template_<language code>_<country code>.xlf
変数の意味は次のとおりです。
- language_codeは、2文字のISO 639言語コードです。
- country_codeは、2文字のISO 639言語コードです。
例: template_en_us.xlf
update (boolean): trueの場合、既存のレポートをオーバーライドします。falseの場合、レポートが存在すればエラーがスローされます。

次の例は、cURLを使用してRESTリソースにPOSTリクエストを発行して、既存のデータ・モデルからレポートを作成する方法を示しています。

curl -X POST -u username:password  
-H "Content-Type:multipart/form-data"  -F
      'ReportRequest={"absolutePath":"FolderName/SubFolderName/",
"dataModelPath":"/Sample Lite/Published Reporting/Data Models/Balance Letter
      Datamodel.xdm","name":"ReportName","update":false};
type=application/json' 
http://host.com:port/xmlpserver/services/rest/v1/reports

カスタム・テンプレートを使用するレポートの作成

次の例は、cURLを使用してRESTリソースにPOSTリクエストを発行して、カスタム・テンプレートを使用してレポートを作成する方法を示しています。

「Balance Letter.rtf」テンプレートが、cURLコマンドを実行するディレクトリと同じディレクトリにあることを確認してください。

curl -X POST -u username:password -H "Content-Type:multipart/form-data"  -F
      'TemplateData=@Balance Letter.rtf;type=application/octet-stream' -F
      'ReportRequest={"absolutePath":"FolderName/SubFolderName/","dataModelPath":"/Sample
      Lite/Published Reporting/Data Models/Balance Letter
      Datamodel.xdm","name":"ReportName","update":false};type=application/json' http://host.com:port/xmlpserver/services/rest/v1/reports

カスタム・テンプレートとXLIFFデータを使用するレポートの作成

次の例は、cURLを使用してRESTリソースにPOSTリクエストを発行して、カスタム・テンプレートおよびXLIFFデータを使用してレポートを作成する方法を示しています。

「Balance Letter.rtf」テンプレートおよびXLIFFデータが、cURLコマンドを実行するディレクトリと同じディレクトリにあることを確認してください。

curl -X POST -u username:password -H "Content-Type:multipart/form-data"  -F
      'XliffData=@translation.xlf;type=application/octet-stream'  -F 'TemplateData=@Balance Letter.rtf;type=application/octet-stream' -F
      'ReportRequest={"absolutePath":"FolderName/SubFolderName/","dataModelPath":"/Sample
      Lite/Published Reporting/Data Models/Balance Letter
      Datamodel.xdm","name":"ReportName","update":false};type=application/json' http://host.oracle.com:port/xmlpserver/services/rest/v1/reports

先頭に戻る