Garoon API ドキュメント

組織を追加、更新、または削除する

目次

組織を追加する

固定リンクがコピーされました

親組織 ID、組織名、組織コードをリクエストのパラメーターとして受け取り、追加した組織情報をレスポンスとして返す API です。

API名

固定リンクがコピーされました

AdminAddOrg

使用可能な Garoon のバージョン

固定リンクがコピーされました

  • パッケージ版 Garoon 3.0 以降

リクエスト

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
org_code/text() xsd:string 1 組織コード
org_name/text() xsd:string 1 組織名
parent_orgId/text() xsd:integer 0 ～ 1 親組織ID
例
1
2
3
4
5

<parameters> 
  <org_code>orgcode-1</org_code> 
  <org_name>orgname-1</org_name> 
  <parent_orgId>3</parent_orgId> 
</parameters>

レスポンス

固定リンクがコピーされました

API 名とレスポンスの要素名が異なります。

パラメーター名 型 パラメーター数 説明
org_info admin:OrgDetail 1 追加した組織情報
orgId/text() xsd:intger 1 組織ID
例
1
2
3
4
5
6
7
8

<returns> 
  <org_info> 
    <orgId>31</orgId> 
    <org_code>orgcode-1</org_code> 
    <org_name>orgname-1</org_name> 
  </org_info> 
  <parent_orgId>3</parent_orgId> 
</returns>

組織を更新する

固定リンクがコピーされました

組織 ID、組織名、組織コードをリクエストのパラメーターとして受け取り、変更した組織情報をレスポンスとして返す API です。

API名

固定リンクがコピーされました

AdminModifyOrgInfo

使用可能な Garoon のバージョン

固定リンクがコピーされました

  • パッケージ版 Garoon 3.0 以降

リクエスト

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
orgId/text() xsd:integer 1 変更する組織のID
org_code/text() xsd:string 1 組織コード
org_name/text() xsd:string 1 組織名
例
1
2
3
4
5

<parameters> 
  <orgId>30</orgId> 
  <org_code>orgcode-1</org_code> 
  <org_name>orgname-1-modified</org_name> 
</parameters>

レスポンス

固定リンクがコピーされました

API 名とレスポンスの要素名が異なります。

パラメーター名 型 パラメーター数 説明
org_info admin:OrgDetail 1 変更した組織情報
例
1
2
3
4
5
6
7

<returns> 
  <org_info> 
    <orgId>30</orgId> 
    <org_code>orgcode-1</org_code> 
    <org_name>orgname-1-modified</org_name> 
  </org_info> 
</returns>

組織を削除する

固定リンクがコピーされました

組織 ID をリクエストのパラメーターとして受け取り、削除された組織 ID をレスポンスとして返す API です。 存在しない組織 ID を指定した場合、値は無視されます。

API名

固定リンクがコピーされました

AdminRemoveOrgsByIds

使用可能な Garoon のバージョン

固定リンクがコピーされました

  • パッケージ版 Garoon 3.0 以降

リクエスト

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
orgId/text() xsd:integer 1 削除する組織のID
例
1
2
3

<parameters> 
  <orgId>30</orgId> 
</parameters>

レスポンス

固定リンクがコピーされました

API 名とレスポンスの要素名が異なります。

パラメーター名 型 パラメーター数 説明
number_orgs_affected/text() xsd:integer 1 削除された組織の数
affected_orgId/text() xsd:integer 0 ～ 無制限 削除された組織のID
例
1
2
3
4

<returns> 
  <number_orgs_affected>1</number_orgs_affected> 
  <affected_orgId>30</affected_orgId> 
</returns>

組織にユーザーを所属させる

固定リンクがコピーされました

組織 ID と、その組織に追加するユーザーの ID を受け取り、組織に追加されたユーザーの ID をレスポンスとして返す API です。

API名

固定リンクがコピーされました

AdminAddUsersToOrg

使用可能な Garoon のバージョン

固定リンクがコピーされました

  • パッケージ版 Garoon 3.0 以降

