ジャンプ先

• リクエスト
• レスポンス
• 例

レポート定義の取得

get

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

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

リクエスト

パス・パラメータ

• 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となります。

先頭に戻る

レスポンス

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

• application/json

200レスポンス

レポート定義を返します。

本文 ()

ルート・スキーマ: ReportDefinition

型: object

ソースを表示

• autoRun(optional): boolean
  trueは、レポート・プロパティの「オートラン」がオンになっていることを意味します。
• cacheDocument(optional): boolean
  trueは、レポート・プロパティの「ドキュメント・キャッシュの有効化」がオンになっていることを意味します。
• controledByExtApp(optional): boolean
  レポートの定義を外部アプリケーションで制御する(true)かまたはしない(false)かを示します。
• dataModelURL(optional): string
  データ・モデルの定義を取得する.xdmファイルの場所。
• defaultOutputFormat(optional): string
  デフォルトの出力フォーマット。有効な値: csv (CSV) data (データ) eText (eTextテンプレート) excel (Microsoft Excel) excel2000 (Microsoft Excel 2000) フラッシュ(Adobe Flash) html (HTML) mhtml (MIME HTML) pdf (Adobe PDF) ppt (Microsoft PowerPoint) rtf (リッチ・テキスト・フォーマット)
• defaultTemplateId(optional): string
  そのレポートに対して特定されたデフォルトのテンプレート。
• diagnostics(optional): boolean
  trueは、そのレポートに対して診断がオンになっていることを意味します。
• ESSJobName(optional): string
  ESSジョブ名。
• listOfTemplateFormatsLabelValues(optional): array listOfTemplateFormatsLabelValues
• onLine(optional): boolean
  trueは、レポート・プロパティの「レポート・オンラインの実行」がオンになっていることを意味します。
• openLinkInNewWindow(optional): boolean
  trueは、レポート・プロパティの「新規ウィンドウでリンクを開く」がオンになっていることを意味します。
• parameterColumns(optional): integer
  レポート・プロパティの「行当たりのパラメータ数」の値。
• reportDefnTitle(optional): string
  非アクティブ。使用しないでください。
• reportDescription(optional): string
  ユーザーがレポートに割当てた説明。
• reportName(optional): string
  ユーザーがレポートに割当てた名前。
• reportParameterNameValues(optional): array reportParameterNameValues
• reportType(optional): string
  非アクティブ。使用しないでください。
• showControls(optional): boolean
  trueは、レポート・プロパティの「コントロールの表示」がオンになっていることを意味します。
• showReportLinks(optional): boolean
  trueは、レポート・プロパティの「レポート・リンクの表示」がオンになっていることを意味します。
• templateIds(optional): array templateIds
  レポート・テンプレートのレイアウト名を渡します。

{
    "type":"object",
    "properties":{
        "ESSJobName":{
            "type":"string",
            "description":"ESS job name."
        },
        "autoRun":{
            "type":"boolean",
            "description":"True indicates that the report property Auto Run is turned on."
        },
        "cacheDocument":{
            "type":"boolean",
            "description":"True indicates that the report property Enable document cache is turned on."
        },
        "controledByExtApp":{
            "type":"boolean",
            "description":"Whether the report definition is controlled by an external application (true) or not (false)."
        },
        "dataModelURL":{
            "type":"string",
            "description":"The .xdm location from where to get the Data Model definition."
        },
        "defaultOutputFormat":{
            "type":"string",
            "description":"The default output format. Valid values include:\ncsv (CSV)\ndata (Data)\neText (eText template)\nexcel (Microsoft Excel)\nexcel2000 (Microsoft Excel 2000)\nflash (Adobe Flash)\nhtml (HTML)\nmhtml (MIME HTML)\npdf (Adobe PDF)\nppt (Microsoft PowerPoint)\nrtf (Rich Text Format)\n"
        },
        "defaultTemplateId":{
            "type":"string",
            "description":"The default template identified for the report."
        },
        "diagnostics":{
            "type":"boolean",
            "description":"True indicates that diagnostics have been turned on for the report."
        },
        "listOfTemplateFormatsLabelValues":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TemplateFormatsLabelValues"
            }
        },
        "onLine":{
            "type":"boolean",
            "description":"True indicates the property \"Run report online\" is turned on for the report."
        },
        "openLinkInNewWindow":{
            "type":"boolean",
            "description":"True indicates the property \"Open Links in New Window\" is turned on for the report."
        },
        "parameterColumns":{
            "type":"integer",
            "description":"The value of the report property \"Parameters per line.\""
        },
        "reportDefnTitle":{
            "type":"string",
            "description":"Inactive. Do not use."
        },
        "reportDescription":{
            "type":"string",
            "description":"The user-assigned description of the report."
        },
        "reportName":{
            "type":"string",
            "description":"The user-assigned name for the report."
        },
        "reportParameterNameValues":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ParamNameValues"
            }
        },
        "reportType":{
            "type":"string",
            "description":"Inactive. Do not use."
        },
        "showControls":{
            "type":"boolean",
            "description":"True indicates the report property \"Show controls\" has been turned on."
        },
        "showReportLinks":{
            "type":"boolean",
            "description":"True indicates the report property \"Show report links\" has been turned on."
        },
        "templateIds":{
            "type":"array",
            "description":"Passes the layout names of the report templates.",
            "items":{
                "type":"string"
            }
        }
    }
}

