PATCH /API/v2/Reports/BookingConfirmations/Lock/{reportId}
編集するため、船腹予約確認書をロックします 帳票ID(***reportId***)を指定して、船腹予約確認書をロックします。 船腹予約確認書を作成(***Create***)した時点では、船腹予約確認書をロックが掛かりますが、取得(***Get***)したあとで、船腹予約確認書を編集する場合は、このメソッドを呼び出して、船腹予約確認書をロックします。 ロックされた船腹予約確認書は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、船腹予約確認書をルートドキュメントから参照できますが、編集中(ロック中)の船腹予約確認書は参照できません。 このロックは、アンロック(***Unlock***)を呼び出すか、帳票の保存後、帳票の提出(***Submit****)を行うと解除されます。 船腹予約確認書に関する詳細については、[船腹予約確認書について]()を参照ください。
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
reportId | 帳票ID |
String |
Required Max length: 30 |
Body Parameters
Name | Description | Type | Additional information |
---|---|---|---|
organizationId | 組織ID |
String |
Required Max length: 20 Pattern : ^[A-Za-z0-9_-]+$ |
Response Information
Resource Description
Name | Description | Type | Additional information |
---|---|---|---|
reportId | 帳票ID |
String |
Required Max length: 30 |
tradeOverview |
Required |
||
reportType |
Required |
||
reportNo | 帳票番号 |
Integer |
Required |
applyType | 申請種別 |
String |
Required Max length: 6 |
bookingConfirmation |
Required |
||
isEditing | 編集中か |
Boolean |
Required |
accessiblePartners | 帳票にアクセス可能なパートナー |
Collection of accessiblePartners |
Required |
attachFiles | 添付ファイル(メタ情報) |
Collection, Null of attachFiles |
None. |
created |
Object, Null |
None. |
|
editing |
Object, Null |
None. |
|
updated |
Object, Null |
None. |
|
submitted |
Object, Null |
None. |