cyber-port sandbox WebAPI

Data Dictionary Home

BulkDownloads : /API/v2/Reports/BulkDownloads

Venndor name

0000000000000_CyberPort（港湾物流分野）

System name

CyberPort

一括ダウンロード

Infomation
Category
Field
Governments
Data / Business logic
Paid / Free Free
Fees
Created by
Maintainer
Date created
Last updated
Update frequency
Necessity of contract Unnecessary
About contract
Version
Terms and Conditions

API List

APIDescription
GET /API/v2/Reports/BulkDownloads/Get/{bulkDownloadId}

帳票の一括ダウンロードの要求を取得します。 一括ダウンロードID（***bulkDownloadId***）を指定して、帳票の一括ダウンロードの要求を取得します。 ステータス（***downloadStatus***）で確認可能です。 帳票の一括ダウンロードに関する詳細については、[帳票の一括ダウンロードについて]()を参照ください。
GET /API/v2/Reports/BulkDownloads/GetAdmin/{bulkDownloadId}

帳票の一括ダウンロードの要求を取得します。 一括ダウンロードID（***bulkDownloadId***）を指定して、帳票の一括ダウンロードの要求を取得します。 ステータス（***downloadStatus***）で確認可能です。 帳票の一括ダウンロードに関する詳細については、[帳票の一括ダウンロードについて]()を参照ください。 このメソッドはシステム管理者しか呼び出せません。 (*For admin)
GET /API/v2/Reports/BulkDownloads/GetFile/{bulkDownloadId}

帳票の一括ダウンロードの結果ファイルを取得します。 一括ダウンロードID（***bulkDownloadId***）を指定して、帳票の一括ダウンロードの結果であるzipファイルを取得します。 zipファイルは、ステータス（***downloadStatus***）がdoneである場合に取得可能です。 帳票の一括ダウンロードに関する詳細については、[帳票の一括ダウンロードについて]()を参照ください。
GET /API/v2/Reports/BulkDownloads/GetList?organizationId=!{organizationId}&tradeType=!{tradeType}&reportCode=!{reportCode}&excelFormatCode=!{excelFormatCode}&from=!{from}&to=!{to}&downloadStatus=!{downloadStatus}

帳票の一括ダウンロードの要求を全て取得します。 検索条件に該当する帳票の一括ダウンロード要求を全て取得します。 帳票の一括ダウンロードに関する詳細については、[帳票の一括ダウンロードについて]()を参照ください。
POST /API/v2/Reports/BulkDownloads/Request

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