ネストされたスキーマ: listOfTemplateFormatsLabelValues

型: array

ソースを表示

• 配列: object TemplateFormatsLabelValues

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/TemplateFormatsLabelValues"
    }
}

ネストされたスキーマ: reportParameterNameValues

型: array

ソースを表示

• 配列: object ParamNameValues

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ParamNameValues"
    }
}

ネストされたスキーマ: templateIds

型: array

レポート・テンプレートのレイアウト名を渡します。

ソースを表示

• 配列: string

{
    "type":"array",
    "description":"Passes the layout names of the report templates.",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: TemplateFormatsLabelValues

型: object

ソースを表示

• active(optional): boolean
  テンプレートがアクティブ(true)またはアクティブでない(false)かを示します。
• applyStyleTemplate(optional): boolean
  スタイル・テンプレートを適用する(true)か適用しない(false)かを示します。
• default(optional): boolean
  テンプレートがデフォルト・テンプレート(true)かデフォルト・テンプレートでない(false)かを示します。
• listOfTemplateFormatLabelValue(optional): array listOfTemplateFormatLabelValue
  TemplateFormatLabelValueのラベルと値のペアが格納されます。
• templateAvailableLocales(optional): array templateAvailableLocales
  テンプレートに対して定義されている使用可能なロケール・オプション。
• templateBaseLocale(optional): string
  テンプレートに対して定義されているベース・ロケール・オプション。
• templateDefaultLocale(optional): string
  テンプレートに対して定義されているデフォルト・ロケール・オプション。
• templateID(optional): string
  Oracle BI Publisherでテンプレートに割り当てられている名前です。例: "Employee Listing"。
• templateType(optional): string
  テンプレートのタイプです。例: "rtf"、"pdf"
• templateURL(optional): string
  Oracle BI Publisherリポジトリ内のテンプレート・ファイル名です。例: "Employee Listing.rtf"。
• viewOnline(optional): boolean
  テンプレートがオンラインで表示できる(true)か表示できない(false)かを示します。

{
    "type":"object",
    "properties":{
        "active":{
            "type":"boolean",
            "description":"Whether the template is active (true) or not (false)."
        },
        "applyStyleTemplate":{
            "type":"boolean",
            "description":"Whether to apply the style template (true) or not (false)."
        },
        "default":{
            "type":"boolean",
            "description":"Whether the template is the default template (true) or not (false)."
        },
        "listOfTemplateFormatLabelValue":{
            "type":"array",
            "description":"Contains the TemplateFormatLabelValue label-value pairs .",
            "items":{
                "$ref":"#/definitions/TemplateFormatLabelValue"
            }
        },
        "templateAvailableLocales":{
            "type":"array",
            "description":"The available locale options defined for a template",
            "items":{
                "type":"string"
            }
        },
        "templateBaseLocale":{
            "type":"string",
            "description":"The base locale options defined for a template."
        },
        "templateDefaultLocale":{
            "type":"string",
            "description":"The default locale options defined for a template."
        },
        "templateID":{
            "type":"string",
            "description":"The name assigned to the template in Oracle BI Publisher, for example: \"Employee Listing\".\n"
        },
        "templateType":{
            "type":"string",
            "description":"The type of template, for example: \"rtf\" or \"pdf\"."
        },
        "templateURL":{
            "type":"string",
            "description":"The template file name in the Oracle BI Publisher repository, for example: \"Employee Listing.rtf\"."
        },
        "viewOnline":{
            "type":"boolean",
            "description":"Whether the template can be viewed online (true) or not (false)."
        }
    }
}

ネストされたスキーマ: listOfTemplateFormatLabelValue

型: array

TemplateFormatLabelValueのラベルと値のペアが格納されます。

ソースを表示

• 配列: object TemplateFormatLabelValue

{
    "type":"array",
    "description":"Contains the TemplateFormatLabelValue label-value pairs .",
    "items":{
        "$ref":"#/definitions/TemplateFormatLabelValue"
    }
}

ネストされたスキーマ: templateAvailableLocales

型: array

テンプレートに対して定義されている使用可能なロケール・オプション。

ソースを表示

• 配列: string

{
    "type":"array",
    "description":"The available locale options defined for a template",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: TemplateFormatLabelValue

型: object

ソースを表示

• templateFormatLabel(optional): string
  テンプレート・フォーマットに対して表示されるラベルです。たとえば、"HTML"、"PDF"、"Excel"などがあります。
• templateFormatValue(optional): string
  ラベルに対応するテンプレート・フォーマットの値です。たとえば、"html"、"pdf"、"excel"などがあります。

{
    "type":"object",
    "properties":{
        "templateFormatLabel":{
            "type":"string",
            "description":"The label that displays for a template format. For Example, \"HTML\", \"PDF\", \"Excel\". "
        },
        "templateFormatValue":{
            "type":"string",
            "description":"The template format value that corresponds to the label. Examples include: \"html\" \"pdf\" \"excel\"."
        }
    }
}

ネストされたスキーマ: ParamNameValues

型: object

ソースを表示

• listOfParamNameValues(optional): array listOfParamNameValues
  ParamNameValueの配列

{
    "type":"object",
    "properties":{
        "listOfParamNameValues":{
            "type":"array",
            "description":"An array of ParamNameValue",
            "items":{
                "$ref":"#/definitions/ParamNameValue"
            }
        }
    }
}

ネストされたスキーマ: listOfParamNameValues

型: array

ParamNameValueの配列

ソースを表示

• 配列: object ParamNameValue

{
    "type":"array",
    "description":"An array of ParamNameValue",
    "items":{
        "$ref":"#/definitions/ParamNameValue"
    }
}

ネストされたスキーマ: 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
  パラメータ値。

{
    "type":"object",
    "properties":{
        "UIType":{
            "type":"string",
            "description":"The type of parameter as defined in the Oracle BI Publisher data model user interface.\nValid values include:\nDate\nHidden\nMenu\nSearch\nText\n"
        },
        "dataType":{
            "type":"string",
            "description":"Valid values include:\nBoolean\nDate\nFloat\nInteger\nString\n"
        },
        "dateFormatString":{
            "type":"string",
            "description":"If UIType is \"Date\", this specifies the Date Format String. The date format string must be a Java date format (for example, MM-DD-YYYY)."
        },
        "dateFrom":{
            "type":"string",
            "description":"If UIType is \"Date\", this specifies the begin value of the date."
        },
        "dateTo":{
            "type":"string",
            "description":"If UIType is \"Date\", this specifies the end value of the date."
        },
        "defaultValue":{
            "type":"string",
            "description":"Specifies the default value of the parameter."
        },
        "fieldSize":{
            "type":"string",
            "description":"For parameter types \"Text\" and \"Date\", specifies the text field size for the parameter."
        },
        "label":{
            "type":"string",
            "description":"For all parameter types except \"Hidden\", specifies the display label for the parameter."
        },
        "lovLabels":{
            "type":"array",
            "description":"If the parameter type is \"Menu\", specifies the values displayed in the list of values to the user.",
            "items":{
                "type":"string"
            }
        },
        "multiValuesAllowed":{
            "type":"boolean",
            "description":"True indicates that a parameter may contain multiple values."
        },
        "name":{
            "type":"string",
            "description":"The parameter name."
        },
        "refreshParamOnChange":{
            "type":"boolean",
            "description":"For parameter types \"Text\" and \"Menu\", a value of true for this parameter indicates that other defined parameters should be refreshed when a selection is made for this parameter.\n"
        },
        "selectAll":{
            "type":"boolean",
            "description":"For parameter type \"Menu\", a value of true indicates that all values can be selected for the LOV."
        },
        "templateParam":{
            "type":"boolean",
            "description":"A value of true indicates the parameter is defined in the RTF template."
        },
        "useNullForAll":{
            "type":"boolean",
            "description":"For parameter type \"Menu\", a value of true indicates that a null will be passed if all values are selected for the parameter."
        },
        "values":{
            "type":"array",
            "description":"Parameter values.",
            "items":{
                "type":"string"
            }
        }
    }
}

ネストされたスキーマ: lovLabels

型: array

パラメータ・タイプが"Menu"の場合に、ユーザーに表示される値リストの値を指定します。

ソースを表示

• 配列: string

{
    "type":"array",
    "description":"If the parameter type is \"Menu\", specifies the values displayed in the list of values to the user.",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: values

型: array

パラメータ値。

ソースを表示

• 配列: string

{
    "type":"array",
    "description":"Parameter values.",
    "items":{
        "type":"string"
    }
}

先頭に戻る

例

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

curl -u username:password -H "Accept:application/json" -X GET https://host.com:port/xmlpserver/services/rest/v1/reports/Sample%20Lite%252FPublished%20Reporting%252FReports%252FBalance%20Letter

先頭に戻る