レポート定義の取得。

get

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

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

• リクエスト
• レスポンス

リクエスト

パス・パラメータ

reportPath

型: string

必須: true

URLエンコードされたレポート・パス。たとえば、レポート・パスが"/Sample Lite/Published Reporting/Reports/Balance Letter"の場合、エンコードされたレポート・パスは"%2FSample%20Lite%2FPublished%20Reporting%2FReports%2FBalance%20Letter"となります。

レスポンス

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

• application/json

200レスポンス

レポート定義を返します。

本文

ルート・スキーマ: ReportDefinition

型: object

プロパティ

autoRun

型: boolean

trueは、レポート・プロパティの「オートラン」がオンになっていることを意味します。

cacheDocument

型: boolean

trueは、レポート・プロパティの「ドキュメント・キャッシュの有効化」がオンになっていることを意味します。

controledByExtApp

型: boolean

レポートの定義を外部アプリケーションで制御する(true)かまたはしない(false)かを示します。

dataModelURL

型: string

データ・モデルの定義を取得する.xdmファイルの場所。

defaultOutputFormat

型: 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

型: string

そのレポートに対して特定されたデフォルトのテンプレート。

diagnostics

型: boolean

trueは、そのレポートに対して診断がオンになっていることを意味します。

ESSJobName

型: string

ESSジョブ名。

listOfTemplateFormatsLabelValues

型: array listOfTemplateFormatsLabelValues

onLine

型: boolean

trueは、レポート・プロパティの「レポート・オンラインの実行」がオンになっていることを意味します。

openLinkInNewWindow

型: boolean

trueは、レポート・プロパティの「新規ウィンドウでリンクを開く」がオンになっていることを意味します。

parameterColumns

型: integer

レポート・プロパティの「行当たりのパラメータ数」の値。

reportDefnTitle

型: string

非アクティブ。使用しないでください。

reportDescription

型: string

ユーザーがレポートに割当てた説明。

reportName

型: string

ユーザーがレポートに割当てた名前。

reportParameterNameValues

型: array reportParameterNameValues

reportType

型: string

非アクティブ。使用しないでください。

showControls

型: boolean

trueは、レポート・プロパティの「コントロールの表示」がオンになっていることを意味します。

showReportLinks

型: boolean

trueは、レポート・プロパティの「レポート・リンクの表示」がオンになっていることを意味します。

templateIds

型: array templateIds

レポート・テンプレートのレイアウト名を渡します。

ネストされたスキーマ: listOfTemplateFormatsLabelValues

型: array

アイテム

• 型: object TemplateFormatsLabelValues

ネストされたスキーマ: reportParameterNameValues

型: array

アイテム

• 型: object ParamNameValues

ネストされたスキーマ: templateIds

型: array

レポート・テンプレートのレイアウト名を渡します。

アイテム

• 型: string

ネストされたスキーマ: TemplateFormatsLabelValues

型: object

プロパティ

active

型: boolean

テンプレートがアクティブ(true)またはアクティブでない(false)かを示します。

applyStyleTemplate

型: boolean

スタイル・テンプレートを適用する(true)か適用しない(false)かを示します。

default

型: boolean

テンプレートがデフォルト・テンプレート(true)かデフォルト・テンプレートでない(false)かを示します。

listOfTemplateFormatLabelValue

型: array listOfTemplateFormatLabelValue

TemplateFormatLabelValueのラベルと値のペアが格納されます。

templateAvailableLocales

型: array templateAvailableLocales

テンプレートに対して定義されている使用可能なロケール・オプション。

templateBaseLocale

型: string

テンプレートに対して定義されているベース・ロケール・オプション。

templateDefaultLocale

型: string

テンプレートに対して定義されているデフォルト・ロケール・オプション。

templateID

型: string

Oracle BI Publisherでテンプレートに割り当てられている名前です。例: "Employee Listing"。

templateType

型: string

テンプレートのタイプです。例: "rtf"、"pdf"

templateURL

型: string

Oracle BI Publisherリポジトリ内のテンプレート・ファイル名です。例: "Employee Listing.rtf"。

viewOnline

型: boolean

テンプレートがオンラインで表示できる(true)か表示できない(false)かを示します。

ネストされたスキーマ: listOfTemplateFormatLabelValue

型: array

TemplateFormatLabelValueのラベルと値のペアが格納されます。

アイテム

• 型: object TemplateFormatLabelValue

ネストされたスキーマ: templateAvailableLocales

型: array

テンプレートに対して定義されている使用可能なロケール・オプション。

アイテム

• 型: string

ネストされたスキーマ: TemplateFormatLabelValue

型: object

プロパティ

templateFormatLabel

型: string

テンプレート・フォーマットに対して表示されるラベルです。たとえば、"HTML"、"PDF"、"Excel"などがあります。

templateFormatValue

型: string

ラベルに対応するテンプレート・フォーマットの値です。たとえば、"html"、"pdf"、"excel"などがあります。

ネストされたスキーマ: ParamNameValues

型: object

プロパティ

listOfParamNameValues

型: array listOfParamNameValues

ParamNameValueの配列

ネストされたスキーマ: listOfParamNameValues

型: array

ParamNameValueの配列

アイテム

• 型: object ParamNameValue

ネストされたスキーマ: ParamNameValue

型: object

プロパティ

dataType

型: string

有効な値: Boolean Date Float Integer String

dateFormatString

型: string

UITypeがDateの場合は、日付フォーマット文字列を指定します。日付フォーマット文字列にはJava日付フォーマットを使用する必要があります(MM-DD-YYYYなど)。

dateFrom

型: string

UITypeがDateの場合は、日付の開始値を指定します。

dateTo

型: string

UITypeがDateの場合は、日付の終了値を指定します。

defaultValue

型: string

パラメータのデフォルト値を指定します。

fieldSize

型: string

パラメータ・タイプが"Text"または"Date"の場合に、パラメータのテキスト・フィールド・サイズを指定します。

label

型: string

パラメータ・タイプが"Hidden"以外の場合に、パラメータの表示ラベルを指定します。

lovLabels

型: array lovLabels

パラメータ・タイプが"Menu"の場合に、ユーザーに表示される値リストの値を指定します。

multiValuesAllowed

型: boolean

trueは、パラメータに複数の値が含まれている可能性があることを意味します。

name

型: string

パラメータ名。

refreshParamOnChange

型: boolean

パラメータ・タイプが"Text"または"Menu"で、このパラメータの値がtrueの場合は、このパラメータに対する選択が行われたときに他の定義済パラメータがリフレッシュされることを示します。

selectAll

型: boolean

パラメータ・タイプが"Menu"の場合、trueは値リストのすべての値を選択できることを示します。

templateParam

型: boolean

trueは、パラメータがRTFテンプレートで定義されていることを示します。

UIType

型: string

Oracle BI Publisherのデータ・モデル・ユーザー・インタフェースで定義されているパラメータのタイプです。有効な値: Date Hidden Menu Search Text

useNullForAll

型: boolean

パラメータ・タイプが"Menu"の場合、trueはパラメータのすべての値が選択されるとnullが渡されることを示します。

values

型: array values

パラメータ値。

ネストされたスキーマ: lovLabels

型: array

パラメータ・タイプが"Menu"の場合に、ユーザーに表示される値リストの値を指定します。

アイテム

• 型: string

ネストされたスキーマ: values

型: array

パラメータ値。

アイテム

• 型: string