1. Oracle Analytics ServerでのOracle Analytics PublisherのためのREST API
  2. タスク
  3. レポートの管理

レポート定義の取得

get

/services/rest/v1/reports/{reportPath}

レポートに関する情報(デフォルトのテンプレート、出力タイプ、テンプレートIDのリストなど)を取得します。テンプレートIDのリストを使用して、デフォルト以外のテンプレートでレポートを生成できます。

リクエスト

パス・パラメータ
  • 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となります。
先頭に戻る

レスポンス

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

200レスポンス

レポート定義を返します。
本文 ()
ルート・スキーマ: ReportDefinition
型: object
ソースを表示
ネストされたスキーマ: listOfTemplateFormatsLabelValues
型: array
ソースを表示
ネストされたスキーマ: reportParameterNameValues
型: array
ソースを表示
ネストされたスキーマ: templateIds
型: array
レポート・テンプレートのレイアウト名を渡します。
ソースを表示
ネストされたスキーマ: TemplateFormatsLabelValues
型: object
ソースを表示
ネストされたスキーマ: listOfTemplateFormatLabelValue
型: array
TemplateFormatLabelValueのラベルと値のペアが格納されます。
ソースを表示
ネストされたスキーマ: templateAvailableLocales
型: array
テンプレートに対して定義されている使用可能なロケール・オプション。
ソースを表示
ネストされたスキーマ: TemplateFormatLabelValue
型: object
ソースを表示
  • テンプレート・フォーマットに対して表示されるラベルです。たとえば、"HTML"、"PDF"、"Excel"などがあります。
  • ラベルに対応するテンプレート・フォーマットの値です。たとえば、"html"、"pdf"、"excel"などがあります。
ネストされたスキーマ: ParamNameValues
型: object
ソースを表示
ネストされたスキーマ: listOfParamNameValues
型: array
ParamNameValueの配列
ソースを表示
ネストされたスキーマ: ParamNameValue
型: object
ソースを表示
  • 有効な値: Boolean Date Float Integer String
  • UITypeがDateの場合は、日付フォーマット文字列を指定します。日付フォーマット文字列にはJava日付フォーマットを使用する必要があります(MM-DD-YYYYなど)。
  • UITypeがDateの場合は、日付の開始値を指定します。
  • UITypeがDateの場合は、日付の終了値を指定します。
  • パラメータのデフォルト値を指定します。
  • パラメータ・タイプが"Text"または"Date"の場合に、パラメータのテキスト・フィールド・サイズを指定します。
  • パラメータ・タイプが"Hidden"以外の場合に、パラメータの表示ラベルを指定します。
  • lovLabels
    パラメータ・タイプが"Menu"の場合に、ユーザーに表示される値リストの値を指定します。
  • trueは、パラメータに複数の値が含まれている可能性があることを意味します。
  • パラメータ名。
  • パラメータ・タイプが"Text"または"Menu"で、このパラメータの値がtrueの場合は、このパラメータに対する選択が行われたときに他の定義済パラメータがリフレッシュされることを示します。
  • パラメータ・タイプが"Menu"の場合、trueは値リストのすべての値を選択できることを示します。
  • trueは、パラメータがRTFテンプレートで定義されていることを示します。
  • Oracle BI Publisherのデータ・モデル・ユーザー・インタフェースで定義されているパラメータのタイプです。有効な値: Date Hidden Menu Search Text
  • パラメータ・タイプが"Menu"の場合、trueはパラメータのすべての値が選択されるとnullが渡されることを示します。
  • values
    パラメータ値。
ネストされたスキーマ: lovLabels
型: array
パラメータ・タイプが"Menu"の場合に、ユーザーに表示される値リストの値を指定します。
ソースを表示
ネストされたスキーマ: values
型: array
パラメータ値。
ソースを表示
先頭に戻る

例

次の例は、cURLを使用してRESTリソースにGETリクエストを発行して、レポートに関する情報を取得する方法を示しています。

