組織の更新情報を取得する
組織の ID とバージョンをリクエストのパラメーターとして受け取り、組織の更新情報をレスポンスとして返す API です。
リクエストで受け取った version とガルーンが持つ version が異なる場合、レスポンスの operationは、”modify”となります。
ガルーンに存在する組織をリクエストで受け取らなかった場合、レスポンスの operation は、”add”となります。
ガルーンに存在しない組織をリクエストで受け取った場合、レスポンスの operationは、”remove”となります。
これらの情報は更新情報であり、本APIによって更新が行われることはありません。
API名
BaseGetOrganizationVersions
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
organization_item | base:ItemVersionType | 0 ~ 無制限
|
更新情報を取得する組織のIDとバージョン |
例
<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 ~ 無制限
|
取得した組織の更新情報 |
例
<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 バージョン 3.0.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
organization_id | base:IDType | 1 ~ 無制限 | 情報を取得する組織のID |
例
<parameters> <organization_id>1</organization_id> <organization_id>2</organization_id> </parameters>
レスポンス
パラメーター名 | 型 | パラメーター数 | 説明 |
organization | base:OrganizationType | 0 ~ 無制限 | 取得した組織情報 |
例
<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 | 指定した組織が存在しない場合 |
記事に関するフィードバック
記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。