SmartREST テンプレート

SmartREST テンプレートとは、CSVデータと Things Cloud REST APIコールを変換するために使用されるリクエストテンプレートとレスポンステンプレートのコレクションです。 例えば、SmartRESTテンプレートを使用することで、毎回手動でリクエストを作成するのではなく、デバイスをプラットフォームに簡単に追加できます。

デバイス統合を容易にするために、Things Cloud は独自のテンプレートを作成することなく使用できる静的テンプレートをサポートしています。 これらのテンプレートは、デバイス管理で最もよく使用されるメッセージにのみ焦点を当てています。静的テンプレートの詳細については、MQTT静的テンプレート を参照してください。

関連情報

ナビゲータの デバイスタイプ メニューから SmartREST テンプレート 画面を開きます。

SmartREST テンプレートテンプレートビュー

各テンプレートには、次の情報が提供されます。

  • テンプレート名
  • テンプレートID
  • 送信メッセージ数
  • レスポンス数

SmartREST テンプレートを追加するには、次の2つの方法があります。

  • 既存のテンプレートをインポートする
  • 新しいテンプレートを作成する

既存の SmartREST テンプレートのインポート

  1. トップメニューバーの右側にある テンプレートのインポート をクリックします。
  2. 表示されるダイアログボックスで、アップロードするファイルを参照して選択します。
  3. テンプレート名と一意のテンプレートID（両方必須）を入力します。
  4. インポート をクリックして、テンプレートをインポートします。

新規 SmartREST テンプレートの作成

  1. トップメニューバーの右側にある SmartREST テンプレートを追加 をクリックします。
  2. 表示されるダイアログボックスで、テンプレート名と一意のテンプレート ID（両方必須）を入力します。
  3. 次へ をクリックして、メッセージやレスポンスの追加を継続します。

メッセージの追加

メッセージテンプレートには、SmartREST リクエストを対応する REST API コールに変換するために必要なすべての情報が含まれています。このコールはプラットフォームに送信されます。

  1. 新しいメッセージを追加するには、目的の SmartREST テンプレートの メッセージ タブに移動し、メッセージを追加 をクリックします。

  2. 次のフィールドを入力します。

    フィールド 説明
    メッセージID メッセージ識別子として使用される一意の値。テンプレートの中ですべてのメッセージとレスポンスが一意である必要があります
    名前 メッセージの名前。必須
    対象の REST API ドロップダウンリストより選択。次のいずれかになります：メジャーメント、インベントリ、アラーム、イベント、オペレーション
    方法 リクエストメソッド。選択した対象のREST APIに応じて、POST、PUT、GETのいずれかになります
    レスポンスを含む リクエストの結果をレスポンステンプレートで処理する場合、このチェックボックスを選択します
    REST API組み込みフィールド これらのフィールドは任意で、選択した対象 REST API によって異なります。値を設定しない場合、デバイスは実際のメッセージを送信する際に設定できます
    REST APIカスタムフィールド フィールドを追加 をクリックして、新しくフィールドを追加できます。API キーを入力し、目的のデータ型を選択します

    メッセージを追加

    下の プレビュー に、リクエストメッセージのプレビューが表示されます。

  3. 保存をクリックします。

メッセージは SmartREST テンプレートに追加されます。

メッセージの削除

メッセージを削除するには、メッセージを開き、下部にある 削除 をクリックします。

メッセージは SmartREST テンプレートから削除されます。

レスポンスの追加

レスポンステンプレートには、プラットフォーム REST API コールのレスポンスからデータ値を抽出するために必要な情報が含まれており、そのデータ値は CSV データ形式でクライアントに送り返されます。

  1. 新しいレスポンスを追加するには、目的の SmartREST テンプレートの レスポンス タブに移動し、レスポンスを追加 をクリックします。
  2. 次のフィールドを入力します。
フィールド 説明
レスポンスID レスポンス識別子として使用される一意の文字列
ベースパターン JSON ドキュメント内のパス。ベースパターンはすべてのパターンのプレフィックスとして機能します。 ここにベースパターンを入力し、ベースパターンの下にサブパスのみのパターンを追加するか、このフィールドを空のままにして、完全なパスを持つパターンを指定できます
条件 レスポンスの条件値
パターン 少なくとも 1 つのパターンが必要です。パターンを追加をクリックし、パターン値を入力します

レスポンスを入力したテンプレートを追加

  1. 保存 をクリックします。

レスポンスは SmartREST テンプレートに追加されます。

詳細については、レスポンステンプレート を参照してください。

レスポンスの削除

レスポンスを削除するには、レスポンスを開き、下部にある 削除 をクリックします。

SmartREST テンプレートの編集

目的のテンプレートをクリックするか、各テンプレートカードの右上にあるメニューアイコン をクリックし 編集 をクリックします。

テンプレートを編集した後、保存 をクリックして設定を保存します。

SmartREST テンプレートの削除

各テンプレートカードの右上にあるメニューアイコン をクリックして、削除 をクリックします。

SmartREST テンプレートのエクスポート

各テンプレートカードの右上にあるメニューアイコン をクリックして、エクスポート をクリックします。

テンプレートは、自動的にファイルシステムにダウンロードされます。

SmartREST テンプレートを CSV ファイルとしてエクスポートするには、次の手順に従います。

  1. エクスポートしたいテンプレートを開き、CSV プレビュー タブを選択します。
  2. 表示されるダイアログボックスで、フィールド区切り記号、小数点区切り記号、文字セットの優先オプションを指定します。
  3. メッセージとレスポンスに関する追加情報が表示される CSV プレビュー タブで、クリップボードにコピー をクリックします。

SmartREST テンプレートは CSV ファイルとしてエクスポートされます。