管理者権限で施設を取得する
管理者権限で施設を取得する
クエリで条件を指定し、施設情報を取得します。
この API を実行するには、管理者権限が必要です。詳細は
必要なアクセス権 を参照してください。
URL
https://sample.cybozu.com/g/api/v1/schedule/admin/facilities
HTTP メソッド
GET
利用できるバージョン
- クラウド版 Garoon
- パッケージ版 Garoon 5.15 以降
必要なアクセス権
次のいずれかの権限が必要です。
- Garoon のシステム管理者権限
- 予定のアプリケーション管理者権限
リクエスト
パラメーター
リクエストパラメーターは、URL クエリパラメーターとして送信してください。
ただし、
Garoon REST API リクエストを送信する API を使って実行する場合は、リクエストボディとして指定できます。
パラメーター名 | 型 | 必須 | 説明 |
---|---|---|---|
id | 配列(数値) | 省略可 | 施設 ID |
name | 文字列 | 省略可 | 施設名(標準) |
nameLocaleJa | 文字列 | 省略可 | 日本語で表示したときの施設名 |
nameLocaleEn | 文字列 | 省略可 | 英語で表示したときの施設名 |
nameLocaleZh | 文字列 | 省略可 | 簡体字で表示したときの表示名 |
nameLocaleZhTw | 文字列 | 省略可 | 繁体字で表示したときの表示名 |
codes | 配列(文字列) | 省略可 | 施設コード |
notes | 文字列 | 省略可 | メモ |
facilityGroup | 配列(数値) | 省略可 | 施設グループ ID |
limit | 数値 | 省略可 | 取得する施設情報の件数 1 から 1,000 まで指定できます。省略すると 100 が設定されます。 |
offset | 数値 | 省略可 | 取得する施設情報の先頭からスキップする数 省略すると、 0 が設定されます。 |
リクエストの例
URL
https://sample.cybozu.com/g/api/v1/schedule/admin/facilities?id[]=1&id[]=2
ヘッダー
|
|
リクエストヘッダーの詳細は Garoon REST API の共通仕様 を参照してください。
ボディ
|
|
レスポンス
プロパティ
プロパティ名 | 型 | 説明 |
---|---|---|
facilities | 配列(オブジェクト) | 施設情報の一覧 |
facilitie[].id | 数値 | 施設 ID |
facilitie[].name | 文字列 | 施設名(標準) |
facilitie[].nameLocale | オブジェクト | 言語ごとに設定した施設の表示名のオブジェクト 言語ごとの表示名が設定されていない場合、このプロパティは返りません。 |
facilitie[].nameLocale.ja | 文字列 | 日本語で表示したときの施設名 |
facilitie[].nameLocale.en | 文字列 | 英語で表示したときの施設名 |
facilitie[].nameLocale.zh | 文字列 | 簡体字で表示したときの施設名 |
facilitie[].nameLocale.zh-tw | 文字列 | 繁体字で表示したときの施設名 |
facilitie[].code | 文字列 | 施設コード |
facilitie[].notes | 文字列 | メモ |
facilitie[].facilityGroup | 数値 | 施設グループ ID |
hasNext | 真偽値 | 次の施設情報があるかどうか
|
count | 数値 | 取得した施設の件数 |
レスポンスの例
|
|
サンプルコード
curl を使ったリクエスト
|
|
Garoon REST API リクエストを送信する API を使ったリクエスト
|
|