Sensors - Create Or Update

Servizio:

Azure Data Manager for Agriculture

Versione API:

2023-11-01-preview

Creare un'entità sensore.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string uri	Nome host dello spazio dei nomi, ad esempio admaInstanceName.farmbeats.azure.net
sensorId	path	True	string	ID della risorsa del sensore.
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
depthInMeters	number[]	Profondità di ogni misura del sensore in metri. Come l'umidità del sensore a 2m, 4m, 6m.
description	string	Descrizione testuale della risorsa.
deviceId	string	ID del dispositivo associato.
hardwareId	string	ID dell'hardware associato.
integrationId	string	ID di integrazione per il dispositivo.
location	Location	Classe modello location.
name	string	Nome che identifica la risorsa.
port	Port	Schema per l'archiviazione dei valori di porta.
properties		Raccolta di coppie di valori chiave 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 di valori chiave per una risorsa e solo una stringa, un numero e una datatime (aaaa-MM-ddTHH:mm:ssZ) sono supportati.
sensorDataModelId	string	ID del modello di dati del sensore associato.
status	string	Stato della risorsa.
type	string	Tipo di sensore.

Risposte

Nome	Tipo	Descrizione
200 OK	Sensor	Operazione completata
201 Created	Sensor	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

Sensors_CreateOrUpdate

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

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

Codice di stato:

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

Definizioni

Nome	Descrizione
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 per 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 per il documento di riferimento InnerError.
Location	Classe modello location.
Port	Schema per l'archiviazione dei valori di porta.
Sensor	Modello API sensore.

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 l'errore segnalato.
innererror	InnerError	Errore interno contenente l'elenco di errori. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object per il documento di riferimento 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 per il documento di riferimento ErrorResponse.

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

InnerError

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

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

Location

Classe modello location.

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

Port

Schema per l'archiviazione dei valori di porta.

Nome	Tipo	Descrizione
name	string	Nome della porta.
type	string	Tipo di porta digitale/analogica.

Sensor

Modello API sensore.

Nome	Tipo	Descrizione
createdBy	string	Creato dall'ID utente/tenant.
createdDateTime	string	Data-ora in cui è stata creata la risorsa, formato di esempio: aaaa-MM-ddTHH:mm:ssZ.
depthInMeters	number[]	Profondità di ogni misura del sensore in metri. Come l'umidità del sensore a 2m, 4m, 6m.
description	string	Descrizione testuale della risorsa.
deviceId	string	ID del dispositivo associato.
eTag	string	Valore ETag per implementare la concorrenza ottimistica.
hardwareId	string	ID dell'hardware associato.
id	string	ID della risorsa.
integrationId	string	ID di integrazione per il dispositivo.
location	Location	Classe modello location.
modifiedBy	string	Modificato dall'ID utente/tenant.
modifiedDateTime	string	Data-ora dell'ultima modifica della risorsa, formato di esempio: aaaa-MM-ddTHH:mm:ssZ.
name	string	Nome che identifica la risorsa.
port	Port	Schema per l'archiviazione dei valori di porta.
properties		Raccolta di coppie di valori chiave 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 di valori chiave per una risorsa e solo una stringa, un numero e una datatime (aaaa-MM-ddTHH:mm:ssZ) sono supportati.
sensorDataModelId	string	ID del modello di dati del sensore associato.
sensorPartnerId	string	ID del partner sensore associato.
status	string	Stato della risorsa.
type	string	Tipo di sensore.