ジャンプ先

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

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

post

/services/rest/v1/reports/{reportPath}/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となります。

本文 ()

レポート・リクエスト

ルート・スキーマ: ReportRequest

型: object

ソースを表示

• attributeCalendar: string
  レポート・リクエストに対して使用するフォーマット・カレンダです。有効な値: "Gregorian"、"Arabic Hijrah"、"English Hijrah"、"Japanese Imperial"、"Thai Buddha"、"ROC Official"
• attributeFormat: string
  要求されたレポートの出力フォーマット。
• attributeLocale: string
  レポートのロケール選択例: fr-FR
• attributeTemplate: string
  レポートに適用するテンプレートたとえば、Employeelisting.rtfです。
• attributeTimezone: string
  リクエストに対して使用するタイムゾーンを、サポートされているJavaタイムゾーンIDを使用して指定します。たとえば、"America/Los_Angeles"。
• attributeUILocale: string
  レポートのロケール選択例: fr-FR
• byPassCache: boolean
  デフォルト値: false

  trueは、ドキュメント・キャッシュをバイパスすることを示します。
• dynamicDataSource: object BIPDataSource
• flattenXML: boolean
  デフォルト値: false

  trueは、XMLがフラット化されることを意味します。ExcelではXMLデータ型をフラット化する必要があるため、このフラグはAnalyzer for Microsoft Excelに対して使用されます。
• parameterNameValues: object ParamNameValues
• xdopropertyList: object MetaDataList

{
    "type":"object",
    "properties":{
        "parameterNameValues":{
            "$ref":"#/definitions/ParamNameValues"
        },
        "byPassCache":{
            "type":"boolean",
            "default":false,
            "description":"True indicates to bypass document cache."
        },
        "xdopropertyList":{
            "$ref":"#/definitions/MetaDataList"
        },
        "attributeFormat":{
            "description":"The output format of the requested report.",
            "type":"string"
        },
        "attributeLocale":{
            "description":"The locale selection for the report. Example: fr-FR",
            "type":"string"
        },
        "attributeTemplate":{
            "description":"The template to apply to the report. For example, Employeelisting.rtf.",
            "type":"string"
        },
        "attributeTimezone":{
            "description":"Specifies the time zone to use for the request, using a supported Java time zone ID. For example, \"America/Los_Angeles\".",
            "type":"string"
        },
        "attributeCalendar":{
            "description":"The formatting calendar to use for the report request. Valid values are: \"Gregorian\", \"Arabic Hijrah\", \"English Hijrah\", \"Japanese Imperial\", \"Thai Buddha\", and \"ROC Official\".",
            "type":"string"
        },
        "attributeUILocale":{
            "description":"The locale selection for the report. Example: fr-FR",
            "type":"string"
        },
        "dynamicDataSource":{
            "description":"If the data source for the report is not defined, you can dynamically define it.",
            "$ref":"#/definitions/BIPDataSource"
        },
        "flattenXML":{
            "description":"True indicates that the XML is to be flattened. This flag is used for the Analyzer for Microsoft Excel because Excel requires XML data type to be flattened.",
            "type":"boolean",
            "default":false
        }
    }
}

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

型: object

ソースを表示

• fileDataSource: object FileDataSource
• jdbcdataSource: object JDBCDataSource

{
    "type":"object",
    "properties":{
        "fileDataSource":{
            "$ref":"#/definitions/FileDataSource"
        },
        "jdbcdataSource":{
            "$ref":"#/definitions/JDBCDataSource"
        }
    }
}

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

型: object

ソースを表示

• listOfParamNameValues: array listOfParamNameValues
  ParamNameValueの配列

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

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

型: object

ソースを表示

• metaDataName: string
  メタデータの名前。
• metaDataValue: string
  メタデータのコンテンツ。

{
    "type":"object",
    "properties":{
        "metaDataName":{
            "type":"string",
            "description":"The name of the metadata."
        },
        "metaDataValue":{
            "type":"string",
            "description":"The metadata content."
        }
    }
}

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

型: object

ソースを表示

• dynamicDataSourcePath: string
  特定のサーバー上に存在するデータソースへのパスを指定するには、データソースへのフルパスを指定し、temporaryDataSourceをfalseに設定します。たとえば、"D:\BI\OracleBI\xmlp\XMLP\DemoFiles\Balance.xml")"となります。ファイルがシステムの一時ディレクトリにある場合は、temporaryDataSourceをtrueに設定して、ファイル名をここで指定します。たとえば、"Balance.xml"となります。
