Devices - Create Or Update

Referens

Service:: Azure Data Manager for Agriculture

API Version:: 2023-11-01-preview

Skapa en enhetsentitet.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
deviceId	path	True	string	ID för enhetsresursen.
endpoint	path	True	string uri	Namnområdets värdnamn, t.ex. admaInstanceName.farmbeats.azure.net
sensorPartnerId	path	True	string	ID för sensorpartnern.
api-version	query	True	string	Den begärda API-versionen

Begärandehuvud

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

Name	Obligatorisk	Typ	Description
Authorization	True	string	Ange en giltig ägartoken för auktoriserade API-anrop. Observera att du kan behöva rensa webbläsarens cacheminne om du har provat oautentiserade anrop tidigare.

Begärandetext

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

Name	Typ	Description
description	string	Textbeskrivning av resursen.
deviceDataModelId	string	ID för den associerade enhetsdatamodellen.
hardwareId	string	Device hardwareId.
integrationId	string	Integrations-ID för enheten.
location	Location	Platsmodellklass.
name	string	Namn för att identifiera resursen.
parentDeviceId	string	Överordnat enhets-ID för den här enheten.
properties		En samling nyckel/värde-par som tillhör resursen. Varje par får inte ha en nyckel som är större än 50 tecken och får inte ha ett värde som är större än 150 tecken. Obs! Högst 25 nyckel/värde-par kan anges för en resurs och endast värden för sträng, siffror och datetime (åå-MM-ddTHH:mm:ssZ) stöds.
reportingIntervalInSeconds	integer	Intervall med vilket enheten skickar data i sekunder.
status	string	Status för resursen.
type	string	Typ av enhet.

Svar

Name	Typ	Description
200 OK	Device	Klart
201 Created	Device	Skapad
Other Status Codes	ErrorResponse	Fel Headers x-ms-error-code: string

Name

Typ

Description

200 OK

Device

Klart

201 Created

Device

Skapad

Other Status Codes

ErrorResponse

Fel

Headers

x-ms-error-code: string

Säkerhet

Authorization

Ange en giltig ägartoken för auktoriserade API-anrop. Observera att du kan behöva rensa webbläsarens cacheminne om du har provat oautentiserade anrop tidigare.

Type: apiKey
In: header

Exempel

Devices_CreateOrUpdate

Sample Request

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

Sample Response

Status code:: 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
  }
}

Status code:: 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
  }
}

Definitioner

Name	Description
Device	Enhets-API-modell.
Error	Ett fel från Azure AgPlatform-tjänsten.
ErrorResponse	Ett felsvar från Azure AgPlatform-tjänsten. Se https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses för ErrorResponse-referensdokument.
InnerError	Inre fel som innehåller listan över fel. Mer information https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object finns i referensdokumentet för InnerError.
Location	Platsmodellklass.

Device

Enhets-API-modell.

Name	Typ	Description
createdBy	string	Skapat av användar-/klientorganisations-ID.
createdDateTime	string	Datum-tid när resursen skapades, exempelformat: åååå-MM-ddTHH:mm:ssZ.
description	string	Textbeskrivning av resursen.
deviceDataModelId	string	ID för den associerade enhetsdatamodellen.
eTag	string	ETag-värdet för att implementera optimistisk samtidighet.
hardwareId	string	Device hardwareId.
id	string	ID för resursen.
integrationId	string	Integrations-ID för enheten.
location	Location	Platsmodellklass.
modifiedBy	string	Ändrat av användar-/klientorganisations-ID.
modifiedDateTime	string	Datum-tid när resursen senast ändrades, exempelformat: åååå-MM-ddTHH:mm:ssZ.
name	string	Namn för att identifiera resursen.
parentDeviceId	string	Överordnat enhets-ID för den här enheten.
properties		En samling nyckel/värde-par som tillhör resursen. Varje par får inte ha en nyckel som är större än 50 tecken och får inte ha ett värde som är större än 150 tecken. Obs! Högst 25 nyckel/värde-par kan anges för en resurs och endast värden för sträng, siffror och datetime (åå-MM-ddTHH:mm:ssZ) stöds.
reportingIntervalInSeconds	integer	Intervall med vilket enheten skickar data i sekunder.
sensorPartnerId	string	ID för den associerade sensorpartnern.
status	string	Status för resursen.
type	string	Typ av enhet.

Error

Ett fel från Azure AgPlatform-tjänsten.

Name	Typ	Description
code	string	Serverdefinierad uppsättning felkoder.
details	Error[]	Matris med information om specifika fel som ledde till det rapporterade felet.
innererror	InnerError	Inre fel som innehåller listan över fel. Mer information https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object finns i referensdokumentet för InnerError.
message	string	Mänsklig läsbar representation av felet.
target	string	Målet för felet.

ErrorResponse

Ett felsvar från Azure AgPlatform-tjänsten. Se https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses för ErrorResponse-referensdokument.

Name	Typ	Description
error	Error	Ett fel från Azure AgPlatform-tjänsten.
traceId	string	Unikt spårnings-ID.

InnerError

Inre fel som innehåller listan över fel. Mer information https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object finns i referensdokumentet för InnerError.

Name	Typ	Description
code	string	Specifik felkod än vad som angavs av det innehållande felet.
innererror	InnerError	Inre fel som innehåller listan över fel. Mer information https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object finns i referensdokumentet för InnerError.

Location

Platsmodellklass.

Name	Typ	Description
latitude	number	Latitud för platsen.
longitude	number	Longitud för platsen.

Share via

Devices - Create Or Update

URI-parametrar

Begärandehuvud

Begärandetext

Svar

Säkerhet

Authorization

Exempel

Devices_CreateOrUpdate

Sample Request

Sample Response

Definitioner

Device

Error

ErrorResponse

InnerError

Location

Ytterligare resurser