Device Data Models - Get

  • リファレンス
サービス:
Azure Data Manager for Agriculture
API バージョン:
2023-11-01-preview

デバイス データ モデル エンティティを取得します。

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

URI パラメーター

名前 / 必須 型 説明
deviceDataModelId
 path True

string

デバイス データ モデル リソースの ID。
endpoint
 path True

string

uri

名前空間のホスト名 (例: admaInstanceName.farmbeats.azure.net)
sensorPartnerId
 path True

string

センサー パートナーの ID。
api-version
 query True

string

要求された API バージョン

要求ヘッダー

名前 必須 型 説明
Authorization True

string

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

応答

名前 型 説明
200 OK

DeviceDataModel

Success
Other Status Codes

ErrorResponse

エラー

ヘッダー

x-ms-error-code: string

セキュリティ

Authorization

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

型: apiKey
/: header

例

DeviceDataModels_Get

要求のサンプル

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

応答のサンプル

状態コード:
200 
{
  "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
  }
}

定義

名前 説明
DeviceDataModel

DeviceDataModel API モデル。
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

デバイスの種類。

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

ポートデジタル/アナログの種類。