Garoon APIドキュメント

管理者権限で施設グループを取得する

目次

管理者権限で施設グループを取得する

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

クエリで条件を指定し、施設グループの情報を取得します。
このAPIを実行するには、管理者権限が必要です。詳細は 必要なアクセス権 を参照してください。

URL

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

クラウド版

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

パッケージ版

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

  • 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/admin/facilityGroups
Linux環境
http://IP_ADDRESS_OR_HOST_NAME/cgi-bin/INSTALL_IDENTIFER/grn.cgi/api/v1/schedule/admin/facilityGroups

HTTPメソッド

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

GET

利用できるバージョン

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

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

必要なアクセス権

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

次のいずれかの権限が必要です。

  • Garoonのシステム管理者権限
  • 予定のアプリケーション管理者権限

リクエスト

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

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

パラメーター
パラメーター名 型 必須 説明
id 配列（数値） 省略可 施設グループID
name 文字列 省略可 施設グループ名
nameLocaleJa 文字列 省略可 日本語で表示したときの施設グループ名
nameLocaleEn 文字列 省略可 英語で表示したときの施設グループ名
nameLocaleZh 文字列 省略可 簡体字で表示したときの施設グループ名
nameLocaleZhTw 文字列 省略可 繁体字で表示したときの施設グループ名
codes 配列（文字列） 省略可 施設グループコード
notes 文字列 省略可 メモ
parentFacilityGroups 数値 省略可 親施設グループID
childFacilityGroups 配列（数値） 省略可 子施設グループID
top 数値 省略可 1階層目の施設グループのみを取得するかどうか
  • 1：1階層目の施設グループを取得する
  • なし：すべての階層の施設グループを取得する
limit 数値 省略可 取得する件数
1から1,000まで指定できます。省略すると100が設定されます。
offset 数値 省略可 取得する施設グループの先頭からスキップする数
省略すると、0が設定されます。
リクエストの例
URL

https://sample.cybozu.com/g/api/v1/schedule/admin/facilityGroups?id[]=1&id[]=2

ヘッダー
1
2
3

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

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

ボディ
1
2
3

{
  "id": [1, 2]
}

レスポンス

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

プロパティ
プロパティ名 型 説明
facilityGroups[].id 数値 施設グループID
facilityGroups[].name 文字列 施設グループ名
facilityGroups[].nameLocale オブジェクト 言語ごとに設定した施設グループ名の表示名のオブジェクト
言語ごとの表示名が設定されていない場合、このプロパティは返りません。
facilityGroups[].nameLocale.ja 文字列 日本語で表示したときの施設グループ名
facilityGroups[].nameLocale.en 文字列 英語で表示したときの施設グループ名
facilityGroups[].nameLocale.zh 文字列 簡体字で表示したときの施設グループ名
facilityGroups[].nameLocale.zh-tw 文字列 繁体字で表示したときの施設グループ名
facilityGroups[].code 文字列 施設グループコード
facilityGroups[].notes 文字列 メモ
facilityGroups[].parentFacilityGroup 数値 親施設グループID
1階層目の施設グループの場合、「null」が返ります。
facilityGroups[].childFacilityGroups[] 配列（オブジェクト） 子施設グループID
facilityGroups[].childFacilityGroups[].id 数値 子施設グループID
hasNext 真偽値 次の施設グループの情報があるかどうか
  • true：次の施設グループの情報がある
  • false：次の施設グループの情報がない
count 数値 取得した施設グループの件数
レスポンスの例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

{
  "facilityGroups": [
    {
      "id": 1,
      "name": "Tokyo",
      "nameLocale": {
        "ja": "東京",
        "en": "Tokyo",
        "zh": "東京",
        "zh-tw": "东京"
      },
      "code": "tokyo_office",
      "notes": "This is note",
      "parentFacilityGroup": "2",
      "childFacilityGroups": [
        {
          "id": "10"
        }
      ]
    }
  ],
  "hasNext": false,
  "count": 1
}

サンプルコード

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

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

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