レポート定義の取得。

get

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

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

リクエスト

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

レスポンス

サポートされているメディア・タイプ
  • application/json
200レスポンス
レポート定義を返します。
本文
ルート・スキーマ: ReportDefinition
型: object
ネストされたスキーマ: listOfTemplateFormatsLabelValues
ネストされたスキーマ: 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
パラメータ値。