Devices - Create Or Update

Servizio:

Azure Data Manager for Agriculture

Versione API:

2023-11-01-preview

Creare un'entità dispositivo.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
deviceId	path	True	string	ID della risorsa del dispositivo.
endpoint	path	True	string uri	Nome host dello spazio dei nomi, ad esempio admaInstanceName.farmbeats.azure.net
sensorPartnerId	path	True	string	ID del partner del sensore.
api-version	query	True	string	Versione dell'API richiesta

Intestazione della richiesta

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

Nome	Necessario	Tipo	Descrizione
Authorization	True	string	Specificare un token di connessione valido per le chiamate API autorizzate. Si noti che potrebbe essere necessario cancellare la cache del browser se si è tentato di eseguire chiamate non autenticate prima.

Corpo della richiesta

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

Nome	Tipo	Descrizione
description	string	Descrizione testuale della risorsa.
deviceDataModelId	string	ID del modello di dati del dispositivo associato.
hardwareId	string	Device hardwareId.
integrationId	string	ID di integrazione per il dispositivo.
location	Location	Classe del modello di posizione.
name	string	Nome che identifica la risorsa.
parentDeviceId	string	ID dispositivo padre per questo dispositivo.
properties		Raccolta di coppie chiave-valore appartenenti alla risorsa. Ogni coppia non deve avere una chiave maggiore di 50 caratteri e non deve avere un valore maggiore di 150 caratteri. Nota: è possibile specificare un massimo di 25 coppie chiave-valore per una risorsa e sono supportati solo valori stringa, numerali e datetime (aa-MM-ggTHH:mm:ssZ).
reportingIntervalInSeconds	integer	Intervallo in cui il dispositivo invia i dati in secondi.
status	string	Stato della risorsa.
type	string	Tipo di dispositivo.

Risposte

Nome	Tipo	Descrizione
200 OK	Device	Operazione completata
201 Created	Device	Data di creazione
Other Status Codes	ErrorResponse	Errore Intestazioni x-ms-error-code: string

Sicurezza

Authorization

Specificare un token di connessione valido per le chiamate API autorizzate. Si noti che potrebbe essere necessario cancellare la cache del browser se si è tentato di eseguire chiamate non autenticate prima.

Tipo: apiKey
In: header

Esempio

Devices_CreateOrUpdate

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

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

Codice di stato:

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

Definizioni

Nome	Descrizione
Device	Modello API del dispositivo.
Error	Errore del servizio Azure AgPlatform.
ErrorResponse	Risposta di errore dal servizio Azure AgPlatform. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses il documento di riferimento ErrorResponse.
InnerError	Errore interno contenente l'elenco di errori. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object il documento di riferimento per InnerError.
Location	Classe del modello di posizione.

Device

Modello API del dispositivo.

Nome	Tipo	Descrizione
createdBy	string	Creato dall'ID utente/tenant.
createdDateTime	string	Data e ora di creazione della risorsa, formato di esempio: a-MM-ggTHH:mm:ssZ.
description	string	Descrizione testuale della risorsa.
deviceDataModelId	string	ID del modello di dati del dispositivo associato.
eTag	string	Valore ETag per implementare la concorrenza ottimistica.
hardwareId	string	Device hardwareId.
id	string	ID della risorsa.
integrationId	string	ID di integrazione per il dispositivo.
location	Location	Classe del modello di posizione.
modifiedBy	string	Modificato dall'ID utente/tenant.
modifiedDateTime	string	Data e ora dell'ultima modifica della risorsa, formato di esempio: aaaa-MM-ggTHH:mm:ssZ.
name	string	Nome che identifica la risorsa.
parentDeviceId	string	ID dispositivo padre per questo dispositivo.
properties		Raccolta di coppie chiave-valore appartenenti alla risorsa. Ogni coppia non deve avere una chiave maggiore di 50 caratteri e non deve avere un valore maggiore di 150 caratteri. Nota: è possibile specificare un massimo di 25 coppie chiave-valore per una risorsa e sono supportati solo valori stringa, numerali e datetime (aa-MM-ggTHH:mm:ssZ).
reportingIntervalInSeconds	integer	Intervallo in cui il dispositivo invia i dati in secondi.
sensorPartnerId	string	ID del partner del sensore associato.
status	string	Stato della risorsa.
type	string	Tipo di dispositivo.

Error

Errore del servizio Azure AgPlatform.

Nome	Tipo	Descrizione
code	string	Set definito dal server di codici di errore.
details	Error[]	Matrice di dettagli sugli errori specifici che hanno causato questo errore segnalato.
innererror	InnerError	Errore interno contenente l'elenco di errori. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object il documento di riferimento per InnerError.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

ErrorResponse

Risposta di errore dal servizio Azure AgPlatform. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses il documento di riferimento ErrorResponse.

Nome	Tipo	Descrizione
error	Error	Errore del servizio Azure AgPlatform.
traceId	string	ID di traccia univoco.

InnerError

Errore interno contenente l'elenco di errori. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object il documento di riferimento per InnerError.

Nome	Tipo	Descrizione
code	string	Codice di errore specifico di quello fornito dall'errore che lo contiene.
innererror	InnerError	Errore interno contenente l'elenco di errori. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object il documento di riferimento per InnerError.

Location

Classe del modello di posizione.

Nome	Tipo	Descrizione
latitude	number	Latitudine della posizione.
longitude	number	Longitudine della posizione.