Sensor Data Models - Create Or Update

リファレンス

サービス:: Azure Data Manager for Agriculture

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

センサーデータモデルエンティティを作成します。

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

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string uri	名前空間のホスト名 (例: admaInstanceName.farmbeats.azure.net)
sensorDataModelId	path	True	string	センサーデータモデルの ID。
sensorPartnerId	path	True	string	センサーパートナーの ID。
api-version	query	True	string	要求された API バージョン

要求ヘッダー

Media Types: "application/merge-patch+json"

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

要求本文

Media Types: "application/merge-patch+json"

名前	必須	型	説明
measures	True	<string, SensorDataModelMeasure>	センサーの種類をセンサーメジャーにマップします。
description		string	リソースの説明テキスト。
manufacturer		string	センサーの製造元。
name		string	リソースを識別する名前
productCode		string	センサー製品コード。
properties			リソースに属するキー値ペアのコレクション。各ペアには、50 文字を超えるキーを持つ必要があり、150 文字を超える値を持つ必要があります。注: リソースには最大 25 個のキー値ペアを指定でき、文字列、数字、datetime (yyyy-MM-ddTHH:mm:ssZ) 値のみがサポートされます。
status		string	リソースの状態。
type		string	センサーの種類。

応答

名前	型	説明
200 OK	SensorDataModel	Success
201 Created	SensorDataModel	作成済み
Other Status Codes	ErrorResponse	エラーヘッダー x-ms-error-code: string

名前

型

説明

200 OK

SensorDataModel

Success

201 Created

SensorDataModel

作成済み

Other Status Codes

ErrorResponse

エラー

ヘッダー

x-ms-error-code: string

セキュリティ

Authorization

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

型: apiKey
/: header

例

SensorDataModels_CreateOrUpdate

要求のサンプル

HTTP

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

{
  "type": "Sensor",
  "manufacturer": "Some sensor manufacturer",
  "productCode": "soil m",
  "measures": {
    "soilMoisture": {
      "description": "measures soil moisture",
      "dataType": "Bool",
      "type": "sm",
      "unit": "none",
      "properties": {
        "abc": "def",
        "elevation": 5
      }
    }
  },
  "status": "new",
  "name": "my sdm for soil moisture",
  "description": "description goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

応答のサンプル

状態コード:: 200

{
  "type": "Sensor",
  "manufacturer": "Some sensor manufacturer",
  "productCode": "soil m",
  "measures": {
    "soilMoisture": {
      "description": "measures soil moisture",
      "dataType": "Bool",
      "type": "sm",
      "unit": "none",
      "properties": {
        "abc": "def",
        "elevation": 5
      }
    }
  },
  "sensorPartnerId": "sp1",
  "id": "sdm124",
  "status": "new",
  "createdDateTime": "2022-01-24T06:12:15Z",
  "modifiedDateTime": "2022-01-24T06:12:42Z",
  "eTag": "040161a2-0000-0700-0000-61ee435a0000",
  "name": "my sdm for soil moisture",
  "description": "description goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

状態コード:: 201

{
  "type": "Sensor",
  "manufacturer": "Some sensor manufacturer",
  "productCode": "soil m",
  "measures": {
    "soilMoisture": {
      "description": "measures soil moisture",
      "dataType": "Bool",
      "type": "sm",
      "unit": "none",
      "properties": {
        "abc": "def",
        "elevation": 5
      }
    }
  },
  "sensorPartnerId": "sp1",
  "id": "sdm124",
  "status": "new",
  "createdDateTime": "2022-01-24T06:12:15Z",
  "modifiedDateTime": "2022-01-24T06:12:15Z",
  "eTag": "040158a0-0000-0700-0000-61ee433f0000",
  "name": "my sdm for soil moisture",
  "description": "description goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

定義

名前	説明
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 してください。
SensorDataModel	SensorModel API モデル。
SensorDataModelMeasure	センサーモデルのメジャーの詳細。
SensorDataType	センサーメジャーのデータ型。

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 してください。

SensorDataModel

SensorModel API モデル。

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

SensorDataModelMeasure

センサーモデルのメジャーの詳細。

名前	型	説明
dataType	SensorDataType	センサーメジャーのデータ型。
description	string	センサーメジャーの説明。
properties		センサーデータモデルのキー値ペアのコレクション。各ペアには、50 文字を超えるキーを持つ必要があり、150 文字を超える値を持つ必要があります。注: モデルには最大 25 個のキー値ペアを指定でき、文字列、数字、datetime (yyyy-MM-ddTHH:mm:ssZ) 値のみがサポートされています。
type	string	センサーデータの測定の種類。
unit	string	センサー測定の単位。

SensorDataType

センサーメジャーのデータ型。

名前	型	説明
Bool	string
DateTime	string
Double	string
Long	string
String	string

次の方法で共有

Sensor Data Models - Create Or Update

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

Authorization

例

SensorDataModels_CreateOrUpdate

要求のサンプル

応答のサンプル

定義

Error

ErrorResponse

InnerError

SensorDataModel

SensorDataModelMeasure

SensorDataType

その他のリソース