ジャンプ先

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

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

get

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

レポート定義からテンプレート・パラメータを取得します

リクエスト

パス・パラメータ

• 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となります。
• templateId(必須): string
  テンプレートのID(たとえば、Chart Layout)。

先頭に戻る

レスポンス

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

• application/json

200レスポンス

レポート・テンプレート・パラメータを返します。

本文 ()

ルート・スキーマ: schema

型: array

ソースを表示

• 配列: object ParamNameValue

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

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

{
    "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 -i \
     --header 'Authorization: Bearer <token>' \
     --header 'Content-Type: application/json' \
     --request GET \
     'https://hostname/xmlpserver/services/rest/v1/reports/Sample%20Lite%252FPublished%20Reporting%252FReports%252FSales%20Performance+Report/templates/ActualVsTargets/parameters'

レスポンス本文の例

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

* Connection #0 to host hostname left intact

先頭に戻る