2023-03-29 データハブ「カスタムフォーマット」の追加とWeb API一部変更
データハブの出力フォーマットに「カスタムフォーマット」が利用できるようになりました。また、本機能追加に伴い一部Web APIの仕様を変更しました。
カスタムフォーマット機能
カスタムフォーマットは、データハブが出力するHTTPペイロードをお客様で任意に設定できる機能です。
従来は出力フォーマットの「未加工」を選択してデバイスで前もってデータを加工しておくか、「JSON形式」を選択してデータハブの受信先でデータを加工する必要があり、お客様にてデータ加工の仕組みをご用意していただく必要がありました。今回追加された「カスタムフォーマット」は、お客様が決めた任意の形式にIoTプラットフォームにて変換・加工できるようになりました。
カスタムフォーマットのご利用方法や詳細は、以下のページをご覧ください。
Web API 仕様変更
カスタムフォーマット機能の提供に伴い、Web API のデータハブ設定 (GET /datahubs, POST /datahubs など) の仕様を一部変更しました。
従来、出力フォーマットを「未加工」と「JSON形式」を切替えるための「jsonFormat」プロパティをそれぞれ「false」「true」で設定する方式を採用していました。今回、カスタムフォーマットを設定できるようにするため「outputFormatType」プロパティを新たに追加し、「raw」「json」「custom」で設定を切り替えられるように変更しました。
| 出力フォーマット | 変更前 | 変更後 |
|---|---|---|
| 未加工 | jsonFormat: false | outputFormatType: "raw" |
| JSON形式 | jsonFormat: true | outputFormatType: "json" |
| カスタムフォーマット | 未実装 | outputFormatType: "custom" |
現在ご利用中の方は「outputFormatType」への移行をお願いします。
「jsonFormat」プロパティは、2023年6月7日以降、レスポンスからプロパティが削除され利用できなくなります。
詳細は、以下の API ドキュメントをご覧ください。