Garoon APIドキュメント

組織情報を取得する

目次

組織の更新情報を取得する

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

組織のIDとバージョンをリクエストのパラメーターとして受け取り、組織の更新情報をレスポンスとして返すAPIです。

リクエストで受け取ったversionとGaroon上のversionが異なる場合、レスポンスのoperationは、"modify"となります。 Garoonに存在する組織をリクエストで受け取らなかった場合、レスポンスのoperationは、"add"となります。 Garoonに存在しない組織をリクエストで受け取った場合、レスポンスのoperationは、"remove"となります。 これらの情報は更新情報です。このAPIによって更新が行われることはありません。

API名

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

BaseGetOrganizationVersions

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

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

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

リクエスト

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

パラメーター名 型 パラメーター数 説明
organization_item base:ItemVersionType 0～ 無制限
  • 0：組織のバージョンが指定されていない
 更新情報を取得する組織のIDとバージョン
例
1
2
3
4
5

<parameters>
  <organization_item id="1" version="11" />
  <organization_item id="2" version="22" />
  <organization_item id="3" version="33" />
</parameters>

レスポンス

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

パラメーター名 型 パラメーター数 説明
organization_item base:ItemVersionResultType 0～ 無制限
  • 0：組織更新情報がない
 取得した組織の更新情報
例
1
2
3
4
5
6
7

<returns>
  <organization_item id="1" version="1245376338" operation="modify" />
  <organization_item id="2" version="1245327097" operation="modify" />
  <organization_item id="3" version="1245327110" operation="modify" />
  <organization_item id="4" version="1245715417" operation="add" />
  <organization_item id="5" version="1245715429" operation="add" />
</returns>

組織情報を取得する

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

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

API名

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

BaseGetOrganizationsById

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

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

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

リクエスト

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

パラメーター名 型 パラメーター数 説明
organization_id base:IDType 1～ 無制限 情報を取得する組織のID
例
1
2
3
4

<parameters>
  <organization_id>1</organization_id>
  <organization_id>2</organization_id>
</parameters>

レスポンス

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

パラメーター名 型 パラメーター数 説明
organization base:OrganizationType 0～ 無制限 取得した組織情報
例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

<returns>
  <organization key="1" name="user1_user1000" version="1281400956" description="事業部user1_user1000" order="1">
    <organization key="2" xmlns="http://schemas.cybozu.co.jp/base/2008"/>
    <organization key="8" xmlns="http://schemas.cybozu.co.jp/base/2008"/>
    <organization key="14" xmlns="http://schemas.cybozu.co.jp/base/2008"/>
    <members xmlns="http://schemas.cybozu.co.jp/base/2008">
    </members>
  </organization >
  <organization key="2" name="user1_user100" version="1281400956" description="部user1_user100" order="1" parent_organization="1">
    <organization key="3" xmlns="http://schemas.cybozu.co.jp/base/2008"/>
    <organization key="4" xmlns="http://schemas.cybozu.co.jp/base/2008"/>
    <members xmlns="http://schemas.cybozu.co.jp/base/2008">
    </members>
  </organization >
</returns>

エラー

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

エラー番号 説明
GRN_CMMN_00106 指定した組織が存在しない場合