管理者権限で施設を取得する

目次

管理者権限で施設を取得する

クエリで条件を指定し、施設情報を取得します。
この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

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

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

ボディ
1
2
3
{
  "id": [1, 2]
}

レスポンス

プロパティ
プロパティ名 説明
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 真偽値 次の施設情報があるかどうか
  • true:次の施設情報がある
  • false:次の施設情報がない
count 数値 取得した施設の件数
レスポンスの例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
  "facilities": [
    {
      "id": 1,
      "name": "Library",
      "nameLocale": {
        "ja": "会議室A",
        "en": "Meeting room A",
        "zh": "会议室A",
        "zh-tw": "會議室A"
      },
      "code": "meeting_room_a",
      "notes": "This is note",
      "facilityGroup": 1
    }
  ],
  "hasNext": false,
  "count": 1
}

サンプルコード

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

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