組織情報を取得する

Garoon API ドキュメント

組織情報を取得する

組織数を取得する

Garoon に存在する組織数をレスポンスとして返す API です。

API名

AdminCountOrgs

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

クラウド版 Garoon
パッケージ版 Garoon 3.0 以降

リクエスト

なし

レスポンス

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

パラメーター名	型	パラメーター数	説明
number_orgs/text()	xsd:integer	1	組織数

例

1
2
3


<returns> 
  <number_orgs>3</number_orgs> 
</returns>

組織IDを取得する

Garoon に存在する組織の ID を返す API です。

API名

AdminGetOrgIds

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

クラウド版 Garoon
パッケージ版 Garoon 3.0 以降

リクエスト

パラメーター名	型	パラメーター数	説明
offset/text()	xsd:integer	0 ～ 1	オフセット
limit/text()	xsd:integer	0 ～ 1	取得数上限

例

1
2
3
4


<parameters> 
  <offset>0</offset> 
  <limit>5</limit> 
</parameters>

レスポンス

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

パラメーター名	型	パラメーター数	説明
number_orgs/text()	xsd:integer	1	取得した組織数
orgId/text()	xsd:integer	0 ～無制限	取得した組織のID

例

1
2
3
4
5
6
7
8


<returns> 
  <number_orgs>5</number_orgs> 
  <orgId>1</orgId> 
  <orgId>2</orgId> 
  <orgId>3</orgId> 
  <orgId>4</orgId> 
  <orgId>5</orgId> 
</returns>

組織を取得する

組織 ID をリクエストのパラメーターとして受け取り、組織の詳細情報をレスポンスとして返す API です。存在しない組織 ID を指定した場合、エラーは発生せず、その ID に対する処理は行いません。組織情報のその他の項目値を取得する場合は、ベース API の BaseGetOrganizationsById を使用します。

API名

AdminGetOrgDetailByIds

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

クラウド版 Garoon
パッケージ版 Garoon 3.0 以降

リクエスト

パラメーター名	型	パラメーター数	説明
orgId/text()	xsd:integer	1 ～無制限	組織ID

例

1
2
3


<parameters> 
  <orgId>2</orgId> 
</parameters>

レスポンス

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

パラメーター名	型	パラメーター数	説明
number_orgs/text()	xsd:integer	1	取得した組織数
OrgDetail	admin:OrgDetail	0 ～無制限 0：組織が存在しない	取得した組織の情報

例

1
2
3
4
5
6
7
8


<returns> 
  <number_orgs>1</number_orgs> 
  <OrgDetail> 
    <orgId>2</orgId> 
    <org_code>11</org_code> 
    <org_name>開発本部</org_name> 
  </OrgDetail> 
</returns>

子組織の数を取得する

組織 ID をリクエストのパラメーターとして受け取り、子組織の個数をレスポンスとして返す API です。

API名

AdminCountChildOrgs

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

クラウド版 Garoon
パッケージ版 Garoon 3.0 以降

リクエスト

パラメーター名	型	パラメーター数	説明
parent_orgId/text()	xsd:integer	1	子組織の数を取得する組織のID

例

1
2
3


<parameters> 
  <parent_orgId>2</parent_orgId> 
</parameters>

レスポンス

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

パラメーター名	型	パラメーター数	説明
parent_orgId/text()	xsd:integer	1	子組織の数を取得する組織のID
number_child_orgs/text()	xsd:integer	1	parent_orgIdの子組織の数

例

1
2
3
4


<returns> 
  <parent_orgId>2</parent_orgId> 
  <number_child_orgs>5</number_child_orgs> 
</returns>

子組織のIDを取得する

組織 ID をリクエストのパラメーターとして受け取り、子組織の ID をレスポンスとして返す API です。

API名

AdminGetChildOrgs

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

クラウド版 Garoon
パッケージ版 Garoon 3.0 以降

リクエスト

パラメーター名	型	パラメーター数	説明
parent_orgId/text()	xsd:integer	1	子組織のIDを取得する組織のID
offset/text()	xsd:integer	0 ～ 1	オフセット
limit/text()	xsd:intger	0 ～ 1	取得する子組織の上限数

例

1
2
3
4
5


<parameters> 
  <parent_orgId>2</parent_orgId> 
  <offset>0</offset> 
  <limit>10</limit> 
</parameters>

レスポンス

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

パラメーター名	型	パラメーター数	説明
parent_orgId/text()	xsd:integer	1	子組織のIDを取得する組織のID
number_child_orgs/text()	xsd:integer	1	取得した子組織の数
orgId/text()	xsd:integer	0 ～無制限 0：子組織が存在しない	子組織ID

