REST API for Oracle BI Publisher

レポート・テンプレート・パラメータの取得

get

/services/rest/v1/reports/{reportPath}/templates/{templateId}/parameters

Oracle BI Publisherカタログ内のレポート定義からテンプレートを取得します。

リクエスト

パス・パラメータ

reportPath: 型: string

必須: true

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

必須: true

テンプレートのID(例:Chart Layout)。

レスポンス

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

application/json

200レスポンス

レポート・テンプレート・パラメータを返します。

本文

ルート・スキーマ: /paths/~1v1~1reports~1{reportPath}~1templates~1{templateId}~1parameters/get/responses/200/schema

型: array

アイテム

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