cyber-port sandbox WebAPI

Data Dictionary Home

PermissionInTrades : /API/v2/Trades/Partners/PermissionInTrades

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
DELETE /API/v2/Trades/Partners/PermissionInTrades/Delete/{permissionInTradeId}

取引内での帳票アクセス権限を削除します。 取引内での帳票アクセス権限ID（***permissionInTradeId***）を指定して、取引内での帳票アクセス権限を削除します。 取引内で変更した帳票アクセス権限がクリアされ、帳票アクセス権限（***/API/v2/Master/Reports/Permissions***）での帳票のRead/Write権限が適用されます。 取引内での帳票アクセス権限に関する詳細については、[取引内での帳票アクセス権限について]()を参照ください。
GET /API/v2/Trades/Partners/PermissionInTrades/Get/{permissionInTradeId}

取引内での帳票アクセス権限を取得します。 取引内での帳票アクセス権限ID（***permissionInTradeId***）を指定して、取引内での帳票アクセス権限を取得します。 取引内での帳票アクセス権限に関する詳細については、[取引内での帳票アクセス権限について]()を参照ください。
GET /API/v2/Trades/Partners/PermissionInTrades/GetList/{tradeNo}?partnerId=!{partnerId}&organizationId=!{organizationId}&permissionInTradeId=!{permissionInTradeId}&reportCode=!{reportCode}&reportId=!{reportId}&permissionInTrade=!{permissionInTrade}

取引内の帳票アクセス権限を取得します。 検索条件を指定して、取引のパートナーに与えられている取引内の帳票アクセス権限を全て取得します。 取引内での帳票アクセス権限に関する詳細については、[取引内での帳票アクセス権限について]()を参照ください。
POST /API/v2/Trades/Partners/PermissionInTrades/Register

取引内での帳票アクセス制限を登録します。 取引のパートナーに対して、取引内での帳票アクセス制限を登録します。 取引のパートナーを追加（***/API/v2/Trades/Partners/Register***）した時点では、追加した組織の事業種別に従い、帳票アクセス権限（***/API/v2/Master/Reports/PermissionInTrades***）での帳票のRead/Write権限が適用されていますが、これを変更する場合に、このメソッドを使用します。 ただし、帳票アクセス権限（***/API/v2/Master/Reports/Permissions***）での設定以上に権限を変更することは出来ません。例えば、帳票アクセス権限（***/API/v2/Master/Reports/Permissions***）での設定で、ある帳票にRead権限までが設定されている場合、これをWrite権限に変更することは出来ません。 この変更は、変更を行った取引に対してのみ有効です。また、取引を複製した場合も（***/API/v2/Trades/Duplicate***）、この設定は引き継がれます。 取引内での帳票アクセス権限に関する詳細については、[取引内での帳票アクセス権限について]()を参照ください。
PATCH /API/v2/Trades/Partners/PermissionInTrades/Update/{permissionInTradeId}

取引内での帳票アクセス権限を更新します。 取引内での帳票アクセス権限ID（***permissionInTradeId***）を指定して、取引内での帳票アクセス権限を更新します。 ただし、帳票アクセス権限（***/API/v2/Master/Reports/Permissions***）での設定以上に権限を変更することは出来ません。 例えば、帳票アクセス権限（***/API/v2/Master/Reports/Permissions***）での設定で、ある帳票にRead権限までが設定されている場合、これをWrite権限に変更することは出来ません。 取引内での帳票アクセス権限に関する詳細については、[取引内での帳票アクセス権限について]()を参照ください。