Sensor Data Models - Create Or Update

Service:

Azure Data Manager for Agriculture

API Version:

2023-11-01-preview

Vytvořte entitu datového modelu senzoru.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string uri	Název hostitele oboru názvů, například admaInstanceName.farmbeats.azure.net
sensorDataModelId	path	True	string	ID datového modelu senzoru.
sensorPartnerId	path	True	string	ID partnera senzoru.
api-version	query	True	string	Požadovaná verze rozhraní API

Hlavička požadavku

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

Name	Vyžadováno	Typ	Description
Authorization	True	string	Zadejte platný nosný token pro autorizovaná volání rozhraní API. Upozorňujeme, že pokud jste se předtím pokusili o neověřené volání, možná budete muset vymazat mezipaměť prohlížeče.

Text požadavku

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

Name	Vyžadováno	Typ	Description
measures	True	<string,  SensorDataModelMeasure>	Mapa typu senzoru na senzorové míry
description		string	Textový popis prostředku.
manufacturer		string	Výrobce senzoru.
name		string	Název pro identifikaci prostředku
productCode		string	Kód produktu senzoru.
properties			Kolekce párů hodnot klíčů, které patří do prostředku. Každý pár nesmí mít klíč větší než 50 znaků a nesmí mít hodnotu větší než 150 znaků. Poznámka: Pro prostředek je možné zadat maximálně 25 párů hodnot klíčů a podporují se pouze hodnoty string, numeral a datetime (yyyy-MM-ddTHH:mm:ssZ).
status		string	Stav prostředku.
type		string	Typ senzoru.

Odpovědi

Name	Typ	Description
200 OK	SensorDataModel	Success
201 Created	SensorDataModel	Vytvořeno
Other Status Codes	ErrorResponse	Chybová Headers x-ms-error-code: string

Zabezpečení

Authorization

Zadejte platný nosný token pro autorizovaná volání rozhraní API. Upozorňujeme, že pokud jste se předtím pokusili o neověřené volání, možná budete muset vymazat mezipaměť prohlížeče.

Type: apiKey
In: header

Příklady

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

Definice

Name	Description
Error	Chyba ze služby Azure AgPlatform.
ErrorResponse	Chybová odpověď ze služby Azure AgPlatform. Viz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses referenční dokument ErrorResponse.
InnerError	Vnitřní chyba obsahující seznam chyb. Viz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object referenční dokument InnerError.
SensorDataModel	Model rozhraní API SensorModel.
SensorDataModelMeasure	Podrobnosti o měření modelu senzoru
SensorDataType	Datový typ měření senzoru.

Error

Chyba ze služby Azure AgPlatform.

Name	Typ	Description
code	string	Sada kódů chyb definovaná serverem.
details	Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	InnerError	Vnitřní chyba obsahující seznam chyb. Viz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object referenční dokument InnerError.
message	string	Znázornění chyby čitelné pro člověka
target	string	Cíl chyby.

ErrorResponse

Chybová odpověď ze služby Azure AgPlatform. Viz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses referenční dokument ErrorResponse.

Name	Typ	Description
error	Error	Chyba ze služby Azure AgPlatform.
traceId	string	Jedinečné ID trasování.

InnerError

Vnitřní chyba obsahující seznam chyb. Viz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object referenční dokument InnerError.

Name	Typ	Description
code	string	Konkrétní kód chyby, než byl poskytnut chybou obsahující chybu.
innererror	InnerError	Vnitřní chyba obsahující seznam chyb. Viz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object referenční dokument InnerError.

SensorDataModel

Model rozhraní API SensorModel.

Name	Typ	Description
createdBy	string	Vytvořeno podle ID uživatele nebo tenanta.
createdDateTime	string	Datum a čas vytvoření prostředku, ukázkový formát: yyyy-MM-ddTHH:mm:ssZ.
description	string	Textový popis prostředku.
eTag	string	Hodnota ETag pro implementaci optimistické souběžnosti
id	string	ID prostředku.
manufacturer	string	Výrobce senzoru.
measures	<string,  SensorDataModelMeasure>	Mapa typu senzoru na senzorové míry
modifiedBy	string	Upraveno podle ID uživatele nebo tenanta.
modifiedDateTime	string	Datum a čas poslední změny prostředku, ukázkový formát: yyyy-MM-ddTHH:mm:ssZ.
name	string	Název pro identifikaci prostředku
productCode	string	Kód produktu senzoru.
properties		Kolekce párů hodnot klíčů, které patří do prostředku. Každý pár nesmí mít klíč větší než 50 znaků a nesmí mít hodnotu větší než 150 znaků. Poznámka: Pro prostředek je možné zadat maximálně 25 párů hodnot klíčů a podporují se pouze hodnoty string, numeral a datetime (yyyy-MM-ddTHH:mm:ssZ).
sensorPartnerId	string	ID přidruženého partnera pro senzory.
status	string	Stav prostředku.
type	string	Typ senzoru.

SensorDataModelMeasure

Podrobnosti o měření modelu senzoru

Name	Typ	Description
dataType	SensorDataType	Datový typ měření senzoru.
description	string	Popis míry senzoru.
properties		Kolekce párů klíčových hodnot pro datový model senzoru. Každý pár nesmí mít klíč větší než 50 znaků a nesmí mít hodnotu větší než 150 znaků. Poznámka: Pro model je možné zadat maximálně 25 párů hodnot klíčů a podporují se pouze hodnoty řetězce, číslic a data a času (yyyy-MM-ddTHH:mm:ssZ).
type	string	Typ měření dat senzoru.
unit	string	Měrná jednotka senzoru.

SensorDataType

Datový typ měření senzoru.

Name	Typ	Description
Bool	string
DateTime	string
Double	string
Long	string
String	string