組織情報を取得する
組織の更新情報を取得する
組織の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~ 無制限
|
更新情報を取得する組織のIDとバージョン |
例
|
|
レスポンス
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| organization_item | base:ItemVersionResultType | 0~ 無制限
|
取得した組織の更新情報 |
例
|
|
組織情報を取得する
組織IDをリクエストのパラメーターとして受け取り、組織情報をレスポンスとして返すAPIです。
API名
BaseGetOrganizationsById
使用可能なGaroonのバージョン
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
リクエスト
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| organization_id | base:IDType | 1~ 無制限 | 情報を取得する組織のID |
例
|
|
レスポンス
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| organization | base:OrganizationType | 0~ 無制限 | 取得した組織情報 |
例
|
|
エラー
| エラー番号 | 説明 |
|---|---|
| GRN_CMMN_00106 | 指定した組織が存在しない場合 |