curl -i \
     --header 'Authorization: Bearer <token>' \
     --header 'Content-Type: application/json' \
     --request GET 'https://hostname/xmlpserver/services/rest/v1/reports/Sample%20Lite%252FPublished%20Reporting%252FReports%252FBalance%20Letter'

レスポンス本文の例

JSON形式のレスポンス本文のコンテンツの例を次に示します。

* Connection #0 to host hostname left intact
{"ESSPackageName":"","ESSJobName":"","autoRun":"true","cacheDocument":"false","controledByExtApp":"false","dataModelURL":"/Sample Lite/Published Reporting/Data Models/Balance Letter Datamodel.xdm","defaultOutputFormat":"pdf","defaultTemplateId":"Publisher Template","diagnostics":"false","listOfTemplateFormatsLabelValues":{"item":[{"active":"true","applyStyleTemplate":"false","default":"true","listOfTemplateFormatLabelValue":{"item":[{"templateFormatLabel":"Interactive","templateFormatValue":"analyze"},{"templateFormatLabel":"HTML","templateFormatValue":"html"},{"templateFormatLabel":"PDF","templateFormatValue":"pdf"},{"templateFormatLabel":"Excel (*.xlsx)","templateFormatValue":"xlsx"},{"templateFormatLabel":"PowerPoint (*.pptx)","templateFormatValue":"pptx"},{"templateFormatLabel":"CSV","templateFormatValue":"csv"}]},"templateAvailableLocales":{"item":["en_US"]},"templateBaseLocale":null,"templateDefaultLocale":"en_US","templateID":"Publisher Template","templateType":"xpt","templateURL":"Untitled.xpt","viewOnline":"true"},{"active":"true","applyStyleTemplate":"false","default":"false","listOfTemplateFormatLabelValue":{"item":[{"templateFormatLabel":"HTML","templateFormatValue":"html"},{"templateFormatLabel":"PDF","templateFormatValue":"pdf"},{"templateFormatLabel":"RTF","templateFormatValue":"rtf"},{"templateFormatLabel":"Excel (*.xlsx)","templateFormatValue":"xlsx"},{"templateFormatLabel":"PowerPoint (*.pptx)","templateFormatValue":"pptx"},{"templateFormatLabel":"CSV","templateFormatValue":"csv"}]},"templateAvailableLocales":{"item":["en_US"]},"templateBaseLocale":null,"templateDefaultLocale":"en_US","templateID":"RTF Template","templateType":"rtf","templateURL":"Balance Letter.rtf","viewOnline":"true"},{"active":"true","applyStyleTemplate":"true","default":"false","listOfTemplateFormatLabelValue":{"item":[{"templateFormatLabel":"HTML","templateFormatValue":"html"},{"templateFormatLabel":"PDF","templateFormatValue":"pdf"},{"templateFormatLabel":"RTF","templateFormatValue":"rtf"},{"templateFormatLabel":"Excel (*.xlsx)","templateFormatValue":"xlsx"},{"templateFormatLabel":"PowerPoint (*.pptx)","templateFormatValue":"pptx"},{"templateFormatLabel":"CSV","templateFormatValue":"csv"}]},"templateAvailableLocales":{"item":["en_US"]},"templateBaseLocale":null,"templateDefaultLocale":"en_US","templateID":"RTF Corp Styles","templateType":"rtf","templateURL":"Balance Letter2.rtf","viewOnline":"true"}]},"onLine":"true","openLinkInNewWindow":"true","parameterColumns":3,"reportDefnTitle":"","reportDescription":"Data Model: Balance Letter Data Model --Layouts: RTF, XPT -- Features: Style Template","reportName":"Balance Letter","reportType":null,"showControls":"true","showReportLinks":"true","templateIds":{"item":["Publisher Template","RTF Template","RTF Corp Styles"]}}
先頭に戻る