リクエスト

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
orgId/text() xsd:integer 1 ユーザーを追加する組織のID
userId/text() xsd:integer 1 ～ 無制限 組織に追加するユーザーのID
例
1
2
3
4
5

<parameters> 
  <orgId>28</orgId> 
  <userId>20</userId> 
  <userId>21</userId> 
</parameters>

レスポンス

固定リンクがコピーされました

API 名とレスポンスの要素名が異なります。

パラメーター名 型 パラメーター数 説明
number_relationships_affected/text() xsd:integer 1 組織に追加されたユーザーの数
affected_orgId/text() xsd:integer 1 追加対象の組織
affected_userId/text() xsd:integer 0 ～ 無制限 組織に追加したユーザーのID
例
1
2
3
4
5
6

<returns> 
  <number_relationships_affected>1</number_relationships_affected> 
  <affected_orgId>28</affected_orgId> 
  <affected_userId>20</affected_userId> 
  <affected_userId>21</affected_userId> 
</returns>

組織からユーザーを削除する

固定リンクがコピーされました

組織から削除するユーザーID をリクエストのパラメーターとして受け取り、削除されたユーザーID をレスポンスとして返す API です。

API名

固定リンクがコピーされました

AdminRemoveUsersFromOrg

使用可能な Garoon のバージョン

固定リンクがコピーされました

  • パッケージ版 Garoon 3.0 以降

リクエスト

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
orgId/text() xsd:integer 1 ユーザーを削除する組織のID
userId/text() xsd:integer 1 ～ 無制限 組織から削除するユーザーのID
例
1
2
3
4
5

<parameters> 
  <orgId>50</orgId> 
  <userId>20</userId> 
  <userId>21</userId> 
</parameters>

レスポンス

固定リンクがコピーされました

API 名とレスポンスの要素名が異なります。

パラメーター名 型 パラメーター数 説明
number_relationships_affected/text() xsd:integer 1 組織から削除されたユーザーの数
affected_orgId/text() xsd:integer 1 削除対象の組織ID
affected_userId/text() xsd:integer 0 ～ 無制限 組織から削除されたユーザーのID
例
1
2
3
4
5
6

<returns> 
  <number_relationships_affected>2</number_relationships_affected> 
  <affected_orgId>50</affected_orgId> 
  <affected_userId>20</affected_userId> 
  <affected_userId>21</affected_userId> 
</returns>

組織の親組織を変更する

固定リンクがコピーされました

組織 ID と、その組織の親にする組織の ID をリクエストのパラメーターとして受け取り、親組織が変更された組織をレスポンスとして返す API です。
移動する組織に子組織が存在する場合、子組織も合わせて移動します。

API名

固定リンクがコピーされました

AdminAddChildrenOfOrg

使用可能な Garoon のバージョン

固定リンクがコピーされました

  • パッケージ版 Garoon 3.0 以降

リクエスト

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
parent_orgId/text() xsd:integer 1 親組織ID
child_orgId/text() xsd:integer 1 ～ 無制限 親組織に追加する組織ID
例
1
2
3
4
5
6

<parameters> 
  <parent_orgId>50</parent_orgId> 
  <child_orgId>10</child_orgId> 
  <child_orgId>20</child_orgId> 
  <child_orgId>30</child_orgId> 
</parameters>

レスポンス

固定リンクがコピーされました

API 名とレスポンスの要素名が異なります。

パラメーター名 型 パラメーター数 説明
number_relationships_affected/text() xsd:integer 1 親組織に追加した組織の数
affected_parent_orgId/text() xsd:integer 1 親組織ID
affected_child_orgId/text() xds:integer 0 ～ 無制限 親組織に追加された組織ID
例
1
2
3
4
5
6
7

<returns> 
  <number_relationships_affected>3</number_relationships_affected> 
  <affected_parent_orgId>50</affected_parent_orgId> 
  <affected_child_orgId>10</affected_child_orgId> 
  <affected_child_orgId>20</affected_child_orgId> 
  <affected_child_orgId>30</affected_child_orgId> 
</returns>