レポート・テンプレート・パラメータの取得
get
/services/rest/v1/reports/{reportPath}/templates/{templateId}/parameters
Oracle BI Publisherカタログ内のレポート定義からテンプレートを取得します。
リクエスト
パス・パラメータ
- 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となります。
- templateId: string
テンプレートのID(例:Chart Layout)。
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
レポート・テンプレート・パラメータを返します。
ネストされたスキーマ: 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
パラメータ値。