Device Data Models - List

リファレンス

サービス:: Azure Data Manager for Agriculture

API バージョン:: 2023-11-01-preview

デバイスデータモデルリソースのページ分割された一覧を返します。

GET {endpoint}/sensor-partners/{sensorPartnerId}/device-data-models?api-version=2023-11-01-preview

省略可能なパラメーターを含む:

GET {endpoint}/sensor-partners/{sensorPartnerId}/device-data-models?ids={ids}&names={names}&propertyFilters={propertyFilters}&statuses={statuses}&minCreatedDateTime={minCreatedDateTime}&maxCreatedDateTime={maxCreatedDateTime}&minLastModifiedDateTime={minLastModifiedDateTime}&maxLastModifiedDateTime={maxLastModifiedDateTime}&maxPageSize={maxPageSize}&skipToken={skipToken}&api-version=2023-11-01-preview

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string uri	名前空間のホスト名 (例: admaInstanceName.farmbeats.azure.net)
sensorPartnerId	path	True	string	関連付けられているセンサーパートナーの ID。
api-version	query	True	string	要求された API バージョン
ids	query		string[]	リソースの ID。
maxCreatedDateTime	query		string date-time	リソースの最大作成日 (含む)。
maxLastModifiedDateTime	query		string date-time	リソースの最終更新日の最大値 (含む)。
maxPageSize	query		integer int32	必要な項目の最大数 (含む)。 Minimum = 10、Maximum = 1000、既定値 = 50。
minCreatedDateTime	query		string date-time	リソースの最小作成日 (含む)。
minLastModifiedDateTime	query		string date-time	リソースの最終更新日の最小値 (含む)。
names	query		string[]	リソースの名前。
propertyFilters	query		string[]	Properties オブジェクト内のキーと値のペアをフィルター処理します。例: "{testKey} eq {testValue}"
skipToken	query		string	次の結果セットを取得するためのトークンをスキップします。
statuses	query		string[]	リソースの状態。

要求ヘッダー

名前	必須	型	説明
Authorization	True	string	承認された API 呼び出しに有効なベアラートークンを指定してください。以前に認証されていない呼び出しを試した場合は、ブラウザーのキャッシュをクリアする必要がある場合があることに注意してください。

応答

名前	型	説明
200 OK	DeviceDataModelListResponse	Success
Other Status Codes	ErrorResponse	エラーヘッダー x-ms-error-code: string

名前

型

説明

200 OK

DeviceDataModelListResponse

Success

Other Status Codes

ErrorResponse

エラー

ヘッダー

x-ms-error-code: string

セキュリティ

Authorization

承認された API 呼び出しに有効なベアラートークンを指定してください。以前に認証されていない呼び出しを試した場合は、ブラウザーのキャッシュをクリアする必要がある場合があることに注意してください。

型: apiKey
/: header

例

DeviceDataModels_List

要求のサンプル

HTTP

GET {endpoint}/sensor-partners/sp1/device-data-models?api-version=2023-11-01-preview

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "type": "Node",
      "manufacturer": "Manufacturer1",
      "productCode": "smt123",
      "ports": [
        {
          "name": "sm",
          "type": "Analog"
        }
      ],
      "sensorPartnerId": "sp1",
      "id": "ddm124",
      "status": "new",
      "createdDateTime": "2022-01-21T09:52:16Z",
      "modifiedDateTime": "2022-01-21T09:54:08Z",
      "eTag": "7f002a96-0000-0700-0000-61ea82c00000",
      "name": "sm-device-model",
      "description": "new device model for soil moisture measurement devices",
      "properties": {
        "key1": "value1",
        "key2": 123.45
      }
    }
  ],
  "skipToken": "skipToken",
  "nextLink": "https://{{resourceName}}.farmbeats.azure.net/sensor-partners/{{sensorPartnerId}}/device-data-models?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d"
}

定義

名前	説明
DeviceDataModel	DeviceDataModel API モデル。
DeviceDataModelListResponse	ページ応答には、要求されたオブジェクトの一覧と、次の結果セットを取得するための URL リンクが含まれています。
Error	Azure AgPlatform サービスからのエラー。
ErrorResponse	Azure AgPlatform サービスからのエラー応答。 ErrorResponse リファレンスドキュメントを参照してください https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses 。
InnerError	エラーの一覧を含む内部エラー。InnerError のリファレンスドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object してください。
Port	ポート値を格納するためのスキーマ。

DeviceDataModel

DeviceDataModel API モデル。

名前	型	説明
createdBy	string	ユーザー/テナント ID によって作成されます。
createdDateTime	string	リソースが作成された日時 (サンプル形式: yyyy-MM-ddTHH:mm:ssZ)。
description	string	リソースの説明テキスト。
eTag	string	オプティミスティックコンカレンシーを実装する ETag 値。
id	string	リソースの ID。
manufacturer	string	デバイスの製造元。
modifiedBy	string	ユーザー/テナント ID によって変更されました。
modifiedDateTime	string	リソースが最後に変更された日時 (サンプル形式: yyyy-MM-ddTHH:mm:ssZ)。
name	string	リソースを識別する名前
ports	Port[]	サポートされているデバイスポートの一覧。
productCode	string	デバイス productCode。
properties		リソースに属するキー値ペアのコレクション。各ペアは、50 文字を超えるキーを持つ必要があり、150 文字を超える値を持つ必要があります。注: リソースには最大 25 個のキー値ペアを指定でき、文字列、数字、datetime (yyyy-MM-ddTHH:mm:ssZ) の値のみがサポートされます。
sensorPartnerId	string	関連付けられているセンサーパートナーの ID。
status	string	リソースの状態。
type	string	デバイスの種類。

DeviceDataModelListResponse

ページ応答には、要求されたオブジェクトの一覧と、次の結果セットを取得するための URL リンクが含まれています。

名前	型	説明
nextLink	string	一覧にある結果の次のページへの継続リンク (絶対 URI)
skipToken	string	次のページの取得に使用されるトークン。 null の場合、追加のページはありません。
value	DeviceDataModel[]	要求されたオブジェクトの一覧。

Error

Azure AgPlatform サービスからのエラー。

名前	型	説明
code	string	サーバー定義のエラーコードのセット。
details	Error[]	この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
innererror	InnerError	エラーの一覧を含む内部エラー。InnerError のリファレンスドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object してください。
message	string	人が判読できるエラーの表現。
target	string	エラーのターゲット。

ErrorResponse

Azure AgPlatform サービスからのエラー応答。 ErrorResponse リファレンスドキュメントを参照してください https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses 。

名前	型	説明
error	Error	Azure AgPlatform サービスからのエラー。
traceId	string	一意のトレース ID。

InnerError

エラーの一覧を含む内部エラー。InnerError のリファレンスドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object してください。

名前	型	説明
code	string	含まれているエラーによって提供されたエラーコードより具体的なエラーコード。
innererror	InnerError	エラーの一覧を含む内部エラー。InnerError のリファレンスドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object してください。

Port

ポート値を格納するためのスキーマ。

名前	型	説明
name	string	ポートの名前。
type	string	ポートデジタル/アナログの種類。

次の方法で共有

Device Data Models - List

URI パラメーター

要求ヘッダー

応答

セキュリティ

Authorization

例

DeviceDataModels_List

要求のサンプル

応答のサンプル

定義

DeviceDataModel

DeviceDataModelListResponse

Error

ErrorResponse

InnerError

Port

その他のリソース