カテゴリー内の他の記事

管理者による施設の更新(PATCH)

Index

管理者による施設の更新

管理者権限で、指定した施設 ID の施設の情報を更新できます。

HTTP メソッド

PATCH

URI

クラウド版

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

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

  • クラウド版 Garoon

必要なアクセス権

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

リクエストパラメータ

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

必須

施設グループの ID

リクエストの例 

PATCH /g/api/v1/schedule/admin/facilities/1
Host: {subdomain}.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json
  • Content-Type に application/json を指定して下さい。 指定しない場合は JSON が解釈できないため、実行時エラーとなります。

リクエストボディ

パラメータ名 指定する値 必須 説明
name 文字列 必須

施設名

nameLocale.ja 文字列 省略可 日本語で表示したときの施設名
nameLocale.en 文字列 省略可 英語で表示したときの施設名
nameLocale.zh 文字列 省略可 簡体字で表示したときの施設名
nameLocale.zh-tw 文字列 省略可 繁体字で表示したときの施設名
code 文字列 必須 施設コード
notes 文字列 省略可 メモ
facilityGroup 数値 省略可 施設グループの ID

レスポンスの例

処理が成功すると、更新された施設の情報が JSON 形式で返されます。 

レスポンスのプロパティ

プロパティ名 説明
id 数値 施設 ID
name 文字列  施設名
nameLocale オブジェクト 言語ごとに設定した施設の表示名
nameLocale.ja 文字列  日本語で表示したときの施設名
nameLocale.en 文字列  英語で表示したときの施設名
nameLocale.zh 文字列  簡体字で表示したときの施設名
nameLocale.zh-tw 文字列  繁体字で表示したときの施設名
code 文字列  施設コード
notes 文字列  メモ
facilityGroup 数値 施設グループの ID

JavaScript サンプル

Garoon REST API

XMLHttpRequest

制限事項

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

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

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

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