2020/11/08の定期メンテナンスにおける Garoon API 更新情報 (2020/10/09)

2020年11月08日の定期メンテナンスの、Garoon API に関する情報をお知らせします。
お知らせの内容に追加、変更等ありましたら、こちらのコメント欄で変更箇所を追記します。
また、API ドキュメントは仕様を順次公開していきます。

kintone API

API 関連のアップデートはありません。
kintone の主なアップデート全般については、アップデート情報のページを参照してください。11月定期メンテナンス分は後日公開されます。

Garoon API

Garoon JavaScript API

機能追加

• メッセージの「下書きの編集/送信」画面で、メッセージの値をセットする API を利用できる
  • 対象 API
    • メッセージの値をセットする　garoon.message.body.set()
• メッセージの「下書きの編集/送信」画面を表示したとき、「メッセージの作成画面が表示されたときのイベント」を利用できる
  
  • 対象 API
    • メッセージの作成画面が表示されたときのイベント　message.body.create.show
  • 備考
    • event オブジェクトに「下書きの編集/送信」画面か判定する draft プロパティが追加されます。

仕様変更

先行情報でお知らせしている内容です。
2020年11月の定期メンテナンスで、予定の登録時に選択できる「公開方法」のうち「公開先を設定する」を廃止するため、下記の仕様変更が入ります。

• 対象 API でスケジュールオブジェクトの visibilityType に SET_PRIVATE_WATCHERS を指定するとエラーとなり、予定の登録または更新ができなくなる
  • 対象 API
    • 予定の登録画面が表示されたときのイベント schedule.event.create.show
    • 予定の登録画面の保存実行前イベント schedule.event.create.submit
    • 予定の変更画面が表示されたときのイベント schedule.event.edit.show
    • 予定の変更画面の保存実行前イベント schedule.event.edit.submit
    • 予定の詳細画面が表示されたときのイベント schedule.event.detail.show
    • 予定の値を取得する garoon.schedule.event.get()
• 対象 API で「公開方法」に「公開先を設定する」を指定した予定を操作したとき、スケジュールオブジェクトの visibilityType の値が PRIVATE になる
  • 対象 API
    • 予定の登録画面が表示されたときのイベント schedule.event.create.show
    • 予定の登録画面の保存実行前イベント schedule.event.create.submit
    • 予定の変更画面が表示されたときのイベント schedule.event.edit.show
    • 予定の変更画面の保存実行前イベント schedule.event.edit.submit
    • 予定の詳細画面が表示されたときのイベント schedule.event.detail.show
    • 予定の値を取得する garoon.schedule.event.get()
  • 内容：
    「公開方法」に「公開先を設定する」を指定した予定について、スケジュールオブジェクトの visibilityType の値が
    
    • 修正前：SET_PRIVATE_WATCHERS が返却される
    • 修正後：PRIVATE が返却される

Garoon REST API

仕様変更

先行情報でお知らせしている内容です。
2020年11月の定期メンテナンスで、予定の登録時に選択できる「公開方法（visibilityType）」のうち「公開先を設定する」を廃止するため、下記の仕様変更が入ります。

• 対象 API でスケジュールオブジェクトの visibilityType に SET_PRIVATE_WATCHERS を指定するとエラーとなり、予定の登録または更新ができなくなる
  • 対象 API
    • 予定の登録（POST） /g/api/v1/schedule/events
    • 予定の更新（PATCH） /g/api/v1/schedule/events/{id}
      
• 「公開方法」の値がいかなる場合でも、対象 API で watchers プロパティを指定できる
  • 対象 API
    • 予定の登録（POST） /g/api/v1/schedule/events
    • 予定の更新（PATCH） /g/api/v1/schedule/events/{id}
• 対象 API で、「公開方法」に「公開先を設定する」を指定した予定を取得したとき、スケジュールオブジェクトの visibilityType の値が PRIVATE になる
  • 対象 API
    • 予定の登録（POST） /g/api/v1/schedule/events
    • 予定の更新（PATCH） /g/api/v1/schedule/events/{id}
      
  • 内容：
    「公開方法」に「公開先を設定する」を指定した予定について、スケジュールオブジェクトの visibilityType の値が
    • 修正前：SET_PRIVATE_WATCHERS で返却される
    • 修正後：PRIVATE で返却される
• 対象 API で共有先を設定した予定を取得したとき、 「公開方法」の値がいかなる場合でも watchers プロパティを取得できる
  • 対象 API
    • 予定の取得（1件） /g/api/v1/schedule/events/{id}
    • 予定の一覧取得（クエリで条件を指定） /g/api/v1/schedule/events
  • 備考
    • API を実行したユーザーが参加または共有されていない非公開の予定は、従来どおり 404 エラーとなり取得できません。

Garoon SOAP API

仕様変更

先行情報でお知らせしている内容です。
2020年11月の定期メンテナンスで、予定の登録時に選択できる「公開方法（@public_type）」のうち「公開先を設定する」を廃止するため、下記の仕様変更が入ります。

