エクスポート¶

指定した条件で検索したレポートの検索結果をCSVファイルで取得します。

HTTPリクエスト
リクエストボディ
レスポンスデータ

HTTPリクエスト ¶

POST /kaiden/v2/api/generic/report/export

リクエストボディ ¶

リクエストボディ情報の説明です。

プロパティ名論理名型設定デフォルト値説明

reportId レポートID string 必須なし ReportBuilderのレポートIDを指定します。

queryId クエリーID string 任意なし

各レポートに保存されるクエリーIDを指定します。

指定した場合、「json」の値は無視します。

json JSON object 任意なしレポートの検索条件およびCSVファイルの出力設定をJSON形式で指定します。

json/exportSetting エクスポート設定 object 任意なし

json/exportSetting/headerRow ヘッダー行出力有無 string 任意 true

true：ヘッダー行を出力する

false：ヘッダー行を出力しない

json/exportSetting/character 文字コード string 任意 UTF-8 「UTF-8」、「SHIFT-JIS」が指定可能です。

json/exportSetting/delimiter 区切り文字 string 任意カンマ（,）カンマ（,）、タブ（\t）が指定可能です。

json/exportSetting/enclosing 囲み文字 string 任意ダブルクォーテーション（”） CSVファイルの囲み文字を指定します。

json/selectionList 表示項目設定 array<string> 任意 ReportBuilderの一覧設定 ReportBuilderの一覧設定の項目名（reportBuilderSettings / List / item @ name）が指定可能です。

json/searchOptions 検索条件設定 object 任意なし

「”項目名”:”検索条件”,”項目名”:”検索条件”…」の形式で指定します。

項目名には、ReportBuilderの一覧設定の項目名（reportBuilderSettings / List / item @ name）が指定可能です。

json/sortKey ソート項目設定 array<object> 任意 ReportBuilderの一覧設定に指定したソート順

「{“項目名”:”ソート方法”},{“項目名”:”ソート方法”}…」の形式で指定します。

項目名には、ReportBuilderの一覧設定の項目名（reportBuilderSettings / List / item @ name）が指定可能です。

ソート方法には、「asc」、「desc」が指定可能です。

リクエストボディのjsonの設定例
{
    "exportSetting":{
        "headerRow":"true",
        "character":"UTF-8",
        "delimiter":",",
        "enclosing":"\""
    },
    "selectionList":[
        "companyCd",
        "id",
        "name"
    ],
    "searchOptions":{
        "companyCd":"xxx",
        "id":"XXX"
    },
    "sortKey":[
        {"companyCd":"asc"},
        {"id":"desc"}
    ]
}

レスポンスデータ ¶

レスポンスデータはCSVファイルを返却します。

処理結果がエラー終了の場合、JSON情報を返却します。

レスポンスデータ例（エラー終了）
{
    "statusCode":"500",
    "error":"true",
    "errorMessage":"XXX"
}
解説

プロパティ名論理名型説明

statusCode 処理ステータス string

401：エラー終了（認可によりアクセスが拒否）

500：エラー終了（認可以外のエラーが発生）

error 処理結果 boolean

true：エラー終了

errorMessage エラーメッセージ string

目次

エクスポート¶

HTTPリクエスト ¶

リクエストボディ ¶

レスポンスデータ ¶

目次

プロパティ名	論理名	型	設定	デフォルト値	説明
reportId	レポートID	string	必須	なし	ReportBuilderのレポートIDを指定します。
queryId	クエリーID	string	任意	なし	各レポートに保存されるクエリーIDを指定します。指定した場合、「json」の値は無視します。
json	JSON	object	任意	なし	レポートの検索条件およびCSVファイルの出力設定をJSON形式で指定します。
json/exportSetting	エクスポート設定	object	任意	なし
json/exportSetting/headerRow	ヘッダー行出力有無	string	任意	true	true：ヘッダー行を出力する false：ヘッダー行を出力しない
json/exportSetting/character	文字コード	string	任意	UTF-8	「UTF-8」、「SHIFT-JIS」が指定可能です。
json/exportSetting/delimiter	区切り文字	string	任意	カンマ（,）	カンマ（,）、タブ（\t）が指定可能です。
json/exportSetting/enclosing	囲み文字	string	任意	ダブルクォーテーション（”）	CSVファイルの囲み文字を指定します。
json/selectionList	表示項目設定	array<string>	任意	ReportBuilderの一覧設定	ReportBuilderの一覧設定の項目名（reportBuilderSettings / List / item @ name）が指定可能です。
json/searchOptions	検索条件設定	object	任意	なし	「”項目名”:”検索条件”,”項目名”:”検索条件”…」の形式で指定します。項目名には、ReportBuilderの一覧設定の項目名（reportBuilderSettings / List / item @ name）が指定可能です。
json/sortKey	ソート項目設定	array<object>	任意	ReportBuilderの一覧設定に指定したソート順	「{“項目名”:”ソート方法”},{“項目名”:”ソート方法”}…」の形式で指定します。項目名には、ReportBuilderの一覧設定の項目名（reportBuilderSettings / List / item @ name）が指定可能です。ソート方法には、「asc」、「desc」が指定可能です。

プロパティ名	論理名	型	説明
statusCode	処理ステータス	string	401：エラー終了（認可によりアクセスが拒否） 500：エラー終了（認可以外のエラーが発生）
error	処理結果	boolean	true：エラー終了
errorMessage	エラーメッセージ	string

目次

エクスポート¶

HTTPリクエスト¶

リクエストボディ¶

レスポンスデータ¶

目次

HTTPリクエスト ¶

リクエストボディ ¶

レスポンスデータ ¶