• temporaryDataSource: boolean
  デフォルト値: false

  ファイル・データソースがシステム一時ディレクトリにある場合はtrueに設定します。dynamicDataSourcePathでフルパスを指定する場合はfalseに設定します。

{
    "type":"object",
    "properties":{
        "dynamicDataSourcePath":{
            "description":"To specify a path to a data source that resides on an available server, specify the full path to the data source and set temporaryDataSource to \"false\". For example: \"D:\\BI\\OracleBI\\xmlp\\XMLP\\DemoFiles\\Balance.xml\")\"\nIf the file is located in the system temporary directory, set temporaryDataSource to true, and specify the file name here. For example: \"Balance.xml\".\n",
            "type":"string"
        },
        "temporaryDataSource":{
            "description":"Set to \"true\" when the file data source is in the system temporary directory. Set to \"false\" when dynamicDataSourcePath specifies the full path.",
            "type":"boolean",
            "default":false
        }
    }
}

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

型: object

ソースを表示

• dataSourceName: string
  Oracle BI Publisherデータ・ソース定義ページでデータ・ソースに割り当てられたデータ・ソース名です(たとえば、Oracle)。
• jdbcdriverClass: string
  データソースのJDBCドライバ・クラスです(たとえば、oracle.jdbc.OracleDriver)。
• jdbcdriverType: string
  Oracle BI Publisherデータ・ソース定義ページで定義されているドライバのタイプです(たとえば、Oracle10g/11g/12c)。
• jdbcpassword: string
  Oracle BI Publisherデータ・ソース定義ページで定義されている、データ・ソースのパスワードです。
• jdbcurl: string
  データソースの接続文字列です(たとえば、jdbc:oracle:thin:@mydatabase.foobar.com.example:1521: orcl)。
• jdbcuserName: string
  Oracle BI Publisherデータ・ソース定義ページで定義されている、データ・ソースのユーザー名です。
• postProcessFunc: string
  接続が閉じたときに実行するPL/SQLファンクションを入力します(後処理)。
• preProcessFunc: string
  接続が作成されたときに実行するPL/SQLファンクションを入力します(前処理)。
• useProxyAuth: boolean
  デフォルト値: false

  プロキシ認証を有効化します。

{
    "type":"object",
    "properties":{
        "dataSourceName":{
            "description":"The Data Source Name assigned to the data source in the Oracle BI Publisher data source definition page (for example, Oracle).",
            "type":"string"
        },
        "jdbcdriverClass":{
            "description":"The JDBC driver class for the data source (for example, oracle.jdbc.OracleDriver).",
            "type":"string"
        },
        "jdbcdriverType":{
            "description":"The driver type as defined in the Oracle BI Publisher data source definition page (for example, Oracle10g/11g/12c).",
            "type":"string"
        },
        "preProcessFunc":{
            "description":"Enter a PL/SQL function to execute when a connection is created (Pre Process).",
            "type":"string"
        },
        "postProcessFunc":{
            "description":"Enter a PL/SQL function to execute when a connection is closed (Post Process).",
            "type":"string"
        },
        "jdbcurl":{
            "description":"The connection string for the data source (for example, jdbc:oracle:thin:@mydatabase.foobar.com.example:1521: orcl).",
            "type":"string"
        },
        "jdbcuserName":{
            "description":"The user name for the data source as defined in the Oracle BI Publisher data source definition page.",
            "type":"string"
        },
        "jdbcpassword":{
            "description":"The password for the data source as defined in the Oracle BI Publisher data source definition page.",
            "type":"string"
        },
        "useProxyAuth":{
            "description":"Enable Proxy Authentication.",
            "type":"boolean",
            "default":false
        }
    }
}

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

型: array

ParamNameValueの配列

ソースを表示

• 配列: object ParamNameValue

{
    "type":"array",
    "description":"An array of ParamNameValue",
    "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"
    }
}

先頭に戻る

レスポンス

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

• application/json

200レスポンス

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

本文 ()

ルート・スキーマ: ParamNameValues

型: object

ソースを表示

• listOfParamNameValues: 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: 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リソースにPOSTリクエストを発行して、レポートのパラメータおよびパラメータのデフォルト値を取得する方法を示しています。

curl -i \
     --header 'Authorization: Bearer <token>' \
     --header 'Content-Type: application/json' \
     --request POST -d '{}' 'https://hostname/xmlpserver/services/rest/v1/reports/Sample%20Lite%252FPublished%20Reporting%252FReports%252FSales%20Performance+Report/parameters'

レスポンス本文の例

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

* Connection #0 to host hostname 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."]}}]}}

先頭に戻る