• 対象 API で schedule:EventType の @public_type に qualified を指定するとエラーとなり、予定の登録または更新ができなくなる
  
  • 対象 API
    • 予定を登録する ScheduleAddEvents
    • 予定を変更する ScheduleModifyEvents
    • 繰り返し予定を変更する ScheduleModifyRepeatEvents
• 「公開方法」の値がいかなる場合でも、対象 API で observers プロパティを指定できる
  
  • 対象 API
    • 予定を登録する ScheduleAddEvents
    • 予定を変更する ScheduleModifyEvents
    • 繰り返し予定を変更する ScheduleModifyRepeatEvents
• 対象 API で「公開方法」に「公開先を設定する」を指定した予定を操作したとき、schedule:EventType の @public_type の値が private になる
  
  • 対象 API
    • 予定に参加する ScheduleParticipateEvents
    • 予定から抜ける ScheduleLeaveEvents
    • 予定を検索する ScheduleSearchEvents
    • 繰り返し予定に参加する ScheduleParticipateEventsToRepeatEvent
    • 繰り返し予定から抜ける ScheduleLeaveEventsFromRepeatEvent
    • 仮予定を確定する ScheduleDetermineTemporaryEvents
    • 予定にコメントを追加する ScheduleAddFollows
    • 繰り返し予定にコメントを追加する ScheduleAddFollowsToRepeatEvent
    • 指定した期間の予定を取得する ScheduleGetEvents
    • 指定した ID の予定を取得する ScheduleGetEventsById
    • 指定したユーザー、組織、または施設の予定を取得する ScheduleGetEventsByTarget
    • 予定を登録する ScheduleAddEvents
    • 予定を変更する ScheduleModifyEvents
    • 繰り返し予定を変更する ScheduleModifyRepeatEvents
    • 予定に参加する ScheduleParticipateEvents
    • 予定から抜ける ScheduleLeaveEvents
    • 繰り返し予定に参加する ScheduleParticipateEventsToRepeatEvent
    • 繰り返し予定から抜ける ScheduleLeaveEventsFromRepeatEvent
    • 仮予定を確定する ScheduleDetermineTemporaryEvents
    • 予定にコメントを追加する ScheduleAddFollows
    • 繰り返し予定にコメントを追加する ScheduleAddFollowsToRepeatEvent
  • 内容：
    「公開方法」に「公開先を設定する」を指定した予定について、schedule:EventType の @public_type の値が
    • 修正前：qualified で返却される
    • 修正後：private で返却される
• 対象 API で共有先を設定した予定を操作したとき、「公開方法」に設定した値がいかなる場合でも observers プロパティを取得できる
  
  • 対象 API
    • 予定に参加する ScheduleParticipateEvents
    • 予定から抜ける ScheduleLeaveEvents
    • 予定を検索する ScheduleSearchEvents
    • 繰り返し予定に参加する ScheduleParticipateEventsToRepeatEvent
    • 繰り返し予定から抜ける ScheduleLeaveEventsFromRepeatEvent
    • 仮予定を確定する ScheduleDetermineTemporaryEvents
    • 予定にコメントを追加する ScheduleAddFollows
    • 繰り返し予定にコメントを追加する ScheduleAddFollowsToRepeatEvent
    • 指定した期間の予定を取得する ScheduleGetEvents
    • 指定した ID の予定を取得する ScheduleGetEventsById
    • 指定したユーザー、組織、または施設の予定を取得する ScheduleGetEventsByTarget
    • 予定を登録する ScheduleAddEvents
    • 予定を変更する ScheduleModifyEvents
    • 繰り返し予定を変更する ScheduleModifyRepeatEvents
    • 予定に参加する ScheduleParticipateEvents
    • 予定から抜ける ScheduleLeaveEvents
    • 繰り返し予定に参加する ScheduleParticipateEventsToRepeatEvent
    • 繰り返し予定から抜ける ScheduleLeaveEventsFromRepeatEvent
    • 仮予定を確定する ScheduleDetermineTemporaryEvents
    • 予定にコメントを追加する ScheduleAddFollows
    • 繰り返し予定にコメントを追加する ScheduleAddFollowsToRepeatEvent
  •  備考
    • API を実行したユーザーが参加または共有されていない非公開の予定は、従来どおり 404 エラーとなり取得できません。
• 対象 API で予定を登録した場合、予定を共有されたユーザーへ通知される予定タイトルの先頭に「[共有]」が付与される
  • 対象 API
    • 通知を取得する NotificationGetNotificationsById
    • 確認済み通知を取得する NotificationGetNotificationHistoriesById
    • 通知を確認済みにする NotificationConfirmNotification
  • 備考
    「[共有]」が付与される通知は、次のいずれかの条件に当てはまる場合です。
    
    • 予定の共有先にのみ「ログインユーザー」「所属組織」「所属ロール」が指定されている
    • 出欠確認で欠席を選択していて、予定の共有先に「ログインユーザー」「所属組織」「所属ロール」が指定されている

※ ページ上部の「API 更新情報のお知らせをメールで受け取る」ボタンから、毎月の API 更新情報をメールで受け取ることができます。