例

1
2
3
4
5
6
7
8
9


<returns> 
  <parent_orgId>2</parent_orgId> 
  <number_child_orgs>5</number_child_orgs> 
  <orgId>3</orgId> 
  <orgId>4</orgId> 
  <orgId>5</orgId> 
  <orgId>6</orgId> 
  <orgId>7</orgId> 
</returns>

親組織のIDを取得する

組織 ID をリクエストのパラメーターとして受け取り、その組織の親組織の ID をレスポンスとして返す API です。

API名

AdminGetParentOrgId

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

クラウド版 Garoon
パッケージ版 Garoon 3.0 以降

リクエスト

パラメーター名	型	パラメーター数	説明
child_orgId/text()	xsd:integer	1	親組織IDを取得する組織ID

例

1
2
3


<parameters> 
  <child_orgId>2</child_orgId> 
</parameters>

レスポンス

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

パラメーター名	型	パラメーター数	説明
child_orgId/text()	xsd:integer	1	親組織IDを取得する組織ID
parent_orgId/text()	xsd:integer	1	取得した親組織ID

例

1
2
3
4


<returns> 
  <child_orgId>2</child_orgId> 
  <parent_orgId>1</parent_orgId> 
</returns>

組織コードから組織IDを取得する

組織コードをリクエストのパラメーターとして受け取り、組織 ID をレスポンスとして返す API です。存在しない組織 ID を指定した場合、-1 が返されます。

API名

AdminGetOrgIdByOrgCode

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

クラウド版 Garoon
パッケージ版 Garoon 3.0 以降

リクエスト

パラメーター名	型	パラメーター数	説明
org_code/text()	xsd:string	1	組織コード

例

1
2
3


<parameters> 
  <org_code>org1</org_code> 
</parameters>

レスポンス

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

パラメーター名	型	パラメーター数	説明
org_code/text()	xsd:string	1	指定した組織コード
orgId/text()	xsd:integer	1	取得した組織ID

例

1
2
3
4


<returns> 
  <org_code>org1</org_code> 
  <orgId>30</orgId> 
</returns>

組織内のユーザー数を取得する

組織 ID をリクエストのパラメーターとして受け取り、組織内に存在するユーザーの人数をレスポンスとして返す API です。存在しない組織 ID を指定した場合、レスポンスの orgId には -1 が入り、number_users は 0 が入ります。

API名

AdminCountUsersInOrg

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

クラウド版 Garoon
パッケージ版 Garoon 3.0 以降

リクエスト

パラメーター名	型	パラメーター数	説明
orgId/text()	xsd:integer	1	組織ID

例

1
2
3


<parameters> 
  <orgId>2</orgId> 
</parameters>

レスポンス

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

パラメーター名	型	パラメーター数	説明
orgId/text()	xsd:integer	1	組織ID
number_users/text()	xsd:integer	1	組織内に存在するユーザー数

例

1
2
3
4


<returns> 
  <orgId>2</orgId> 
  <number_users>9</number_users> 
</returns>

組織内のユーザーのIDを取得する

組織 ID をリクエストのパラメーターとして受け取り、組織内に存在するユーザーの ID をレスポンスとして返す API です。存在しない組織 ID を指定した場合、レスポンスの orgId には -1 が入り、number_users は 0 が入ります。

API名

AdminGetUserIdsInOrg

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

クラウド版 Garoon
パッケージ版 Garoon 3.0 以降

リクエスト

パラメーター名	型	パラメーター数	説明
orgId/text()	xsd:integer	1	組織ID
offset/text()	xsd:integer	0 ～ 1	オフセット
limit/text()	xsd:integer	0 ～ 1	取得するユーザーの上限数

例

1
2
3
4
5


<parameters> 
  <orgId>2</orgId> 
  <offset>0</offset> 
  <limit>10</limit> 
</parameters>

レスポンス

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

パラメーター名	型	パラメーター数	説明
orgId/text()	xsd:integer	1	組織ID
number_users/text()	xsd:integer	1	取得したユーザー数
userId/text()	xsd:integer	0 ～無制限	取得したユーザーのID

例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13


<returns> 
  <orgId>2</orgId> 
  <number_users>9</number_users> 
  <userId>2</userId> 
  <userId>3</userId> 
  <userId>4</userId> 
  <userId>5</userId> 
  <userId>6</userId> 
  <userId>7</userId> 
  <userId>8</userId> 
  <userId>9</userId> 
  <userId>10</userId> 
</returns>

Garoon API ドキュメント