施設グループの一覧取得（クエリで条件を指定）
施設グループの一覧をクエリで条件を指定して取得できます。
HTTP メソッド
GET
URI
クラウド版
https://(サブドメイン名).cybozu.com/g/api/v1/schedule/facilityGroups
パッケージ版（Windows環境）
http://(サーバーのIPアドレスまたはホスト名)/scripts/(インストール識別子)/grn.exe/api/v1/schedule/facilityGroups
パッケージ版（Linux環境）
http://(サーバーのIPアドレスまたはホスト名)/cgi-bin/(インストール識別子)/grn.cgi/api/v1/schedule/facilityGroups
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 5.0.0以降
必要なアクセス権
なし
リクエストパラメータ
| パラメータ名 | 指定する値 | 必須 | 説明 |
|---|---|---|---|
| limit | 数値 |
省略可 |
取得する施設グループの制限数を指定します。 要求パラメータで指定された条件に一致する施設グループがさらにある場合でも、施設グループ数は指定した値より少なくなる可能性があります。 デフォルト値：100 |
| offset | 数値 | 省略可 |
取得する施設グループの先頭からスキップする数を指定します。 |
リクエストの例
GET /g/api/v1/schedule/facilityGroups HTTP/1.1
Host: {subdomain}.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
- Content-Typeヘッダは不要です。
レスポンスの例
処理が成功すると、リクエストパラメータで指定された条件で、施設グループの内容がJSON形式で返されます。
プロパティ
| プロパティ名 | 型 | 説明 |
|---|---|---|
| facilityGroups[].id | 数値 |
施設グループID |
| facilityGroups[].name | 文字列 |
施設グループ名 |
| facilityGroups[].code | 文字列 | 施設グループコード |
| facilityGroups[].notes | 数値 | 施設グループのメモ |
| facilityGroups[].parentFacilityGroup | 数値 | 親施設グループID |
| facilityGroups[].childFacilityGroups.id | 数値 | 子施設グループID |
| hasnext | 真偽値 |
レスポンスに次の施設グループがあるかどうか |
施設グループに所属する施設の取得（クエリで条件を指定）
指定された施設グループに所属する施設の一覧を取得できます 。
HTTP メソッド
GET
URI
クラウド版
https://(サブドメイン名).cybozu.com/g/api/v1/schedule/facilityGroups/{id}/facilities
パッケージ版（Windows環境）
http://(サーバーのIPアドレスまたはホスト名)/scripts/(インストール識別子)/grn.exe/api/v1/schedule/facilityGroups/{id}/facilities
パッケージ版（Linux環境）
http://(サーバーのIPアドレスまたはホスト名)/cgi-bin/(インストール識別子)/grn.cgi/api/v1/schedule/facilityGroups/{id}/facilities
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 5.0.0以降
必要なアクセス権
なし
リクエストパラメータ
| パラメータ名 | 指定する値 | 必須 | 説明 |
|---|---|---|---|
| id | 数値 | 必須 | 施設グループIDを指定します。 |
| limit | 数値 |
省略可 |
取得する施設の制限数を指定します。 要求パラメータで指定された条件に一致する施設がさらにある場合でも、施設数は指定した値より少なくなる可能性があります。 デフォルト値：100 |
| offset | 数値 | 省略可 |
取得する施設の先頭からスキップする数を指定します。 |
リクエストの例
GET /g/api/v1/schedule/facilityGroups/5/facilities HTTP/1.1
Host: {subdomain}.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
- Content-Typeヘッダは不要です。
レスポンスの例
処理が成功すると、リクエストパラメータで指定された条件で、施設の内容がJSON形式で返されます。
プロパティ
| プロパティ名 | 型 | 説明 |
|---|---|---|
| facilities[].id | 数値 |
施設ID |
| facilities[].name | 文字列 |
施設名 |
| facilities[].code | 文字列 |
施設コード |
| facilities[].notes | 文字列 |
施設のメモ |
| facilities[].facilityGroup | 数値 |
親施設グループID |
制限事項
共通仕様の制限事項 をご確認ください。
記事に関するフィードバック
記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。