カスタムフォーマット機能は、データハブやクラウドアダプタで転送するペイロードをお客様にて指定できるようにする機能です。

カスタムフォーマットはIoTサービス独自の記法を用いることで、デバイスから受け取ったデータ (文字列) を置換できます。これによりお客様にて独自のHTTPリクエストを作成できるようになり、直接APIサーバにデータを転送できるようになります。

※ 現在、データハブとクラウドアダプタに対応しています。今後、データストレージでもカスタムフォーマットを使用できるようになる予定です。

利用方法

1. コントロールパネルやWeb APIにてデータハブやクラウドアダプタの設定を作成します。
   • コントロールパネルの使用方法は データハブ画面やクラウドアダプタ画面をご覧頂き、画面の指示に従って設定してください。
2. 作成したデータハブやクラウドアダプタの設定にカスタムフォーマットを設定します。
   • コントロールパネルでは、出力フォーマットで「カスタム」を選択します。
   • Web APIでは、outputFormatTypeに「custom」を指定します (データハブのみ)。
   • カスタムフォーマットの記法は下記を参照してください。
3. その後はデータハブやクラウドアダプタの利用方法と同じです。
   • デバイスからGateway APIに送信し、データハブやクラウドアダプタの動作を確認してください。

カスタムフォーマットを使用する場合、デバイスからGateway APIへデータを送信する時に必ず「テキストデータ」で送信してください。 「バイナリデータ」で送信した場合、カスタムフォーマット機能は動作せず、バイナリデータが変換されずそのままの形式で転送先に送信されます。

カスタムフォーマットの記法と利用可能なパラメータの一覧

カスタムフォーマット記法とパラメータ一覧 をご覧頂き、設定してください。