Data Dictionary Home

TradeWaltzShippingInstructionHistories : /API/v2/Reports/TradeWaltzShippingInstructionHistories

Venndor name

0000000000000_CyberPort（港湾物流分野）

System name

CyberPort

TradeWaltz輸出船積依頼データ照会

Infomation
Category
Field
Governments
Data / Business logic	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

API		Description
POST	/API/v2/Reports/TradeWaltzShippingInstructionHistories/Create	TradeWaltz輸出船積依頼データ照会を作成します。 TradeWaltz輸出船積依頼データ照会を作成するには、利用者がTradeWaltz輸出船積依頼データ照会を作成できる事業種別が割り当てられた組織に所属している必要があり、かつ、作成しようとする取引についても、権限が割り当てられている必要があります。 TradeWaltz輸出船積依頼データ照会に関する詳細については、[TradeWaltz輸出船積依頼データ照会について]()を参照ください。
DELETE	/API/v2/Reports/TradeWaltzShippingInstructionHistories/Delete/{reportId}	TradeWaltz輸出船積依頼データ照会を削除します。帳票ID（*reportId）を指定して、TradeWaltz輸出船積依頼データ照会を削除します。 TradeWaltz輸出船積依頼データ照会を削除しても、ルートドキュメントの内容までは削除されません。申請種別を使用して、作成したTradeWaltz輸出船積依頼データ照会のキャンセルを伝える場合は、キャンセル（Cancel）を実施後、帳票の提出（Submit*）を実施してください。 TradeWaltz輸出船積依頼データ照会に関する詳細については、[TradeWaltz輸出船積依頼データ照会について]()を参照ください。
DELETE	/API/v2/Reports/TradeWaltzShippingInstructionHistories/DeleteFile/{fileId}	TradeWaltz輸出船積依頼データ照会の添付ファイルを削除します。ファイルID（*fileId*）を指定して、TradeWaltz輸出船積依頼データ照会の添付ファイルを削除します。帳票の添付ファイルを削除できるのは、そのファイルを添付したパートナーに所属している利用者だけです。帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。
GET	/API/v2/Reports/TradeWaltzShippingInstructionHistories/Get/{reportId}?historyId=!{historyId}	TradeWaltz輸出船積依頼データ照会を取得します。帳票ID（*reportId*）を指定して、TradeWaltz輸出船積依頼データ照会を取得します。編集が行われていない場合は、ルートドキュメントから最新のTradeWaltz輸出船積依頼データ照会を取得します。編集中の場合は、先に保存した、TradeWaltz輸出船積依頼データ照会を取得します。 TradeWaltz輸出船積依頼データ照会に関する詳細については、[TradeWaltz輸出船積依頼データ照会について]()を参照ください。
GET	/API/v2/Reports/TradeWaltzShippingInstructionHistories/GetDiff/{reportId}?historyId=!{historyId}	保存されているTradeWaltz輸出船積依頼データ照会とルートドキュメントの差分を取得します。帳票ID（*reportId）に該当するTradeWaltz輸出船積依頼データ照会と、ルートドキュメントの差分を取得します。比較元を保存されているTradeWaltz輸出船積依頼データ照会、比較先をルートドキュメントとして、差分の取得を行います。差分は、帳票の差分モデル（CompareResult*）として返却します。帳票の差分に関する詳細については、[帳票の差分について]()を参照ください。
GET	/API/v2/Reports/TradeWaltzShippingInstructionHistories/GetFile/{fileId}	TradeWaltz輸出船積依頼データ照会に添付されたファイルを取得します。ファイルID（*fileId）を指定して、TradeWaltz輸出船積依頼データ照会に添付されたファイルを取得します。帳票の添付ファイルを獲得できるパートナーは、帳票にアクセス可能なパートナー（/API/v2/Reports/AccessiblePartners*）にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。
GET	/API/v2/Reports/TradeWaltzShippingInstructionHistories/GetList?tradeNo=!{tradeNo}&uniqueNo=!{uniqueNo}&bookingNo=!{bookingNo}&blNo=!{blNo}&invoiceNo=!{invoiceNo}	TradeWaltz輸出船積依頼データ照会を全て取得します。検索条件に該当するTradeWaltz輸出船積依頼データ照会を全て取得します。編集が行われていない場合は、ルートドキュメントから最新のTradeWaltz輸出船積依頼データ照会を取得します。編集中の場合は、先に保存した、TradeWaltz輸出船積依頼データ照会を取得します。 TradeWaltz輸出船積依頼データ照会に関する詳細については、[TradeWaltz輸出船積依頼データ照会について]()を参照ください。
GET	/API/v2/Reports/TradeWaltzShippingInstructionHistories/GetTradeWaltzAttachFile?reportId=!{reportId}&linkageSeq=!{linkageSeq}&documentManageId=!{documentManageId}	TradeWaltzから添付ファイルを取得します。連携SEQ（*linkageSeq）とTradeWaltz帳票管理ID（documentManageId）を指定して、TradeWaltzから添付ファイルを取得します。添付ファイルを獲得できるパートナーは、履歴帳票にアクセス可能なパートナー（/API/v2/Reports/AccessiblePartners）にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。 TradeWaltzから添付ファイルを取得するためには、所属する組織がTradeWaltz連携ユーザー（/API/v2/Organizations/TradeWaltzLinkageUsers）にて、有効な連携ユーザーID（linkageUserId）、連携パスワード（linkagePassword*）が設定されている必要があります。
PATCH	/API/v2/Reports/TradeWaltzShippingInstructionHistories/Lock/{reportId}	編集するため、TradeWaltz輸出船積依頼データ照会をロックします帳票ID（*reportId）を指定して、TradeWaltz輸出船積依頼データ照会をロックします。 TradeWaltz輸出船積依頼データ照会を作成（Create）した時点では、TradeWaltz輸出船積依頼データ照会をロックが掛かりますが、取得（Get）したあとで、TradeWaltz輸出船積依頼データ照会を編集する場合は、このメソッドを呼び出して、TradeWaltz輸出船積依頼データ照会をロックします。ロックされたTradeWaltz輸出船積依頼データ照会は、ロックを行った組織に所属している利用者しか編集できません。他の組織に所属している利用者は、TradeWaltz輸出船積依頼データ照会をルートドキュメントから参照できますが、編集中（ロック中）の船腹予約確認書は参照できません。このロックは、アンロック（Unlock）を呼び出すか、帳票の保存後、帳票の提出（Submit**）を行うと解除されます。 TradeWaltz輸出船積依頼データ照会に関する詳細については、[TradeWaltz輸出船積依頼データ照会について]()を参照ください。
PATCH	/API/v2/Reports/TradeWaltzShippingInstructionHistories/SetCancel/{reportId}	TradeWaltz輸出船積依頼データ照会の申請種別をキャンセルします帳票ID（*reportId）を指定して、TradeWaltz輸出船積依頼データ照会の申請種別（applyType）を、キャンセル（CANCEL）にします。申請種別（applyType）が、訂正（AMEND）の場合に、この操作は有効になります。このメソッドで、申請種別（applyType）を、キャンセル（CANCEL）にし、帳票の提出（Submit*）することで、申請種別が確定します。 TradeWaltz輸出船積依頼データ照会に関する詳細については、[TradeWaltz輸出船積依頼データ照会について]()を参照ください。
PATCH	/API/v2/Reports/TradeWaltzShippingInstructionHistories/Submit/{reportId}	TradeWaltz輸出船積依頼データ照会を提出します帳票ID（*reportId）を指定して、更新（Update）したTradeWaltz輸出船積依頼データ照会を提出します。このメソッドでは、変更内容をルートドキュメントへ反映し、TradeWaltz輸出船積依頼データ照会が参照できる取引内のパートナーに、変更内容を公開することになります。帳票の更新（Update*）しても、このメソッドが呼び出されるまでは、変更内容は取引内のパートナーに共有されず、TradeWaltz輸出船積依頼データ照会もロックされた状態のままなので、ご注意ください。 TradeWaltz輸出船積依頼データ照会に関する詳細については、[TradeWaltz輸出船積依頼データ照会について]()を参照ください。
POST	/API/v2/Reports/TradeWaltzShippingInstructionHistories/SubmitByPost	TradeWaltz輸出船積依頼データ照会を提出します動作は、TradeWaltz輸出船積依頼データ照会の提出（*/API/v2/Reports/TradeWaltzShippingInstructionHistories/Submit*）と同様です。 TradeWaltz輸出船積依頼データ照会に関する詳細については、[TradeWaltz輸出船積依頼データ照会について]()を参照ください。
PATCH	/API/v2/Reports/TradeWaltzShippingInstructionHistories/Unlock/{reportId}	TradeWaltz輸出船積依頼データ照会のロックを解除します帳票ID（*reportId）を指定して、TradeWaltz輸出船積依頼データ照会のロックを解除します。更新内容のルートドキュメントへの反映は、帳票の提出（Submit*）で行うので、このメソッドを呼び出すと、編集内容は破棄されます。 TradeWaltz輸出船積依頼データ照会に関する詳細については、[TradeWaltz輸出船積依頼データ照会について]()を参照ください。
PATCH	/API/v2/Reports/TradeWaltzShippingInstructionHistories/Update/{reportId}	TradeWaltz輸出船積依頼データ照会を更新します。帳票ID（*reportId）を指定して、TradeWaltz輸出船積依頼データ照会を更新します。このメソッドでは、TradeWaltz輸出船積依頼データ照会の更新内容を保存しますが、ルートドキュメントへの反映は実施しません。ルートドキュメントへの反映は、帳票の提出メソッド（Submit*）を使用します。 TradeWaltz輸出船積依頼データ照会に関する詳細については、[TradeWaltz輸出船積依頼データ照会について]()を参照ください。
POST	/API/v2/Reports/TradeWaltzShippingInstructionHistories/UpdateByPost	TradeWaltz輸出船積依頼データ照会を更新します。動作は、TradeWaltz輸出船積依頼データ照会の更新（*/API/v2/Reports/TradeWaltzShippingInstructionHistories/Update*）と同様です。 TradeWaltz輸出船積依頼データ照会に関する詳細については、[TradeWaltz輸出船積依頼データ照会について]()を参照ください。
POST	/API/v2/Reports/TradeWaltzShippingInstructionHistories/UploadFile	TradeWaltz輸出船積依頼データ照会にファイルを添付します。指定されたTradeWaltz輸出船積依頼データ照会に、ファイルを添付します。帳票にファイルを添付できるパートナーは、帳票にアクセス可能なパートナー（*/API/v2/Reports/AccessiblePartners*）にて、その帳票にアクセス権限を持つパートナーとして登録されている組織に所属している利用者です。帳票の添付ファイルに関する詳細については、[帳票の添付ファイルについて]()を参照ください。