POST /API/v2/Trades/Processes/Plan
取引にプロセスを登録（計画）します。 取引に実施予定のプロセスを登録（計画）します。 登録できるプロセスは、サイバーポート標準プロセス（***/API/v2/Master/StandardProcesses***）か、取引に参加しているパートナーがカスタマイズしたプロセス（***/API/v2/Organizations/CustomizedProcesses***）となります 取引にプロセスを登録（計画）した時点では、そのプロセスで取扱う帳票は、作成されません。 プロセスを開始する際（***/API/v2/Trades/Processes/Start***）に、そのプロセスで取扱う帳票とタスクを作成します。 ただし、作成済みの帳票を使用して、プロセスを開始することも可能です。 取引内でのプロセスに関する詳細については、[取引内でのプロセスについて]()を参照ください。
Request Information
URI Parameters
None.
Body Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| tradeNo | 取引管理番号 |
String |
Required Max length: 20 |
| processCode | プロセスコード |
String |
Required Max length: 12 |
| customizedProcessCode | カスタマイズプロセスコード |
String, Null |
Max length: 37 |
| processName | プロセス名 |
String, Null |
Max length: 100 |
| processNameEn | プロセス名_英語表記 |
String, Null |
Max length: 100 |
| organizationIdAsPlanner | プロセスを計画するパートナーの組織ID |
String |
Required Max length: 20 Pattern : ^[A-Za-z0-9_-]+$ |
| startAt | 開始日時 |
String, Null |
Format : date-time |
| dueAt | 期限日時 |
String, Null |
Format : date-time |
| message | メッセージ |
String, Null |
None. |
Response Information
Resource Description
| Name | Description | Type | Additional information |
|---|---|---|---|
| processGroupCode | プロセスグループコード |
String |
Required Max length: 8 |
| processGroupName | プロセスグループ名 |
String |
Required Max length: 30 |
| processGroupNameEn | プロセスグループ名_英語表記 |
String, Null |
Max length: 30 |
| displayOrder | 表示順 |
Integer |
Required |
| processes | プロセス |
Collection, Null of processes |
None. |