Devices - Create Or Update

Reference

Služba:: Azure Data Manager for Agriculture

Verze rozhraní API:: 2023-11-01-preview

Vytvoření entity zařízení

PATCH {endpoint}/sensor-partners/{sensorPartnerId}/devices/{deviceId}?api-version=2023-11-01-preview

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
deviceId	path	True	string	ID prostředku zařízení.
endpoint	path	True	string (uri)	Název hostitele oboru názvů, např. admaInstanceName.farmbeats.azure.net
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. Mějte na paměti, že pokud jste zkusili neověřené volání dříve, možná budete muset vymazat mezipaměť prohlížeče.

Text požadavku

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

Name	Typ	Description
description	string minLength: 0 maxLength: 500	Textový popis prostředku
deviceDataModelId	string	ID přidruženého datového modelu zařízení
hardwareId	string minLength: 0 maxLength: 100	Device hardwareId.
integrationId	string	ID integrace zařízení.
location	Location	Třída modelu umístění.
name	string minLength: 0 maxLength: 100	Název k identifikaci prostředku
parentDeviceId	string	ID nadřazeného zařízení pro toto zařízení.
properties		Kolekce párů klíč-hodnota, které patří k 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 lze zadat maximálně 25 párů klíč-hodnota a jsou podporovány pouze hodnoty string, číslic a datetime (yyyy-MM-ddTHH:mm:ssZ).
reportingIntervalInSeconds	integer (int32)	Interval, ve kterém zařízení odesílá data v sekundách.
status	string minLength: 0 maxLength: 100	Stav prostředku
type	string minLength: 0 maxLength: 100	Typ zařízení.

Odpovědi

Name	Typ	Description
200 OK	Device	Úspěch
201 Created	Device	Vytvořeno
Other Status Codes	ErrorResponse	Chyba Hlavičky x-ms-error-code: string

Name

Typ

Description

200 OK

Device

Úspěch

201 Created

Device

Vytvořeno

Other Status Codes

ErrorResponse

Chyba

Hlavičky

x-ms-error-code: string

Zabezpečení

Authorization

Zadejte platný nosný token pro autorizovaná volání rozhraní API. Mějte na paměti, že pokud jste zkusili neověřené volání dříve, možná budete muset vymazat mezipaměť prohlížeče.

Typ: apiKey
V: header

Příklady

Devices_CreateOrUpdate

Ukázkový požadavek

HTTP

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

{
  "deviceDataModelId": "ddm124",
  "integrationId": "string",
  "type": "device",
  "hardwareId": "HD156",
  "reportingIntervalInSeconds": 10,
  "location": {
    "latitude": 23.5,
    "longitude": 42.7
  },
  "status": "new device",
  "name": "my device",
  "description": "description goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

Ukázková odpověď

Stavový kód:: 200

{
  "deviceDataModelId": "ddm124",
  "integrationId": "string",
  "type": "device",
  "hardwareId": "HD156",
  "reportingIntervalInSeconds": 10,
  "location": {
    "latitude": 23.5,
    "longitude": 42.7
  },
  "sensorPartnerId": "sp1",
  "id": "d123",
  "status": "new device",
  "createdDateTime": "2022-01-24T06:20:47Z",
  "modifiedDateTime": "2022-01-24T06:21:07Z",
  "eTag": "0401a5cc-0000-0700-0000-61ee45540000",
  "name": "my device",
  "description": "description goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

Stavový kód:: 201

{
  "deviceDataModelId": "ddm124",
  "integrationId": "string",
  "type": "device",
  "hardwareId": "HD156",
  "reportingIntervalInSeconds": 10,
  "location": {
    "latitude": 23.5,
    "longitude": 42.7
  },
  "sensorPartnerId": "sp1",
  "id": "d123",
  "status": "new device",
  "createdDateTime": "2022-01-24T06:20:47Z",
  "modifiedDateTime": "2022-01-24T06:20:47Z",
  "eTag": "0401baca-0000-0700-0000-61ee453f0000",
  "name": "my device",
  "description": "description goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

Definice

Name	Description
Device	Model rozhraní API zařízení
Error	Chyba ze služby Azure AgPlatform.
ErrorResponse	Odpověď na chybu ze služby Azure AgPlatform. Viz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses referenčního dokumentu ErrorResponse.
InnerError	Vnitřní chyba obsahující seznam chyb Viz referenční dokument https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object pro InnerError.
Location	Třída modelu umístění.

Device

Objekt

Model rozhraní API zařízení

Name	Typ	Description
createdBy	string	Vytvořil(a) id uživatele nebo tenanta.
createdDateTime	string (date-time)	Datum a čas vytvoření prostředku, ukázkový formát: rrrr-MM-ddTHH:mm:ssZ.
description	string minLength: 0 maxLength: 500	Textový popis prostředku
deviceDataModelId	string	ID přidruženého datového modelu zařízení
eTag	string	Hodnota ETag pro implementaci optimistické souběžnosti.
hardwareId	string minLength: 0 maxLength: 100	Device hardwareId.
id	string	ID prostředku.
integrationId	string	ID integrace zařízení.
location	Location	Třída modelu umístění.
modifiedBy	string	Upravil(a) id uživatele nebo tenanta.
modifiedDateTime	string (date-time)	Datum a čas poslední změny prostředku, ukázkový formát: rrrr-MM-ddTHH:mm:ssZ.
name	string minLength: 0 maxLength: 100	Název k identifikaci prostředku
parentDeviceId	string	ID nadřazeného zařízení pro toto zařízení.
properties		Kolekce párů klíč-hodnota, které patří k 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 lze zadat maximálně 25 párů klíč-hodnota a jsou podporovány pouze hodnoty string, číslic a datetime (yyyy-MM-ddTHH:mm:ssZ).
reportingIntervalInSeconds	integer (int32)	Interval, ve kterém zařízení odesílá data v sekundách.
sensorPartnerId	string	ID přidruženého partnera senzoru.
status	string minLength: 0 maxLength: 100	Stav prostředku
type	string minLength: 0 maxLength: 100	Typ zařízení.

Error

Objekt

Chyba ze služby Azure AgPlatform.

Name	Typ	Description
code	string minLength: 1	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 referenční dokument https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object pro InnerError.
message	string minLength: 1	Čitelné znázornění chyby člověkem
target	string	Cíl chyby.

ErrorResponse

Objekt

Odpověď na chybu ze služby Azure AgPlatform. Viz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses referenčního dokumentu ErrorResponse.

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

InnerError

Objekt

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

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

Location

Objekt

Třída modelu umístění.

Name	Typ	Description
latitude	number (double) minimum: -90 maximum: 90	Zeměpisná šířka místa.
longitude	number (double) minimum: -180 maximum: 180	Zeměpisná délka umístění.

Sdílet prostřednictvím

Devices - Create Or Update

Parametry identifikátoru URI

Hlavička požadavku

Text požadavku

Odpovědi

Zabezpečení

Authorization

Příklady

Devices_CreateOrUpdate

Ukázkový požadavek

Ukázková odpověď

Definice

Device

Error

ErrorResponse

InnerError

Location

Další materiály