レポート・パラメータの取得
post
/services/rest/v1/reports/{reportPath}/parameters
レポート・パラメータとそれらのデフォルト値の配列を取得します。パラメータのリストを使用して、レポートの実行やスケジュールを行う前にパラメータ値を設定できます。
リクエスト
パス・パラメータ
- reportPath
-
型:
string
必須:true
URLエンコードされたレポート・パスたとえば、レポート・パスが"/Sample Lite/Published Reporting/Reports/Balance Letter"の場合、エンコードされたレポート・パスは"%2FSample%20Lite%2FPublished%20Reporting%2FReports%2FBalance%20Letter"となります。
本文のパラメータ
レポート・リクエスト
ルート・スキーマ: ReportRequest
型:
object
- attributeCalendar
-
型:
string
レポート・リクエストに対して使用するフォーマット・カレンダです。有効な値: "Gregorian"、"Arabic Hijrah"、"English Hijrah"、"Japanese Imperial"、"Thai Buddha"、"ROC Official" - attributeFormat
-
型:
string
要求されたレポートの出力フォーマット。 - attributeLocale
-
型:
string
レポートのロケール選択例: fr-FR - attributeTemplate
-
型:
string
レポートに適用するテンプレート例: Employeelisting.rtf。 - attributeTimezone
-
型:
string
リクエストに対して使用するタイムゾーンを、サポートされているJavaタイムゾーンIDを使用して指定します。例: "America/Los_Angeles" - attributeUILocale
-
型:
string
レポートのロケール選択例: fr-FR - byPassCache
-
型:
boolean
デフォルト値:false
trueは、ドキュメント・キャッシュをバイパスすることを示します。 - dynamicDataSource
-
型:
object
BIPDataSource - flattenXML
-
型:
boolean
デフォルト値:false
trueは、XMLがフラット化されることを意味します。ExcelではXMLデータ型をフラット化する必要があるため、このフラグはAnalyzer for Microsoft Excelに対して使用されます。 - parameterNameValues
-
型:
object
ParamNameValues - xdopropertyList
-
型:
object
MetaDataList
ネストされたスキーマ: BIPDataSource
型:
object
- fileDataSource
-
型:
object
FileDataSource - jdbcdataSource
-
型:
object
JDBCDataSource
ネストされたスキーマ: ParamNameValues
型:
object
- listOfParamNameValues
-
型:
array
listOfParamNameValuesParamNameValueの配列
ネストされたスキーマ: MetaDataList
型:
object
- metaDataName
-
型:
string
メタデータの名前。 - metaDataValue
-
型:
string
メタデータのコンテンツ。
ネストされたスキーマ: FileDataSource
型:
object
- dynamicDataSourcePath
-
型:
string
特定のサーバー上に存在するデータソースへのパスを指定するには、データソースへのフルパスを指定し、temporaryDataSourceをfalseに設定します。たとえば、"D:\BI\OracleBI\xmlp\XMLP\DemoFiles\Balance.xml")"となります。ファイルがシステムの一時ディレクトリにある場合は、temporaryDataSourceをtrueに設定して、ファイル名をここで指定します。たとえば、"Balance.xml"となります。 - temporaryDataSource
-
型:
boolean
デフォルト値:false
ファイル・データソースがシステム一時ディレクトリにある場合はtrueに設定します。dynamicDataSourcePathでフルパスを指定する場合はfalseに設定します。
ネストされたスキーマ: JDBCDataSource
型:
object
- dataSourceName
-
型:
string
Oracle BI Publisherデータ・ソース定義ページでデータ・ソースに割り当てられたデータ・ソース名です(例: Oracle)。 - jdbcdriverClass
-
型:
string
データソースのJDBCドライバ・クラスです(例: oracle.jdbc.OracleDriver)。 - jdbcdriverType
-
型:
string
Oracle BI Publisherデータ・ソース定義ページで定義されているドライバのタイプです(例: Oracle10g/11g/12c)。 - jdbcpassword
-
型:
string
Oracle BI Publisherデータ・ソース定義ページで定義されている、データ・ソースのパスワードです。 - jdbcurl
-
型:
string
データソースの接続文字列です(例: jdbc:oracle:thin:@mydatabase.foobar.com.example:1521: orcl)。 - jdbcuserName
-
型:
string
Oracle BI Publisherデータ・ソース定義ページで定義されている、データ・ソースのユーザー名です。 - postProcessFunc
-
型:
string
接続が閉じたときに実行するPL/SQLファンクションを入力します(後処理)。 - preProcessFunc
-
型:
string
接続が作成されたときに実行するPL/SQLファンクションを入力します(前処理)。 - useProxyAuth
-
型:
boolean
デフォルト値:false
プロキシ認証を有効化します。
ネストされたスキーマ: listOfParamNameValues
ネストされたスキーマ: 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
ネストされたスキーマ: values
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
レポート・パラメータを返します。
本文
ルート・スキーマ: ParamNameValues
型:
object
- listOfParamNameValues
-
型:
array
listOfParamNameValuesParamNameValueの配列
ネストされたスキーマ: listOfParamNameValues
ネストされたスキーマ: 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
ネストされたスキーマ: values