施設の一覧を取得する

施設の一覧をクエリで条件を指定して取得できます。

URL

クラウド版

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

パッケージ版

Windows 環境

http://サーバーのIPアドレスまたはホスト名/scripts/インストール識別子/grn.exe/api/v1/schedule/facilities

Linux 環境

http://サーバーのIPアドレスまたはホスト名/cgi-bin/インストール識別子/grn.cgi/api/v1/schedule/facilities

HTTPメソッド

GET

利用できるバージョン

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

必要なアクセス権

なし

リクエスト

パラメーター

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

リクエストの例

URL

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

ヘッダー

1
2
3

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

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

ボディ

1
2
3

{
  "limit": 30
}

レスポンス

プロパティ

レスポンスの例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

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

サンプルコード

curlを使ったリクエスト

1
2

curl -X GET 'https://sample.cybozu.com/g/api/v1/schedule/facilities?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/facilities', 'GET', body);