Garoon API ドキュメント

施設グループに所属する施設を取得する

目次

施設グループに所属する施設を取得する

固定リンクがコピーされました

クエリで条件を指定して、特定の施設グループに所属する施設を取得できます。

URL

固定リンクがコピーされました

クラウド版

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

パッケージ版

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

  • 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/FACILITY_GROUP_ID/facilities
Linux環境
http://IP_ADDRESS_OR_HOST_NAME/cgi-bin/INSTALL_IDENTIFER/grn.cgi/api/v1/schedule/facilityGroups/FACILITY_GROUP_ID/facilities
パスパラメーター
パラメーター名 説明
FACILITY_GROUP_ID 施設グループに所属している施設を取得するための 施設グループ ID

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/1/facilities?limit=5

ヘッダー
1
2
3

{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

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

ボディ
1
2
3

{
  "limit": 5
}

レスポンス

固定リンクがコピーされました

プロパティ
プロパティ名 型 説明
facilities[].id 数値 施設 ID
facilities[].name 文字列 施設名
facilities[].code 文字列 施設コード
facilities[].notes 文字列 施設のメモ
facilities[].facilityGroup 数値 親施設グループ ID
レスポンスの例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

{
  "facilities": [
    {
      "id": "5",
      "name": "Room A",
      "code": "roa",
      "notes": "This is facility memo.\nYou can write multiple lines.",
      "facilityGroup": "2"
    }
  ]
}

サンプルコード

固定リンクがコピーされました

curl を使ったリクエスト
1
2

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

const body = {
  limit: 5
};

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