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

レポート定義の取得

get

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

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

リクエスト

パス・パラメータ
  • 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となります。
先頭に戻る

レスポンス

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

200レスポンス

レポート定義を返します。
本文 ()
ルート・スキーマ: ReportDefinition
型: object
ソースを表示
ネストされたスキーマ: listOfTemplateFormatsLabelValues
型: array
ソースを表示
ネストされたスキーマ: reportParameterNameValues
型: array
ソースを表示
ネストされたスキーマ: templateIds
型: array
レポート・テンプレートのレイアウト名を渡します。
ソースを表示
ネストされたスキーマ: TemplateFormatsLabelValues
型: object
ソースを表示
ネストされたスキーマ: listOfTemplateFormatLabelValue
型: array
TemplateFormatLabelValueのラベルと値のペアが格納されます。
ソースを表示
ネストされたスキーマ: templateAvailableLocales
型: array
テンプレートに対して定義されている使用可能なロケール・オプション。
ソースを表示
ネストされたスキーマ: TemplateFormatLabelValue
型: object
ソースを表示
ネストされたスキーマ: ParamNameValues
型: object
ソースを表示
ネストされたスキーマ: listOfParamNameValues
型: array
ParamNameValueの配列
ソースを表示
ネストされたスキーマ: ParamNameValue
型: object
ソースを表示
ネストされたスキーマ: lovLabels
型: array
パラメータ・タイプが"Menu"の場合に、ユーザーに表示される値リストの値を指定します。
ソースを表示
ネストされたスキーマ: values
型: array
パラメータ値。
ソースを表示
先頭に戻る

例

次の例は、cURLを使用してRESTリソースにGETリクエストを発行して、レポートに関する情報を取得する方法を示しています。

curl -u admin:welcome1 -H "Accept:application/json" -X GET https://host.com:9502/xmlpserver/services/rest/v1/reports/Sample%20Lite%252FPublished%20Reporting%252FReports%252FBalance%20Letter -v -i

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

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

*   Trying IP Address...
* Connected to host.com (IP Address) port 9502 (#0)
* Server auth using Basic with user 'admin'
> GET /xmlpserver/services/rest/v1/reports/Sample%20Lite%252FPublished%20Reporting%252FReports%252FBalance%20Letter HTTP/1.1
> Host: host.com:9502
> Authorization: Basic YWRtaW46d2VsY29tZTE=
> User-Agent: curl/7.86.0
> Accept:application/json
> 
* 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:09:23 GMT
Date: Tue, 09 May 2023 08:09:23 GMT
< Pragma: no-cache
Pragma: no-cache
< Content-Length: 2805
Content-Length: 2805
< 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-001b6572
X-ORACLE-DMS-ECID: d7b33589-3787-4136-b64e-32d5a38ad04e-001b6572
< X-FRAME-OPTIONS: SAMEORIGIN
X-FRAME-OPTIONS: SAMEORIGIN

レスポンス本文の例

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

* Connection #0 to host host.com left intact
{"ESSPackageName":"","ESSJobName":"","autoRun":"true","cacheDocument":"false","controledByExtApp":"false","dataModelURL":"/Sample Lite/Published Reporting/Data Models/Balance Letter Datamodel.xdm","defaultOutputFormat":"pdf","defaultTemplateId":"Publisher Template","diagnostics":"false","listOfTemplateFormatsLabelValues":{"item":[{"active":"true","applyStyleTemplate":"false","default":"true","listOfTemplateFormatLabelValue":{"item":[{"templateFormatLabel":"Interactive","templateFormatValue":"analyze"},{"templateFormatLabel":"HTML","templateFormatValue":"html"},{"templateFormatLabel":"PDF","templateFormatValue":"pdf"},{"templateFormatLabel":"Excel (*.xlsx)","templateFormatValue":"xlsx"},{"templateFormatLabel":"PowerPoint (*.pptx)","templateFormatValue":"pptx"},{"templateFormatLabel":"CSV","templateFormatValue":"csv"}]},"templateAvailableLocales":{"item":["en_US"]},"templateBaseLocale":null,"templateDefaultLocale":"en_US","templateID":"Publisher Template","templateType":"xpt","templateURL":"Untitled.xpt","viewOnline":"true"},{"active":"true","applyStyleTemplate":"false","default":"false","listOfTemplateFormatLabelValue":{"item":[{"templateFormatLabel":"HTML","templateFormatValue":"html"},{"templateFormatLabel":"PDF","templateFormatValue":"pdf"},{"templateFormatLabel":"RTF","templateFormatValue":"rtf"},{"templateFormatLabel":"Excel (*.xlsx)","templateFormatValue":"xlsx"},{"templateFormatLabel":"PowerPoint (*.pptx)","templateFormatValue":"pptx"},{"templateFormatLabel":"CSV","templateFormatValue":"csv"}]},"templateAvailableLocales":{"item":["en_US"]},"templateBaseLocale":null,"templateDefaultLocale":"en_US","templateID":"RTF Template","templateType":"rtf","templateURL":"Balance Letter.rtf","viewOnline":"true"},{"active":"true","applyStyleTemplate":"true","default":"false","listOfTemplateFormatLabelValue":{"item":[{"templateFormatLabel":"HTML","templateFormatValue":"html"},{"templateFormatLabel":"PDF","templateFormatValue":"pdf"},{"templateFormatLabel":"RTF","templateFormatValue":"rtf"},{"templateFormatLabel":"Excel (*.xlsx)","templateFormatValue":"xlsx"},{"templateFormatLabel":"PowerPoint (*.pptx)","templateFormatValue":"pptx"},{"templateFormatLabel":"CSV","templateFormatValue":"csv"}]},"templateAvailableLocales":{"item":["en_US"]},"templateBaseLocale":null,"templateDefaultLocale":"en_US","templateID":"RTF Corp Styles","templateType":"rtf","templateURL":"Balance Letter2.rtf","viewOnline":"true"}]},"onLine":"true","openLinkInNewWindow":"true","parameterColumns":3,"reportDefnTitle":"","reportDescription":"Data Model: Balance Letter Data Model --Layouts: RTF, XPT -- Features: Style Template","reportName":"Balance Letter","reportType":null,"showControls":"true","showReportLinks":"true","templateIds":{"item":["Publisher Template","RTF Template","RTF Corp Styles"]}}
先頭に戻る