カテゴリー内の他の記事

管理者による施設グループの取得(GET)

Index

管理者による施設グループの取得(クエリで条件を指定)

クエリで条件を指定し、施設グループの情報を取得できます。

HTTP メソッド

GET

URI

クラウド版

https://(サブドメイン名).cybozu.com/g/api/v1/schedule/admin/facilityGroups

使用可能なガルーンのバージョン

  • クラウド版 Garoon

必要なアクセス権

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

クエリパラメータ

パラメータ名 指定する値 必須 説明
id 配列(数値)

省略可

施設グループの ID

name 文字列 省略可

施設グループ名

nameLocaleJa 文字列 省略可 日本語で表示したときの施設グループ名
nameLocaleEn 文字列 省略可 英語で表示したときの施設グループ名
nameLocaleZh 文字列 省略可 簡体字で表示したときの施設グループ名
nameLocaleZhTw 文字列 省略可 繁体字で表示したときの施設グループ名
codes 配列(文字列) 省略可 施設グループコード
notes 文字列 省略可 メモ
parentFacilityGroups 数値 省略可 親施設グループの ID
childFacilityGroups

配列(数値) 省略可 子施設グループの ID
top
数値 省略可

1階層目の施設グループのみを取得するかどうか

  • 1: 1階層目の施設グループを取得する
  • なし: すべての階層の施設グループを取得する
limit 数値 省略可

取得する件数
1〜1000を指定できます。

デフォルトは 100件です。

offset 数値 省略可

取得する件数の先頭からスキップする数
0〜無制限を指定できます。

デフォルトは 0 です。

リクエストの例 

GET /g/api/v1/schedule/admin/facilityGroups?id=[1,2,3]
Host: {subdomain}.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
  • Content-Typeヘッダは不要です。

レスポンスの例

処理が成功すると、条件に一致する施設の情報が JSON 形式で返されます。 

レスポンスのプロパティ

プロパティ名 説明
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 真偽値 レスポンスに次の施設があるかどうか
count 数値 取得した施設グループの件数

JavaScript サンプル

Garoon REST API

XMLHttpRequest

制限事項

共通仕様の制限事項 をご確認ください。

記事に関するフィードバック

記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。

サインインしてコメントを残してください。