POST /API/v1/Deals/SendReport

帳票を送信します。 ## 概要 指定された帳票を取引参加組織に送信します。 帳票の送信は、その帳票が格納された取引に参加している組織のうち、その帳票にRead権限がある組織に対して行われます。 ## 指定するパラメタについて ### 取引管理番号 送信する帳票が格納された取引の取引管理番号(***dealNo***)を指定します。*※ただし、取引管理番号は指定しなくとも構いません。* ### 取引・帳票ID 送信する帳票の取引・帳票ID(***dealReportId***)を指定します。 ### 組織の組織ID・事業種別ID 送信元となる組織の組織ID(***organizationId***)と事業種別ID(***businessTypeId***)をセットで指定します。 ### メッセージ 帳票を送信する際の送信メッセージを指定します。 ### 帳票を担当する組織の組織ID・事業種別ID 取引参加組織の中から、帳票の担当者となる組織を、組織ID(***organizationId***)と事業種別ID(***businessTypeId***)のセットで指定します。 ## 通知を受け取る方法について このAPIで発行された通知を受け取る方法は、メール方式とWebhook方式の2つがあります。 ### メール方式 - 港湾関連データ連携基盤でのデフォルトでの通知受け取り方法です。組織に利用者アカウントを登録することで通知が受けられます。 - 通知について で各アクションで送信対象となる取引参加組織に所属する利用者全てにメールが送信されます。 - この通知を受け取るか否かは、利用者・帳票毎に設定可能です。 ### Webhook方式 - 港湾関連データ連携基盤でのオプションとしての通知受け取り方法です。組織情報にWebhookで使用するURLを設定することで、通知をJSONデータとして受け取ることが可能です。 - 例えば、通知について でのアクションと、貴社システムのアプリケーションをWebhookをトリガーとして自動で連携処理を行いたい場合などは、この方式を利用します。 - 組織に、Webhook通知用のシステムを登録する必要があります。

Request Information

URI Parameters

None.

Body Parameters

SendReportRequest

NameDescriptionTypeAdditional information
dealNo

取引管理番号

String

Required

businessTypeId

事業種別ID

String

Required

organizationId

組織ID

String

Required

dealReportId

取引・帳票ID

String

Required

inChargeOrganizations

担当組織

Collection, Null of inChargeOrganizations

None.

message

メッセージ

String

Required

tasks

タスク

Collection, Null of tasks

None.

Response Information

Resource Description

None.