カテゴリー内の他の記事

予定の更新(PATCH)

フォローする

Index

予定の更新(1件)

予定IDを指定して予定の内容を更新できます。

  • 繰り返し予定の場合、元の予定を更新します。
  • 仮予定は更新できません。

HTTP メソッド

PATCH

URI

クラウド版

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

パッケージ版(Windows環境)

http://(サーバーのIPアドレスまたはホスト名)/scripts/(インストール識別子)/grn.exe/api/v1/schedule/events/{id}

パッケージ版(Linux環境)

http://(サーバーのIPアドレスまたはホスト名)/cgi-bin/(インストール識別子)/grn.cgi/api/v1/schedule/events/{id}

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

  • クラウド版 Garoon
  • パッケージ版 Garoon バージョン 4.10.0以降

必要なアクセス権

予定の変更権限

リクエストの例

リクエストヘッダ

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

リクエストボディ

※各フィールドの形式については スケジュールのeventオブジェクトをご確認ください。

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

予定メニュー

予定メニューのデフォルト設定値「-----」のvalueは空文字列とみなされます。詳細

subject 文字列 タイトル
notes 文字列

メモ


改行文字は「\n」です。

start オブジェクト

開始日時とタイムゾーン

start.dateTime

文字列

予定の開始日時

形式はRFC3339です。

start.timeZone

文字列

開始日時のタイムゾーン

end オブジェクト

終了日時とタイムゾーン

次にあてはまる場合、必須です。

  • isStartOnlyがfalse(または指定されていない)の場合
  • facilitiesが指定されている場合
  • eventTypeがALL_DAYの場合
end.dateTime 文字列

予定の終了日時

形式はRFC3339です。

end.timeZone 文字列 終了日時のタイムゾーン
isAllDay 真偽値 終日の予定かどうか
isStartOnly 真偽値 開始のみの予定かどうか
attendees 配列

参加者のリスト

①type ②codeまたはid が必須です。

attendees[].id 文字列 参加者のユーザーID
attendees[].code 文字列 attendees[].type プロパティのvalueにより異なります。
  • 「ORGANIZATION」 の場合:組織コード
  • 「USER」 の場合:ログイン名
attendees[].type 文字列

参加者のタイプ

利用可能なvalueは次のとおりです。 

  • ORGANIZATION
  • USER
facilities 配列

施設のリスト

codeまたはid が必須です。

facilities[].id 文字列 施設名ID
facilities[].code 文字列

施設の候補リストの施設コード

facilityUsingPurpose 文字列

施設の利用目的

「施設の利用申請」を有効にした場合、必須です。

companyInfo オブジェクト 会社情報
companyInfo.name 文字列 会社名
companyInfo.zipCode 文字列 郵便番号
companyInfo.address 文字列 住所
companyInfo.route 文字列 路線の経路
companyInfo.routeTime 文字列 路線の所要時間
companyInfo.routeFare 文字列 路線の運賃
companyInfo.phone 文字列 電話番号
visibilityType 文字列

公開設定のタイプ

利用可能なvalueは次のとおりです。 

  • PUBLIC
  • PRIVATE
  • SET_PRIVATE_WATCHERS
useAttendanceCheck 真偽値

出欠確認を使用しているかどうか

システム設定で「出欠確認の使用」の許可が必要です。

watchers 配列

公開先のリスト

visibilityTypeがSET_PRIVATE_WATCHERSの場合、必須です。
①type ②codeまたはid が必須です。

watchers[].id 文字列 公開先のユーザーID
watchers[].code 文字列

watchers[].type プロパティのvalueにより異なります。

  • 「ORGANIZATION」 の場合:組織コード
  • 「USER」 の場合:ログイン名
  • 「ROLE」の場合:ロール名
watchers[].type 文字列

公開先のタイプ

利用可能なvalueは次のとおりです。 

  • ORGANIZATION
  • USER
  • ROLE
additionalItems オブジェクト 予定のAPI用連携項目
additionalItems.item.value 文字列  予定のAPI用連携項目の値

 

レスポンスの例

処理が成功すると、予定の内容がJSON形式で返されます。※各フィールドの形式については スケジュールのeventオブジェクトをご確認ください。

制限事項

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

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

直接的に記事と関連がないご質問はcybozu developer コミュニティをご活用ください。

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