POST /API/v2/Reports/BulkDownloads/Request

帳票の一括ダウンロードを要求(登録)します。 帳票の一括ダウンロードの要求を登録します。 帳票の一括ダウンロードは、この要求に従い、 - 指定された組織IDでアクセス可能な - 帳票コードで指定された - 対象期間(from-to)内に更新された 帳票を一括でダウンロードするため、zipファイルにパッケージングします。 さらに、Excelフォーマットコード(***excelFormatCode***)を指定することで、帳票をExcelファイル化し、zipファイルにパッケージングします。 zipファイルに含まれるものは、 - 帳票JSON - 帳票の添付ファイル - 帳票のExcelファイル です。 帳票の一括ダウンロードには、時間が掛かるので、処理結果については、要求の取得(***/API/v2/Reports/BulkDownload/Get/{bulkDownloadId}***)を使って、確認します。 帳票の一括ダウンロードに関する詳細については、[帳票の一括ダウンロードについて]()を参照ください。

Request Information

URI Parameters

None.

Body Parameters

v2.ReportBulkDownload_Request

NameDescriptionTypeAdditional information
organizationId

組織ID

String

Required

Max length: 20

Pattern : ^[A-Za-z0-9_-]+$

reportCode

帳票コード

String

Required

Max length: 5

excelFormatCode

Excelフォーマットコード

String, Null

Max length: 33

from

対象期間(From)

String

Required

Max length: 72

Format : date-time

to

対象期間(To)

String

Required

Max length: 72

Format : date-time

Response Information

Resource Description

v2.ReportBulkDownload

NameDescriptionTypeAdditional information
bulkDownloadId

一括ダウンロードID

String

Required

Max length: 36

organization

organization

Required

tradeType

取引タイプ

String

Required

Max length: 8

reportType

reportType

Required

excelFormatCode

Excelフォーマットコード

String, Null

Max length: 33

excelFormatName

Excelフォーマット名

String

Required

Max length: 100

from

対象期間(From)

String

Required

Max length: 72

Format : date-time

to

対象期間(To)

String

Required

Max length: 72

Format : date-time

count

対象件数

Integer, Null

None.

downloadStatus

ステータス

String

Required

Max length: 10

fileName

ファイル名

String, Null

Max length: 100