管理者による施設の更新
施設情報を更新します。
この API を実行するには、管理者権限が必要です。詳細は
必要なアクセス権 を参照してください。
URL
クラウド版
https://sample.cybozu.com/g/api/v1/schedule/admin/facilities/施設 ID
パッケージ版
- Windows 環境
- http://
サーバーの IP アドレスまたはホスト名
/scripts/インストール識別子
/grn.exe/api/v1/schedule/admin/facilities/施設 ID
- Linux 環境
- http://
サーバーの IP アドレスまたはホスト名
/cgi-bin/インストール識別子
/grn.cgi/api/v1/schedule/admin/facilities/施設 ID
HTTP メソッド
PATCH
パスパラメーター
パラメーター名 |
説明 |
施設 ID |
更新する施設の施設 ID |
利用できるバージョン
- クラウド版 Garoon
- パッケージ版 Garoon 5.15 以降
必要なアクセス権
次のいずれかの権限が必要です。
- Garoon のシステム管理者権限
- 予定のアプリケーション管理者権限
リクエスト
パラメーター
パラメーター名 |
型 |
必須 |
説明 |
name |
文字列 |
必須 |
施設名 |
nameLocale.ja |
文字列 |
省略可 |
日本語で表示したときの施設名 |
nameLocale.en |
文字列 |
省略可 |
英語で表示したときの施設名 |
nameLocale.zh |
文字列 |
省略可 |
簡体字で表示したときの施設名 |
nameLocale.zh-tw |
文字列 |
省略可 |
繁体字で表示したときの施設名 |
code |
文字列 |
必須 |
施設コード |
notes |
文字列 |
省略可 |
メモ |
facilityGroup |
数値 |
省略可 |
施設グループ ID |
リクエストの例
URL
https://sample.cybozu.com/g/api/v1/schedule/admin/facilities/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": "Library",
"nameLocale": {
"ja": "会議室A",
"en": "Meeting room A",
"zh": "会议室A",
"zh-tw": "會議室A"
},
"code": "meeting_room_a",
"notes": "This is note",
"facilityGroup": 1
}
|
レスポンスの例
プロパティ
プロパティ名 |
型 |
説明 |
id |
数値 |
施設 ID |
name |
文字列 |
施設名 |
nameLocale |
オブジェクト |
言語ごとに設定した施設の表示名 |
nameLocale.ja |
文字列 |
日本語で表示したときの施設名 |
nameLocale.en |
文字列 |
英語で表示したときの施設名 |
nameLocale.zh |
文字列 |
簡体字で表示したときの施設名 |
nameLocale.zh-tw |
文字列 |
繁体字で表示したときの施設名 |
code |
文字列 |
施設コード |
notes |
文字列 |
メモ |
facilityGroup |
数値 |
施設グループ ID |
リクエストの例
1
2
3
4
5
6
7
8
9
10
11
12
13
|
{
"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
}
|
サンプルコード
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/facilities/1' \
-H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
-H 'Content-Type: application/json' \
-d '{
"name": "Library",
"nameLocale": {
"ja": "会議室A",
"en": "Meeting room A",
"zh": "会议室A",
"zh-tw": "會議室A"
},
"code": "meeting_room_a",
"notes": "This is note",
"facilityGroup": 1
}'
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
|
const body = {
name: 'Library',
nameLocale: {
ja: '会議室A',
en: 'Meeting room A',
zh: '会议室A',
'zh-tw': '會議室A'
},
code: 'meeting_room_a',
notes: 'This is note',
facilityGroup: 1
};
await garoon.api('/api/v1/schedule/admin/facilities/1', 'PATCH', body);
|