Data Dictionary Home

Organizations : /API/v2/Organizations

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

API		Description
DELETE	/API/v2/Organizations/Delete/{organizationId}	組織を削除します。組織ID（organizationId）を指定して、組織を削除します。このメソッドは会社の管理者（*/API/v2/Companies/Administrators*）として登録された利用者が利用できます。また、取引に参加している組織については、削除は行えません。組織に関する詳細については、[組織について]()を参照ください。
GET	/API/v2/Organizations/Get/{organizationId}	組織を取得します。組織ID（*organizationId*）を指定して、組織を取得します。組織に関する詳細については、[組織について]()を参照ください。
GET	/API/v2/Organizations/GetAccessibleReports/{organizationId}	組織がアクセス可能な帳票を全て取得します。組織がアクセス可能な帳票を全て取得します。アクセス可能な帳票は、組織に割り当てられた事業種別を条件に、(*/API/v2/Master/ReportTypes/Permissions**)で、アクセス権限がR権限以上のものを取得します。
GET	/API/v2/Organizations/GetMyList?organizationId=!{organizationId}	会社配下の組織を全て取得します。ログインしている利用者が所属する会社配下に登録されている全ての組織を取得します。有効でない組織（isActive=false）を含めて、会社配下に登録されている全ての組織を取得します。組織に関する詳細については、[組織について]()を参照ください。
GET	/API/v2/Organizations/IsUnique/{organizationId}	組織IDが一意であるかを判定します。組織ID（*organizationId*）を指定して、組織IDが一意であるか（このIDで組織を追加できるのか）を判定します。組織に関する詳細については、[組織について]()を参照ください。
POST	/API/v2/Organizations/Register	所属する会社に組織を登録します。管理者が所属する会社に、組織を登録します。このメソッドは会社の管理者（*/API/v2/Companies/Administrators*）として登録された利用者が利用できます。組織に関する詳細については、[組織について]()を参照ください。
GET	/API/v2/Organizations/Search?corporateNo=!{corporateNo}&companyName=!{companyName}&companyNameEn=!{companyNameEn}&organizationName=!{organizationName}&organizationNameEn=!{organizationNameEn}&businessTypeCodeList=!{businessTypeCodeList}	検索条件に該当する組織を取得します。検索条件を指定して、条件に該当する組織を全て取得します。非公開の組織（*permitSearchByName=false）や無効な組織（isActive=false*）は検索対象外となります。組織に関する詳細については、[組織について]()を参照ください。
PATCH	/API/v2/Organizations/SetActive/{organizationId}	組織が有効であるか（isActive）を更新します。組織ID（*organizationId）を指定して、組織が有効であるか（isActive）を更新します。 isActiveをfalseにすると、その組織は、 - 参加していた取引は参照できますが、取引内での操作は行えません。 - 新しい取引を作成したり、取引のパートナーとして参加することは出来ません。このメソッドは会社の管理者（/API/v2/Companies/Administrators*）として登録された利用者が利用できます。組織に関する詳細については、[組織について]()を参照ください。
PATCH	/API/v2/Organizations/Update/{organizationId}	組織を更新します。組織ID（*organizationId）を指定して、組織を更新します。更新する組織は、ログインしている利用者が所属する会社配下になければなりません。このメソッドは会社の管理者（/API/v2/Companies/Administrators*）として登録された利用者が利用できます。組織に関する詳細については、[組織について]()を参照ください。