Processes : /API/v2/Trades/Processes

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
PATCH /API/v2/Trades/Processes/AddReports/{processId}

取引のプロセスに帳票を追加します。 取引内でのプロセスに関する詳細については、[取引内でのプロセスについて]()を参照ください。

DELETE /API/v2/Trades/Processes/Delete/{processId}

取引のプロセスを削除します。 取引内でのプロセスに関する詳細については、[取引内でのプロセスについて]()を参照ください。

GET /API/v2/Trades/Processes/Get/{processId}

取引内のプロセスを取得します。 プロセスID(***processId***)を指定して、取引内のプロセスを取得します。 取引内でのプロセスに関する詳細については、[取引内でのプロセスについて]()を参照ください。

GET /API/v2/Trades/Processes/GetList/{tradeNo}

取引内のプロセスを全て取得します。 取引管理番号(***tradeNo***)を指定して、取引内のプロセスを全て取得します。

GET /API/v2/Trades/Processes/GetList/{tradeNo}?processId=!{processId}&processGroupCode=!{processGroupCode}&processCode=!{processCode}&customizedProcessCode=!{customizedProcessCode}&organizationIdAsPlanner=!{organizationIdAsPlanner}&organizationIdAsSubmitter=!{organizationIdAsSubmitter}&organizationIdAsAccepter=!{organizationIdAsAccepter}&processStatus=!{processStatus}&startAtFrom=!{startAtFrom}&startAtTo=!{startAtTo}&dueAtFrom=!{dueAtFrom}&dueAtTo=!{dueAtTo}

取引内のプロセスを全て取得します。 取引管理番号(***tradeNo***)を指定して、取引内のプロセスを全て取得します。 取引内でのプロセスに関する詳細については、[取引内でのプロセスについて]()を参照ください。

POST /API/v2/Trades/Processes/Plan

取引にプロセスを登録(計画)します。 取引に実施予定のプロセスを登録(計画)します。 登録できるプロセスは、サイバーポート標準プロセス(***/API/v2/Master/StandardProcesses***)か、取引に参加しているパートナーがカスタマイズしたプロセス(***/API/v2/Organizations/CustomizedProcesses***)となります 取引にプロセスを登録(計画)した時点では、そのプロセスで取扱う帳票は、作成されません。 プロセスを開始する際(***/API/v2/Trades/Processes/Start***)に、そのプロセスで取扱う帳票とタスクを作成します。 ただし、作成済みの帳票を使用して、プロセスを開始することも可能です。 取引内でのプロセスに関する詳細については、[取引内でのプロセスについて]()を参照ください。

PATCH /API/v2/Trades/Processes/SetStatus/{processId}

取引のプロセスのステータスを設定します。 取引のプロセスのステータスを設定します。 ステータスを更新すると、紐づくタスクのステータスも連動して更新されます。例えば、プロセスのステータスをDoneにすると、紐づくタスクのステータスもDoneになります。 取引内でのプロセスに関する詳細については、[取引内でのプロセスについて]()を参照ください。

POST /API/v2/Trades/Processes/Start

取引のプロセスを開始します。 取引に登録されている実施予定のプロセスを開始します。 プロセスを開始すると、そのプロセスで取扱う帳票が作成され(作成済みでない場合)、各帳票にタスクが作成されます。 取引内でのプロセスに関する詳細については、[取引内でのプロセスについて]()を参照ください。

POST /API/v2/Trades/Processes/Start/{processId}

No documentation available.

PATCH /API/v2/Trades/Processes/Update/{processId}

取引のプロセスを更新します。 取引内でのプロセスに関する詳細については、[取引内でのプロセスについて]()を参照ください。

PATCH /API/v2/Trades/Processes/UpdateDisplayOrder

No documentation available.

PATCH /API/v2/Trades/Processes/UpdateDisplayOrder/{processId}

取引のプロセスの並び順を設定します。 取引内でのプロセスに関する詳細については、[取引内でのプロセスについて]()を参照ください。