Sensors - Create Or Update

Služba:

Azure Data Manager for Agriculture

Verze rozhraní API:

2023-11-01-preview

Vytvořte entitu senzoru.

PATCH {endpoint}/sensor-partners/{sensorPartnerId}/sensors/{sensorId}?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
sensorId	path	True	string	ID prostředku 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	Typ	Description
depthInMeters	number[]	Hloubka každého senzoru měří v metrech. Stejně jako vlhkost senzoru na 2m, 4m, 6m.
description	string	Textový popis prostředku.
deviceId	string	ID přidruženého zařízení.
hardwareId	string	ID přidruženého hardwaru.
integrationId	string	ID integrace pro zařízení.
location	Location	Třída modelu umístění
name	string	Název pro identifikaci prostředku
port	Port	Schéma pro ukládání hodnot portů
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).
sensorDataModelId	string	ID přidruženého datového modelu senzoru.
status	string	Stav prostředku.
type	string	Typ senzoru.

Odpovědi

Name	Typ	Description
200 OK	Sensor	Success
201 Created	Sensor	Vytvořeno
Other Status Codes	ErrorResponse	Chybová Hlavičky 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.

Typ: apiKey
V: header

Příklady

Sensors_CreateOrUpdate

Ukázkový požadavek

HTTP

PATCH {endpoint}/sensor-partners/sp1/sensors/s124?api-version=2023-11-01-preview

{
  "sensorDataModelId": "sdm124",
  "integrationId": "string",
  "hardwareId": "SMHD 456",
  "deviceId": "d124",
  "type": "SM",
  "location": {
    "latitude": 23.5,
    "longitude": 42.7
  },
  "port": {
    "name": "measure",
    "type": "digital"
  },
  "status": "sm created",
  "name": "my new sm",
  "description": "description for sensor goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

Ukázková odpověď

Stavový kód:

200

{
  "sensorDataModelId": "sdm124",
  "integrationId": "string",
  "hardwareId": "SMHD-456",
  "deviceId": "d124",
  "type": "SM",
  "location": {
    "latitude": 23.5,
    "longitude": 42.7
  },
  "port": {
    "name": "measure",
    "type": "digital"
  },
  "sensorPartnerId": "sp1",
  "id": "s124",
  "status": "sm created",
  "createdDateTime": "2022-01-24T06:27:05Z",
  "modifiedDateTime": "2022-01-24T06:27:05Z",
  "eTag": "040139eb-0000-0700-0000-61ee46b90000",
  "name": "my new sm",
  "description": "description for sensor goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

Stavový kód:

201

{
  "sensorDataModelId": "sdm124",
  "integrationId": "string",
  "hardwareId": "SMHD-456",
  "deviceId": "d124",
  "type": "SM",
  "location": {
    "latitude": 23.5,
    "longitude": 42.7
  },
  "port": {
    "name": "measure",
    "type": "digital"
  },
  "sensorPartnerId": "sp1",
  "id": "s124",
  "status": "sm created",
  "createdDateTime": "2022-01-24T06:27:05Z",
  "modifiedDateTime": "2022-01-24T06:27:05Z",
  "eTag": "040139eb-0000-0700-0000-61ee46b90000",
  "name": "my new sm",
  "description": "description for sensor 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.
Location	Třída modelu umístění
Port	Schéma pro ukládání hodnot portů
Sensor	Model rozhraní API pro senzory.

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.

Location

Třída modelu umístění

Name	Typ	Description
latitude	number	Zeměpisná šířka umístění.
longitude	number	Zeměpisná délka umístění.

Port

Schéma pro ukládání hodnot portů

Name	Typ	Description
name	string	Název portu.
type	string	Typ digitálního/analogového portu.

Sensor

Model rozhraní API pro senzory.

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.
depthInMeters	number[]	Hloubka každého senzoru měří v metrech. Stejně jako vlhkost senzoru na 2m, 4m, 6m.
description	string	Textový popis prostředku.
deviceId	string	ID přidruženého zařízení.
eTag	string	Hodnota ETag pro implementaci optimistické souběžnosti
hardwareId	string	ID přidruženého hardwaru.
id	string	ID prostředku.
integrationId	string	ID integrace pro zařízení.
location	Location	Třída modelu umístění
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
port	Port	Schéma pro ukládání hodnot portů
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).
sensorDataModelId	string	ID přidruženého datového modelu senzoru.
sensorPartnerId	string	ID přidruženého partnera pro senzory.
status	string	Stav prostředku.
type	string	Typ senzoru.