施設の一覧を取得する
施設の一覧を取得する
施設の一覧をクエリで条件を指定して取得できます。
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 を使って実行する場合は、リクエストボディとして指定できます。
パラメーター名 | 型 | 必須 | 説明 |
---|---|---|---|
name | 文字列 | 省略可 | 施設名 |
limit | 数値 | 省略可 | 取得する施設の件数 1 から 1,000 まで指定できます。省略すると 100 が設定されます。 指定された条件に一致する施設がさらにある場合でも、指定した値より取得できる施設の数は少なくなる可能性があります。 |
offset | 数値 | 省略可 | 取得する施設の先頭からスキップする数 省略すると、 0 が設定されます。 |
リクエストの例
URL
https://sample.cybozu.com/g/api/v1/schedule/facilities?limit=30
ヘッダー
|
|
リクエストヘッダーの詳細は Garoon REST API の共通仕様 を参照してください。
ボディ
|
|
レスポンス
プロパティ
プロパティ名 | 型 | 説明 |
---|---|---|
facilities[].id | 数値 | 施設 ID |
facilities[].name | 文字列 | 施設名 |
facilities[].code | 文字列 | 施設コード |
facilities[].notes | 文字列 | 施設のメモ |
facilities[].facilityGroup | 数値 | 親施設グループ ID |
hasNext | 真偽値 | 次の施設情報があるかどうか
|
レスポンスの例
|
|
サンプルコード
curlを使ったリクエスト
|
|
Garoon REST API リクエストを送信する API を使ったリクエスト
|
|