1. Oracle Analytics ServerのOracle Analytics PublisherのREST API
  2. タスク
  3. レポートの管理

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

post

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

レポート・パラメータとそれらのデフォルト値の配列を取得します。パラメータのリストを使用して、レポートの実行やスケジュールを行う前にパラメータ値を設定できます。

リクエスト

パス・パラメータ
  • 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となります。
本文 ()
レポート・リクエスト
ルート・スキーマ: ReportRequest
型: object
ソースを表示
ネストされたスキーマ: BIPDataSource
型: object
ソースを表示
ネストされたスキーマ: ParamNameValues
型: object
ソースを表示
ネストされたスキーマ: MetaDataList
型: object
ソースを表示
ネストされたスキーマ: FileDataSource
型: object
ソースを表示
  • 特定のサーバー上に存在するデータソースへのパスを指定するには、データソースへのフルパスを指定し、temporaryDataSourceをfalseに設定します。たとえば、"D:\BI\OracleBI\xmlp\XMLP\DemoFiles\Balance.xml")"となります。ファイルがシステムの一時ディレクトリにある場合は、temporaryDataSourceをtrueに設定して、ファイル名をここで指定します。たとえば、"Balance.xml"となります。
  • デフォルト値: false
    ファイル・データソースがシステム一時ディレクトリにある場合はtrueに設定します。dynamicDataSourcePathでフルパスを指定する場合はfalseに設定します。
ネストされたスキーマ: JDBCDataSource
型: object
ソースを表示
ネストされたスキーマ: listOfParamNameValues
型: array
ParamNameValueの配列
ソースを表示
ネストされたスキーマ: ParamNameValue
型: object
ソースを表示
ネストされたスキーマ: lovLabels
型: array
パラメータ・タイプが"Menu"の場合に、ユーザーに表示される値リストの値を指定します。
ソースを表示
ネストされたスキーマ: values
型: array
パラメータ値。
ソースを表示
先頭に戻る

レスポンス

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

200レスポンス

レポート・パラメータを返します。
本文 ()
ルート・スキーマ: ParamNameValues
型: object
ソースを表示
ネストされたスキーマ: listOfParamNameValues
型: array
ParamNameValueの配列
ソースを表示
ネストされたスキーマ: ParamNameValue
型: object
ソースを表示
ネストされたスキーマ: lovLabels
型: array
パラメータ・タイプが"Menu"の場合に、ユーザーに表示される値リストの値を指定します。
ソースを表示
ネストされたスキーマ: values
型: array
パラメータ値。
ソースを表示
先頭に戻る

例

次の例は、cURLを使用してRESTリソースにPOSTリクエストを発行して、レポートのパラメータおよびパラメータのデフォルト値を取得する方法を示しています。

curl -u admin:welcome1 -X POST -v -H "Content-Type: application/json" -d '{}' https://host.com:9502/xmlpserver/services/rest/v1/reports/Sample%20Lite%252FPublished%20Reporting%252FReports%252FSales%20Performance+Report/parameters -v -i

レスポンス・ヘッダーの例

次にレスポンス・ヘッダーの例を示します。

*   Trying IP Address...
* Connected to host.com (IP Address) port 9502 (#0)
* Server auth using Basic with user 'admin'
> POST /xmlpserver/services/rest/v1/reports/Sample%20Lite%252FPublished%20Reporting%252FReports%252FSales%20Performance+Report/parameters HTTP/1.1
> Host: host.com:9502
> Authorization: Basic YWRtaW46d2VsY29tZTE=
> User-Agent: curl/7.86.0
> Accept: */*
> Content-Type: application/json
> Content-Length: 2
> 
* Mark bundle as not supporting multiuse
< HTTP/1.1 200 OK
HTTP/1.1 200 OK
< Cache-Control: no-store
Cache-Control: no-store
< Date: Tue, 09 May 2023 08:15:00 GMT
Date: Tue, 09 May 2023 08:15:00 GMT
< Pragma: no-cache
Pragma: no-cache
< Content-Length: 1107
Content-Length: 1107
< Content-Type: application/json
Content-Type: application/json
< Content-Security-Policy: default-src 'self' ; script-src 'self' 'unsafe-inline' 'unsafe-eval' ; style-src 'self' 'unsafe-inline' ; img-src 'self' data:; media-src 'none'; frame-ancestors 'self'
Content-Security-Policy: default-src 'self' ; script-src 'self' 'unsafe-inline' 'unsafe-eval' ; style-src 'self' 'unsafe-inline' ; img-src 'self' data:; media-src 'none'; frame-ancestors 'self'
< X-ORACLE-DMS-RID: 0
X-ORACLE-DMS-RID: 0
< X-ORACLE-DMS-ECID: d7b33589-3787-4136-b64e-32d5a38ad04e-001b6613
X-ORACLE-DMS-ECID: d7b33589-3787-4136-b64e-32d5a38ad04e-001b6613
< X-FRAME-OPTIONS: SAMEORIGIN
X-FRAME-OPTIONS: SAMEORIGIN

レスポンス本文の例

JSON形式のレスポンス本文のコンテンツの例を次に示します。

* Connection #0 to host host.com left intact
{"listOfParamNameValues":{"item":[{"UIType":"Menu","dataType":"xsd:string","defaultValue":"2009","label":"Calendar Year","lovLabels":{"item":["2009.00","2010.00","2008.00"]},"multiValuesAllowed":"false","name":"P_YEAR","refreshParamOnChange":"false","selectAll":"false","templateParam":"false","useNullForAll":"true","values":{"item":["2009.00","2010.00","2008.00"]}},{"UIType":"Menu","dataType":"xsd:string","defaultValue":"Stockplus Inc.","label":"Company Name","lovLabels":{"item":["Stockplus Inc.","Genmind Corp","Tescare Ltd."]},"multiValuesAllowed":"false","name":"P_COMPANY","refreshParamOnChange":"true","selectAll":"false","templateParam":"false","useNullForAll":"false","values":{"item":["Stockplus Inc.","Genmind Corp","Tescare Ltd."]}},{"UIType":"Menu","dataType":"xsd:string","defaultValue":"Inbound Org.","label":"Organization Name","lovLabels":{"item":["Inbound Org.","International Org."]},"multiValuesAllowed":"false","name":"P_ORG","refreshParamOnChange":"false","selectAll":"false","templateParam":"false","useNullForAll":"true","values":{"item":["Inbound Org.","International Org."]}}]}}
先頭に戻る