Heartbeat API v2 移行ガイド

2018 年 4 月 2 日以降、Heartbeat API v1 にアクセスできなくなります。このドキュメントは、新しい Heartbeat API へ移行するのをサポートすることを目的としています。

Heartbeat 追加リクエスト

• 現在、ペイロード フィールド "interval"、"intervalUnit"、"enabled" は、必須フィールドです。"description" フィールドはオプションのままです。

• コンテンツ タイプのヘッダーは「application/json」として提供される必要があります。

• 応答の変更については、新しいハートビート API ドキュメントをご査収ください。

Heartbeat 取得クエスト

• 以前のバージョンの [name(名前)] フィールドが、URL パス変数として指定されます。リクエスト URL とその応答については、新しいハートビート API ドキュメントをご参照ください。
  
  

ハートビート更新リクエスト

• 更新リクエストの HTTP メソッドが POST から PATCH に変更されました。

• コンテンツ タイプのヘッダーは「application/json」として提供される必要があります。

• 以前のバージョンの [name (名前)] フィールドが、URL パス変数として指定されます。リクエスト URL と対応については、新しいハートビート API ドキュメントをご参照ください。

ハートビート削除リクエスト

• 以前のバージョンの [name (名前)] フィールドが、URL パス変数として指定されます。リクエスト URL と対応については、新しいハートビート API ドキュメントをご参照ください。

Heartbeat リクエストを有効/無効化する

• これらのリクエストで使用される HTTP メソッドは、POST に加えて PUT と PATCH をサポートするようになりました。

• 以前のバージョンの [name (名前)] フィールドが、URL パス変数として指定されます。リクエスト URL と対応については、新しいハートビート API ドキュメントをご参照ください。

ハートビート送信リクエスト (新規バージョンではハートビート Ping 送信)

• 現在、以前のバージョンのハートビート送信リクエストは、ハートビート Ping 送信と呼ばれます。この変更は、このリクエストの URL にも適用されます。

• このリクエストで使用される HTTP メソッドは、POST に加えて GET、PUT、PATCH をサポートするようになりました。

• この要求は非同期的に処理されるため、問題が発生した場合は、手動でログをチェックする必要があります。

• 以前のバージョンの [name (名前)] フィールドが、URL パス変数として指定されます。リクエスト URL と対応については、新しいハートビート API ドキュメントをご参照ください。

Heartbeat リクエストをリストする

• Heartbeat API v2では、ハートビート リクエストのリストはサポートされていません。