ExportSynchronous 操作

この操作はエクスポートが完了するのを待ち、エクスポートされたレポートブックを返します。この操作は小規模のレポートブックをエクスポートする際に使用します。大規模エクスポートではタイムアウトが発生する場合があります。

要求

メソッド URL
GET /BI/api/rest/IonApi/BookExport/v1/ExportSynchronous
パラメーター ステータス タイプ 値
appName 必須 String エクスポート対象のレポートブックを含むアプリケーションの一意の名前。
bookName 必須 String エクスポートするレポートブックの一意の名前。
outputFormat 必須 Enum

pdf [0]

xlsx [1]

xlsx value [2]

pptx [3]

image [4]

エクスポート出力形式。
usePageLayout オプション Boolean デフォルトは TRUE です。pptx または画像のエクスポートにのみ使用します。
imageFormat オプション Enum

png [0]

jpg [1]

デフォルトは png です。画像のエクスポートにのみ使用します。
string exportProfile オプション String エクスポートプロファイル名。デフォルトでエクスポートする場合は空のままにします。

結果

選択された形式のエクスポート済みレポートブックを表すバイナリデータが返されます。

エクスポートが失敗した場合、エラーメッセージを含む JSON 文字列が返されます。