予定の更新（PATCH） – cybozu developer network

Index

予定の更新（1件）
制限事項

予定の更新（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	真偽値	条件必須	開始のみの予定かどうか ※ 省略した場合のデフォルト値は false です。 ※ end を省略する場合は、isStartOnly の値に true を指定してください。
attendees	配列	条件必須	参加者のリスト ※ attendees（参加者）または facilities（施設）のいずれかが必須です。
attendees[].type			参加者のタイプ次のいずれかの値を指定します。 ORGANIZATION USER ※ attendees を指定する場合、必須です。
attendees[].id	文字列	条件必須	attendees[].type に指定する値により異なります。「ORGANIZATION」の場合：組織 ID 「USER」の場合：Garoon ユーザー ID ※ attendees を指定する場合、id または code が必須です。
attendees[].code	文字列	条件必須	attendees[].type に指定する値により異なります。「ORGANIZATION」の場合：組織コード「USER」の場合：Garoon ユーザー名（ログイン名） ※ attendees を指定する場合、id または code が必須です。 ※ id と code を指定すると、id の値が優先されます。
facilities	配列	条件必須	施設のリスト ※ attendees（参加者）または facilities（施設）のいずれかが必須です。
facilities[].id	文字列	条件必須	施設名ID ※ facilities を指定する場合、id または code が必須です。
facilities[].code	文字列	条件必須	施設の候補リストの施設コード ※ facilities を指定する場合、id または code が必須です。 ※ id と code を指定すると、id の値が優先されます。
facilityUsingPurpose	文字列	条件必須	施設の利用目的 ※「施設の利用申請」を有効にした場合、必須です。
companyInfo	オブジェクト	省略可	会社情報
companyInfo.name	文字列	省略可	会社名
companyInfo.zipCode	文字列	省略可	郵便番号
companyInfo.address	文字列	省略可	住所
companyInfo.route	文字列	省略可	路線の経路
companyInfo.routeTime	文字列	省略可	路線の所要時間
companyInfo.routeFare	文字列	省略可	路線の運賃
companyInfo.phone	文字列	省略可	電話番号
visibilityType	文字列	省略可	公開設定のタイプ次のいずれかの値を指定します。 PUBLIC PRIVATE SET_PRIVATE_WATCHERS
useAttendanceCheck	真偽値	省略可	出欠確認を使用しているかどうかシステム設定で「出欠確認の使用」の許可が必要です。
watchers	配列	条件必須	公開先のリスト ※ visibilityTypeがSET_PRIVATE_WATCHERSの場合、必須です。
watchers[].type	文字列	条件必須	公開先のタイプ次のいずれかの値を指定します。 ORGANIZATION USER ROLE ※ watches を指定する場合、必須です。
watchers[].id	文字列	条件必須	watchers[].type に指定した値により異なります。「ORGANIZATION」の場合：組織ID 「USER」の場合：Garoon ユーザーID 「ROLE」の場合：ロールID ※ watches を指定する場合、id または code が必須です。
watchers[].code	文字列	条件必須	watchers[].type に指定した値により異なります。「ORGANIZATION」の場合：組織コード「USER」の場合：Garoon ユーザー名（ログイン名）「ROLE」の場合：ロール名 ※ watches を指定する場合、id または code が必須です。 ※ id と code を指定すると、id の値が優先されます。
additionalItems	オブジェクト	省略可	予定のAPI用連携項目
additionalItems.item.value	文字列	省略可	予定のAPI用連携項目の値

レスポンスの例

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

制限事項

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