組織の一覧を取得する
組織の一覧を取得する
組織の一覧を取得します。
URL
クラウド版
https://sample.cybozu.com/g/api/v1/base/organizations
パッケージ版
環境に合わせてそれぞれ以下を置き換えてください。
IP_ADDRESS_OR_HOST_NAME
:Garoonのインストール先のIPアドレスまたはホスト名INSTALL_IDENTIFER
:Garoonのインストール識別子
- Windows環境
- http://
IP_ADDRESS_OR_HOST_NAME
/scripts/INSTALL_IDENTIFER
/grn.exe/api/v1/base/organizations - Linux環境
- http://
IP_ADDRESS_OR_HOST_NAME
/cgi-bin/INSTALL_IDENTIFER
/grn.cgi/api/v1/base/organizations
HTTPメソッド
GET
利用できるバージョン
- クラウド版Garoon
- パッケージ版Garoon 5.0以降
必要なアクセス権
なし
リクエスト
パラメーター
リクエストパラメーターは、URLクエリパラメーターとして送信してください。
ただし、
Garoon REST APIリクエストを送信するAPIを使って実行する場合は、リクエストボディとして指定できます。
パラメーター名 | 型 | 必須 | 説明 |
---|---|---|---|
name | 文字列 | 省略可 | 組織名 |
limit | 数値 | 省略可 | 取得する組織の件数 1から1,000まで指定できます。省略すると100が設定されます。 指定された条件に一致する組織がさらにある場合でも、指定した値より取得できる組織の数は少なくなる可能性があります。 |
offset | 数値 | 省略可 | 取得する組織の先頭からスキップする数 省略すると、0が設定されます。 |
リクエストの例
URL
https://sample.cybozu.com/g/api/v1/base/organizations?limit=30
ヘッダー
|
|
リクエストヘッダーの詳細は Garoon REST APIの共通仕様を確認してください。
ボディ
|
|
レスポンス
プロパティ
プロパティ名 | 型 | 説明 |
---|---|---|
organizations | 配列 | 組織情報の一覧 並び順は organizations[].id の昇順です。 |
organizations[].id | 数値 | 組織ID |
organizations[].name | 文字列 | 組織名 |
organizations[].code | 文字列 | 組織コード |
organizations[].parentOrganization | 文字列 | 親組織ID |
organizations[].childOrganizations.id | 数値 | 子組織ID |
hasNext | 真偽値 | 次の組織情報があるかどうか
|
レスポンスの例
|
|
サンプルコード
curlを使ったリクエスト
|
|
Garoon REST APIリクエストを送信するAPIを使ったリクエスト
|
|