製品データ API は、製品に関連付けられたデバイスのスナップショットデータ API、生データ API、およびイベントデータ API を網羅しています。特定の製品データ API が確立されると、製品内の特定のデバイスの生データ、スナップショットデータ、またはイベントデータを取得できます。このトピックでは、製品データ API を作成および編集する手順の概要を説明します。
前提条件
製品データ API の作成
製品データ API は、過去 30 日間のデータのクエリに限定されています。
IoT Platform コンソール で、[概要] をクリックします。[概要] タブで、管理するインスタンスを見つけ、インスタンス [ID] またはインスタンス名をクリックします。
左側のナビゲーションウィンドウを使用して、[DataService Studio] > [データ API] に移動します。
[製品データ API] タブをシングルクリックし、次に [API の作成] をシングルクリックします。
[API の作成] パネルで、ターゲット製品の横にあるチェックボックスをオンにします。
[適用] をシングルクリックします。
製品データ API リストが更新され、選択した製品のスナップショットデータと生データの API が含まれます。
パラメーター
スナップショットデータ API
生データ API
イベントデータ API
API 名
${productName} Product Snapshot Data Query${productName} Product Raw Data Query${productName} Product Event Data QueryAPI パス
/${productKey}/snapshot/data/get/${productKey}/rawdata/get/${productKey}/event/data/get${productName}は製品名を表し、${productKey}は製品の一意の識別子です。
製品データ API の編集
スナップショットデータクエリ API と生データクエリ API については、API 名、入力パラメーター、およびレスポンスパラメーターを変更できます。
[データ API] ページに移動し、[製品データ API] タブをシングルクリックします。
API リストで目的の製品のスナップショットデータクエリ API または生データクエリ API を見つけ、対応する列の [操作]、次に [編集] をシングルクリックします。
[API の編集] 構成ウィザードで、[API の基本情報] を更新し、[次へ] をシングルクリックします。
パラメーター
説明
API 名
API 名を変更します。漢字、英字、数字、アンダースコア (_)、およびハイフン (-) を使用でき、長さは最大 30 文字です。
API パス
このフィールドは変更できません。
API タグ
タグコンテンツを入力し、Enter キーを押してタグを作成します。漢字、英字、数字、アンダースコア (_)、およびハイフン (-) を使用でき、最大長は 30 文字です。タグを使用すると、柔軟な API 管理のためにカスタム ID を作成できます。
漢字、英字、数字、アンダースコア (_)、およびハイフン (-) を使用でき、最大長は 30 文字です。
タグ機能を使用して API にカスタム ID を割り当て、柔軟な管理を可能にします。
重要1 つの API に割り当てられるタグは最大 5 つです。
API の説明
API の説明を記述し、その機能やその他の関連情報を詳しく説明します。
戻り値の型
API 呼び出し後に返されるデータの形式は JSON に固定されています。
[パラメーターの設定とテスト] ページで、必要に応じて構成パラメーターと詳細設定を調整します。
カテゴリ
構成項目
説明
構成パラメーター
リクエストパラメーター
[パラメーターの追加] をクリックし、含める [フィールドの添付] を選択します。追加されたパラメーターでは、演算子、必須ステータス、値の例、および説明を設定できます。
追加されたパラメーターでは、演算子の構成、必須性の指定、値の例の提供、詳細な説明を含めることができます。
削除
アイコンをクリックしてパラメーターを削除します。
重要数値パラメータータイプは、
LIKE演算子をサポートしていません。レスポンスパラメーター
デフォルトでは、API によって返されるすべてのフィールドが選択されています。ソートに使用するかどうかを決定し、値の例を提供し、説明を追加できます。
パラメーターを削除するには、削除
アイコンをクリックします。削除したパラメーターを再度追加するには、[パラメーターの追加] をクリックするか、[すべてのパラメーターを選択] チェックボックスを使用してすべてのフィールドをレスポンスパラメーターとして再選択します。説明[ソートに使用] オプションを使用すると、クエリ結果を返す前に、フィールドの値に基づいて昇順または降順に並べ替えることができます。
ソート順
パラメーターのソート順序を選択します。
[昇順] (デフォルト) を選択すると、パラメーターが昇順に配置されます。
[降順] を選択すると、パラメーターが降順に配置されます。
詳細設定
結果のページングを有効にする
返された結果をページ分割するかどうかを決定します。
[有効にしない] を選択すると、表示可能な結果は 100 エントリに制限されます。
[有効にする] を選択すると、複数ページにわたるすべての結果が表示されます。有効にすると、ページングの共通パラメーターが自動的に追加されます。
pageNum: ページングのページ番号を指定します。
pageSize: 1 ページあたりの結果数を決定します。最大値は 100 です。
タイムアウト設定
API 呼び出しが 8000 ミリ秒を超えると、タイムアウトエラーが返されます。この設定は変更できません。
上記の構成を完了し、[API のテスト] セクションで、リクエストパラメーターのテスト値を入力し、[テスト開始] をクリックします。
返されたサンプルデータは、[戻り値の例] タブで表示できます。または、[リクエストの詳細] をクリックして特定のリクエスト情報を表示できます。
[公開] をクリックして API を確定します。
重要公開する前に、API が正常にテストされていることを確認してください。
[保存] ボタンをシングルクリックして [API の詳細] ページを表示する必要があります。このページには、[ステータス] が [未公開] と表示されます。
データクエリのために API を呼び出すには、API を公開する必要があります。
次の手順
製品データ API を使用して、製品内の特定のデバイスの生データ、スナップショットデータ、およびイベントデータにアクセスします。
API 呼び出しの例については、以下を参照してください。
詳細については、「Java SDK 呼び出し例」をご参照ください。
詳細については、「Node.js SDK 呼び出しの例」をご参照ください。
API の使用状況を表示するには、[API の詳細] ページに移動します。特定の操作の詳細な手順については、「API の表示」をご参照ください。