Garoon APIドキュメント

管理者権限で施設グループを更新する

目次

管理者権限で施設グループを更新する

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

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

URL

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

クラウド版

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

パッケージ版

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

  • 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/FACILITY_GROUP_ID
Linux環境
http://IP_ADDRESS_OR_HOST_NAME/cgi-bin/INSTALL_IDENTIFER/grn.cgi/api/v1/schedule/admin/facilityGroups/FACILITY_GROUP_ID
パスパラメーター
パラメーター名 説明
FACILITY_GROUP_ID 更新する施設グループの施設グループID

HTTPメソッド

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

PATCH

利用できるバージョン

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

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

必要なアクセス権

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

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

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

リクエスト

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

パラメーター
パラメーター名 型 必須 説明
name 文字列 必須 施設グループ名
nameLocale.ja 文字列 省略可 日本語で表示したときの施設グループ名
nameLocale.en 文字列 省略可 英語で表示したときの施設グループ名
nameLocale.zh 文字列 省略可 簡体字で表示したときの施設グループ名
nameLocale.zh-tw 文字列 省略可 繁体字で表示したときの施設グループ名
code 文字列 必須 施設グループコード
notes 文字列 省略可 メモ
parentFacilityGroup 数値 省略可 親施設グループID
リクエストの例
URL

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

ヘッダー
1
2
3
4

{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}

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

ボディ
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

{
  "name": "Tokyo",
  "nameLocale": {
    "ja": "東京",
    "en": "Tokyo",
    "zh": "東京",
    "zh-tw": "东京"
  },
  "code": "tokyo_office",
  "notes": "This is note",
  "parentFacilityGroup": 2
}
レスポンスの例
プロパティ
プロパティ名 型 説明
id 数値 施設グループID
name 文字列 施設グループ名
nameLocale オブジェクト 言語ごとに設定した施設グループの表示名
nameLocale.ja 文字列 日本語で表示したときの施設グループ名
nameLocale.en 文字列 英語で表示したときの施設グループ名
nameLocale.zh 文字列 簡体字で表示したときの施設グループ名
nameLocale.zh-tw 文字列 繁体字で表示したときの施設グループ名
code 文字列 施設コード
notes 文字列 メモ
parentFacilityGroup 数値 親施設グループID
レスポンスの例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

{
  "id": 1,
  "name": "Tokyo",
  "nameLocale": {
    "ja": "東京",
    "en": "Tokyo",
    "zh": "東京",
    "zh-tw": "东京"
  },
  "code": "tokyo_office",
  "notes": "This is note",
  "parentFacilityGroup": 2
}

サンプルコード

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

curlを使ったリクエスト
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

curl -X PATCH 'https://sample.cybozu.com/g/api/v1/schedule/admin/facilityGroups/1' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Tokyo",
    "nameLocale": {
      "ja": "東京",
      "en": "Tokyo",
      "zh": "東京",
      "zh-tw": "东京"
    },
    "code": "tokyo_office",
    "notes": "This is note",
    "parentFacilityGroup": 2
  }
Garoon REST APIリクエストを送信するAPI を使ったリクエスト
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

const body = {
  name: 'Tokyo',
  nameLocale: {
    ja: '東京',
    en: 'Tokyo',
    zh: '東京',
    'zh-tw': '东京'
  },
  code: 'tokyo_office',
  notes: 'This is note',
  parentFacilityGroup: 2
};

await garoon.api('/api/v1/schedule/admin/facilityGroups/1', 'PATCH', body);