Sensor Data Models - Create Or Update

Service:

Azure Data Manager for Agriculture

API Version:

2023-11-01-preview

Hozzon létre egy érzékelő adatmodell-entitást.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string uri	A névtér gazdagépneve, például admaInstanceName.farmbeats.azure.net
sensorDataModelId	path	True	string	Az érzékelő adatmodelljének azonosítója.
sensorPartnerId	path	True	string	Az érzékelőpartner azonosítója.
api-version	query	True	string	A kért API-verzió

Kérelem fejléce

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

Name	Kötelező	Típus	Description
Authorization	True	string	Adjon meg érvényes tulajdonosi jogkivonatot az engedélyezett API-hívásokhoz. Vegye figyelembe, hogy előfordulhat, hogy törölnie kell a böngésző gyorsítótárát, ha korábban nem hitelesített hívásokat próbált meg.

Kérelem törzse

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

Name	Kötelező	Típus	Description
measures	True	<string,  SensorDataModelMeasure>	Az érzékelő típusának térképe az érzékelő mértékeihez.
description		string	Az erőforrás szöveges leírása.
manufacturer		string	Érzékelő gyártója.
name		string	Név az erőforrás azonosításához.
productCode		string	Érzékelő termékkódja.
properties			Az erőforráshoz tartozó kulcsértékpárok gyűjteménye. Minden párnak nem lehet 50 karakternél nagyobb kulcsa, és nem lehet 150 karakternél nagyobb érték. Megjegyzés: Egy erőforráshoz legfeljebb 25 kulcsértékpár adható meg, és csak sztring-, szám- és datetime (ééééé-MM-ddTHH:mm:ssZ) értékek támogatottak.
status		string	Az erőforrás állapota.
type		string	Az érzékelő típusa.

Válaszok

Name	Típus	Description
200 OK	SensorDataModel	Success
201 Created	SensorDataModel	Létrehozva
Other Status Codes	ErrorResponse	Hiba Headers x-ms-error-code: string

Biztonság

Authorization

Adjon meg érvényes tulajdonosi jogkivonatot az engedélyezett API-hívásokhoz. Vegye figyelembe, hogy előfordulhat, hogy törölnie kell a böngésző gyorsítótárát, ha korábban nem hitelesített hívásokat próbált meg.

Type: apiKey
In: header

Példák

SensorDataModels_CreateOrUpdate

Sample Request

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
  }
}

Sample Response

Status code:

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
  }
}

Status code:

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
  }
}

Definíciók

Name	Description
Error	Az Azure AgPlatform szolgáltatás hibája.
ErrorResponse	Hibaválasz az Azure AgPlatform szolgáltatástól. Lásd https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses : ErrorResponse referenciadokumentum.
InnerError	Belső hiba, amely a hibák listáját tartalmazza. Lásd https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object : InnerError referenciadokumentum.
SensorDataModel	SensorModel API-modell.
SensorDataModelMeasure	Az érzékelőmodell mérésének részletei.
SensorDataType	Az érzékelő méri az adattípust.

Error

Az Azure AgPlatform szolgáltatás hibája.

Name	Típus	Description
code	string	Kiszolgáló által definiált hibakódok.
details	Error[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
innererror	InnerError	Belső hiba, amely a hibák listáját tartalmazza. Lásd https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object : InnerError referenciadokumentum.
message	string	A hiba emberi olvasásra alkalmas ábrázolása.
target	string	A hiba célja.

ErrorResponse

Hibaválasz az Azure AgPlatform szolgáltatástól. Lásd https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses : ErrorResponse referenciadokumentum.

Name	Típus	Description
error	Error	Az Azure AgPlatform szolgáltatás hibája.
traceId	string	Egyedi nyomkövetési azonosító.

InnerError

Belső hiba, amely a hibák listáját tartalmazza. Lásd https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object : InnerError referenciadokumentum.

Name	Típus	Description
code	string	Konkrét hibakód, mint amelyet a hiba tartalmazott.
innererror	InnerError	Belső hiba, amely a hibák listáját tartalmazza. Lásd https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object : InnerError referenciadokumentum.

SensorDataModel

SensorModel API-modell.

Name	Típus	Description
createdBy	string	A felhasználó/bérlő azonosítója hozza létre.
createdDateTime	string	Az erőforrás létrehozásának dátum-időpontja, mintaformátum: yyyy-MM-ddTHH:mm:ssZ.
description	string	Az erőforrás szöveges leírása.
eTag	string	Az ETag értéke az optimista egyidejűség megvalósításához.
id	string	Az erőforrás azonosítója.
manufacturer	string	Érzékelő gyártója.
measures	<string,  SensorDataModelMeasure>	Az érzékelő típusának térképe az érzékelő mértékeihez.
modifiedBy	string	Módosítva a felhasználó/bérlő azonosítója alapján.
modifiedDateTime	string	Az erőforrás utolsó módosításának dátuma, mintaformátum: yyyy-MM-ddTHH:mm:ssZ.
name	string	Név az erőforrás azonosításához.
productCode	string	Érzékelő termékkódja.
properties		Az erőforráshoz tartozó kulcsértékpárok gyűjteménye. Minden párnak nem lehet 50 karakternél nagyobb kulcsa, és nem lehet 150 karakternél nagyobb érték. Megjegyzés: Egy erőforráshoz legfeljebb 25 kulcsértékpár adható meg, és csak sztring-, szám- és datetime (ééééé-MM-ddTHH:mm:ssZ) értékek támogatottak.
sensorPartnerId	string	A társított érzékelőpartner azonosítója.
status	string	Az erőforrás állapota.
type	string	Az érzékelő típusa.

SensorDataModelMeasure

Az érzékelőmodell mérésének részletei.

Name	Típus	Description
dataType	SensorDataType	Az érzékelő méri az adattípust.
description	string	Az érzékelő mértékének leírása.
properties		Kulcsértékpárok gyűjteménye az érzékelő-adatmodellhez. Minden párnak nem lehet 50 karakternél nagyobb kulcsa, és nem lehet 150 karakternél nagyobb érték. Megjegyzés: Modellhez legfeljebb 25 kulcsértékpár adható meg, és csak sztring, szám és datetime (yyyy-MM-ddTHH:mm:ssZ) értékek támogatottak.
type	string	Az érzékelőadatok mérési típusa.
unit	string	Az érzékelő mértékegysége.

SensorDataType

Az érzékelő méri az adattípust.

Name	Típus	Description
Bool	string
DateTime	string
Double	string
Long	string
String	string