レポート定義の更新
put
/services/rest/v1/reports/{reportPath}
レポート定義ファイル(.xdo)の属性を更新して、そのファイルをOracle BI Publisherカタログに書き戻します。
リクエスト
サポートされているメディア・タイプ
- application/json
パス・パラメータ
- 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となります。
レポート定義
ルート・スキーマ: ReportDefinition
型:
ソースを表示
object
- autoRun(optional): boolean
trueは、レポート・プロパティの「オートラン」がオンになっていることを意味します。
- cacheDocument(optional): boolean
trueは、レポート・プロパティの「ドキュメント・キャッシュの有効化」がオンになっていることを意味します。
- controledByExtApp(optional): boolean
レポートの定義を外部アプリケーションで制御する(true)かまたはしない(false)かを示します。
- dataModelURL(optional): string
データ・モデルの定義を取得する.xdmファイルの場所。
- defaultOutputFormat(optional): string
デフォルトの出力フォーマット。有効な値: csv (CSV) data (データ) eText (eTextテンプレート) excel (Microsoft Excel) excel2000 (Microsoft Excel 2000) フラッシュ(Adobe Flash) html (HTML) mhtml (MIME HTML) pdf (Adobe PDF) ppt (Microsoft PowerPoint) rtf (リッチ・テキスト・フォーマット)
- defaultTemplateId(optional): string
そのレポートに対して特定されたデフォルトのテンプレート。
- diagnostics(optional): boolean
trueは、そのレポートに対して診断がオンになっていることを意味します。
- ESSJobName(optional): string
ESSジョブ名。
- listOfTemplateFormatsLabelValues(optional): array listOfTemplateFormatsLabelValues
- onLine(optional): boolean
trueは、レポート・プロパティの「レポート・オンラインの実行」がオンになっていることを意味します。
- openLinkInNewWindow(optional): boolean
trueは、レポート・プロパティの「新規ウィンドウでリンクを開く」がオンになっていることを意味します。
- parameterColumns(optional): integer
レポート・プロパティの「行当たりのパラメータ数」の値。
- reportDefnTitle(optional): string
非アクティブ。使用しないでください。
- reportDescription(optional): string
ユーザーがレポートに割当てた説明。
- reportName(optional): string
ユーザーがレポートに割当てた名前。
- reportParameterNameValues(optional): array reportParameterNameValues
- reportType(optional): string
非アクティブ。使用しないでください。
- showControls(optional): boolean
trueは、レポート・プロパティの「コントロールの表示」がオンになっていることを意味します。
- showReportLinks(optional): boolean
trueは、レポート・プロパティの「レポート・リンクの表示」がオンになっていることを意味します。
- templateIds(optional): array templateIds
レポート・テンプレートのレイアウト名を渡します。
ネストされたスキーマ: TemplateFormatsLabelValues
型:
ソースを表示
object
- active(optional): boolean
テンプレートがアクティブ(true)またはアクティブでない(false)かを示します。
- applyStyleTemplate(optional): boolean
スタイル・テンプレートを適用する(true)か適用しない(false)かを示します。
- default(optional): boolean
テンプレートがデフォルト・テンプレート(true)かデフォルト・テンプレートでない(false)かを示します。
- listOfTemplateFormatLabelValue(optional): array listOfTemplateFormatLabelValue
TemplateFormatLabelValueのラベルと値のペアが格納されます。
- templateAvailableLocales(optional): array templateAvailableLocales
テンプレートに対して定義されている使用可能なロケール・オプション。
- templateBaseLocale(optional): string
テンプレートに対して定義されているベース・ロケール・オプション。
- templateDefaultLocale(optional): string
テンプレートに対して定義されているデフォルト・ロケール・オプション。
- templateID(optional): string
Oracle BI Publisherでテンプレートに割り当てられている名前です。例: "Employee Listing"。
- templateType(optional): string
テンプレートのタイプです。例: "rtf"、"pdf"
- templateURL(optional): string
Oracle BI Publisherリポジトリ内のテンプレート・ファイル名です。例: "Employee Listing.rtf"。
- viewOnline(optional): boolean
テンプレートがオンラインで表示できる(true)か表示できない(false)かを示します。
ネストされたスキーマ: listOfTemplateFormatLabelValue
型:
array
TemplateFormatLabelValueのラベルと値のペアが格納されます。
ソースを表示
ネストされたスキーマ: TemplateFormatLabelValue
型:
ソースを表示
object
- templateFormatLabel(optional): string
テンプレート・フォーマットに対して表示されるラベルです。たとえば、"HTML"、"PDF"、"Excel"などがあります。
- templateFormatValue(optional): string
ラベルに対応するテンプレート・フォーマットの値です。たとえば、"html"、"pdf"、"excel"などがあります。
ネストされたスキーマ: ParamNameValues
型:
ソースを表示
object
- listOfParamNameValues(optional): array listOfParamNameValues
ParamNameValueの配列
ネストされたスキーマ: ParamNameValue
型:
ソースを表示
object
- dataType(optional): string
有効な値: Boolean Date Float Integer String
- dateFormatString(optional): string
UITypeがDateの場合は、日付フォーマット文字列を指定します。日付フォーマット文字列にはJava日付フォーマットを使用する必要があります(MM-DD-YYYYなど)。
- dateFrom(optional): string
UITypeがDateの場合は、日付の開始値を指定します。
- dateTo(optional): string
UITypeがDateの場合は、日付の終了値を指定します。
- defaultValue(optional): string
パラメータのデフォルト値を指定します。
- fieldSize(optional): string
パラメータ・タイプが"Text"または"Date"の場合に、パラメータのテキスト・フィールド・サイズを指定します。
- label(optional): string
パラメータ・タイプが"Hidden"以外の場合に、パラメータの表示ラベルを指定します。
- lovLabels(optional): array lovLabels
パラメータ・タイプが"Menu"の場合に、ユーザーに表示される値リストの値を指定します。
- multiValuesAllowed(optional): boolean
trueは、パラメータに複数の値が含まれている可能性があることを意味します。
- name(optional): string
パラメータ名。
- refreshParamOnChange(optional): boolean
パラメータ・タイプが"Text"または"Menu"で、このパラメータの値がtrueの場合は、このパラメータに対する選択が行われたときに他の定義済パラメータがリフレッシュされることを示します。
- selectAll(optional): boolean
パラメータ・タイプが"Menu"の場合、trueは値リストのすべての値を選択できることを示します。
- templateParam(optional): boolean
trueは、パラメータがRTFテンプレートで定義されていることを示します。
- UIType(optional): string
Oracle BI Publisherのデータ・モデル・ユーザー・インタフェースで定義されているパラメータのタイプです。有効な値: Date Hidden Menu Search Text
- useNullForAll(optional): boolean
パラメータ・タイプが"Menu"の場合、trueはパラメータのすべての値が選択されるとnullが渡されることを示します。
- values(optional): array values
パラメータ値。
レスポンス
200レスポンス
レポート定義の更新が成功しました。
400レスポンス
レポート定義の更新中にエラーが発生しました。
ルート・スキーマ: schema
型:
string