施設グループの一覧を取得する

目次

施設グループの一覧を取得する

クエリで条件を指定して、施設グループの一覧を取得します。

URL

クラウド版

https://sample.cybozu.com/g/api/v1/schedule/facilityGroups

パッケージ版

環境に合わせてそれぞれ以下を置き換えてください。

  • IP_ADDRESS_OR_HOST_NAME:Garoon のインストール先の IP アドレスまたはホスト名
  • INSTALL_IDENTIFER:Garoon のインストール識別子
Windows 環境
http://IP_ADDRESS_OR_HOST_NAME/scripts/INSTALL_IDENTIFER/grn.exe/api/v1/schedule/facilityGroups
Linux 環境
http://IP_ADDRESS_OR_HOST_NAME/cgi-bin/INSTALL_IDENTIFER/grn.cgi/api/v1/schedule/facilityGroups

HTTP メソッド

GET

利用できるバージョン

  • クラウド版 Garoon
  • パッケージ版 Garoon 5.0 以降

必要なアクセス権

なし

リクエスト

パラメーター

リクエストパラメーターは、URL クエリパラメーターとして送信してください。
ただし、 Garoon REST API リクエストを送信する API を使って実行する場合は、リクエストボディとして指定できます。

パラメーター名 必須 説明
limit 数値 省略可 取得する施設グループの件数
1 から 1,000 まで指定できます。省略すると 100 が設定されます。
指定された条件に一致する施設グループがさらにある場合でも、指定した値より取得できる施設グループの数は少なくなる可能性があります。
offset 数値 省略可 取得する施設グループの先頭からスキップする数
省略すると、 0 が設定されます。
リクエストの例
URL

https://sample.cybozu.com/g/api/v1/schedule/facilityGroups?limit=30

ヘッダー
1
2
3
{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

リクエストヘッダーの詳細は Garoon REST API の共通仕様 を参照してください。

ボディ
1
2
3
{
  "limit": 30
}

レスポンス

プロパティ
プロパティ名 説明
facilityGroups[].id 数値 施設グループ ID
facilityGroups[].name 文字列 施設グループ名
facilityGroups[].code 文字列 施設グループコード
facilityGroups[].notes 数値 施設グループのメモ
facilityGroups[].parentFacilityGroup 数値 親施設グループ ID
facilityGroups[].childFacilityGroups.id 数値 子施設グループ ID
hasNext 真偽値 次の施設グループ情報があるかどうか
  • true:次の施設グループ情報がある
  • false:次の施設グループ情報がない
レスポンスの例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
  "facilityGroups": [
    {
      "id": "5",
      "name": "head office",
      "code": "Galaxy",
      "notes": "This is facility group memo.\nYou can write multiple lines.",
      "parentFacilityGroup": "2",
      "childFacilityGroups": [
        {
          "id": "10"
        }
      ]
    }
  ],
  "hasNext": false
}

サンプルコード

curl を使ったリクエスト
1
2
curl -X GET 'https://sample.cybozu.com/g/api/v1/schedule/facilityGroups?limit=30' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU='
Garoon REST API リクエストを送信する API を使ったリクエスト
1
2
3
4
5
const body = {
  limit: 30
};

await garoon.api('/api/v1/schedule/facilityGroups', 'GET', body);