管理者権限で施設グループを取得する
管理者権限で施設グループを取得する
クエリで条件を指定し、施設グループの情報を取得します。
この API を実行するには、管理者権限が必要です。詳細は
必要なアクセス権 を参照してください。
URL
クラウド版
https://sample.cybozu.com/g/api/v1/schedule/admin/facilityGroups
パッケージ版
- Windows 環境
- http://
サーバーの IP アドレスまたはホスト名
/scripts/インストール識別子
/grn.exe/api/v1/schedule/admin/facilityGroups - Linux 環境
- http://
サーバーの IP アドレスまたはホスト名
/cgi-bin/インストール識別子
/grn.cgi/api/v1/schedule/admin/facilityGroups
HTTP メソッド
GET
利用できるバージョン
- クラウド版 Garoon
- パッケージ版 Garoon 5.15 以降
必要なアクセス権
次のいずれかの権限が必要です。
- Garoon のシステム管理者権限
- 予定のアプリケーション管理者権限
リクエスト
リクエストパラメーターは、URL クエリパラメーターとして送信してください。
ただし、
Garoon REST API リクエストを送信する API を使って実行する場合は、リクエストボディとして指定できます。
パラメーター
パラメーター名 | 型 | 必須 | 説明 |
---|---|---|---|
id | 配列(数値) | 省略可 | 施設グループ ID |
name | 文字列 | 省略可 | 施設グループ名 |
nameLocaleJa | 文字列 | 省略可 | 日本語で表示したときの施設グループ名 |
nameLocaleEn | 文字列 | 省略可 | 英語で表示したときの施設グループ名 |
nameLocaleZh | 文字列 | 省略可 | 簡体字で表示したときの施設グループ名 |
nameLocaleZhTw | 文字列 | 省略可 | 繁体字で表示したときの施設グループ名 |
codes | 配列(文字列) | 省略可 | 施設グループコード |
notes | 文字列 | 省略可 | メモ |
parentFacilityGroups | 数値 | 省略可 | 親施設グループ ID |
childFacilityGroups | 配列(数値) | 省略可 | 子施設グループ ID |
top | 数値 | 省略可 | 1階層目の施設グループのみを取得するかどうか
|
limit | 数値 | 省略可 | 取得する件数 1 から 1,000 まで指定できます。省略すると 100 が設定されます。 |
offset | 数値 | 省略可 | 取得する施設グループの先頭からスキップする数 省略すると、 0 が設定されます。 |
リクエストの例
URL
https://sample.cybozu.com/g/api/v1/schedule/admin/facilityGroups?id[]=1&id[]=2
ヘッダー
|
|
リクエストヘッダーの詳細は Garoon REST API の共通仕様 を参照してください。
ボディ
|
|
レスポンス
プロパティ
プロパティ名 | 型 | 説明 |
---|---|---|
facilityGroups[].id | 数値 | 施設グループ ID |
facilityGroups[].name | 文字列 | 施設グループ名 |
facilityGroups[].nameLocale | オブジェクト | 言語ごとに設定した施設グループ名の表示名のオブジェクト 言語ごとの表示名が設定されていない場合、このプロパティは返りません。 |
facilityGroups[].nameLocale.ja | 文字列 | 日本語で表示したときの施設グループ名 |
facilityGroups[].nameLocale.en | 文字列 | 英語で表示したときの施設グループ名 |
facilityGroups[].nameLocale.zh | 文字列 | 簡体字で表示したときの施設グループ名 |
facilityGroups[].nameLocale.zh-tw | 文字列 | 繁体字で表示したときの施設グループ名 |
facilityGroups[].code | 文字列 | 施設グループコード |
facilityGroups[].notes | 文字列 | メモ |
facilityGroups[].parentFacilityGroup | 数値 | 親施設グループ ID 1階層目の施設グループの場合、「null」が返ります。 |
facilityGroups[].childFacilityGroups[] | 配列(オブジェクト) | 子施設グループ ID |
facilityGroups[].childFacilityGroups[].id | 数値 | 子施設グループ ID |
hasNext | 真偽値 | 次の施設グループの情報があるかどうか
|
count | 数値 | 取得した施設グループの件数 |
レスポンスの例
|
|
サンプルコード
curl を使ったリクエスト
|
|
Garoon REST API リクエストを送信する API を使ったリクエスト
|
|