Sensor Data Models - Create Or Update

Servizio:

Azure Data Manager for Agriculture

Versione API:

2023-11-01-preview

Creare un'entità del modello di dati del sensore.

PATCH {endpoint}/sensor-partners/{sensorPartnerId}/sensor-data-models/{sensorDataModelId}?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
sensorDataModelId	path	True	string	ID del modello di dati 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	Necessario	Tipo	Descrizione
measures	True	<string,  SensorDataModelMeasure>	Mappa del tipo di sensore alle misure del sensore.
description		string	Descrizione testuale della risorsa.
manufacturer		string	Produttore del sensore.
name		string	Nome che identifica la risorsa.
productCode		string	ProductCode del sensore.
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.
status		string	Stato della risorsa.
type		string	Tipo di sensore.

Risposte

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

SensorDataModels_CreateOrUpdate

Esempio di richiesta

HTTP

PATCH {endpoint}/sensor-partners/sp1/sensor-data-models/sdm124?api-version=2023-11-01-preview

{
  "type": "Sensor",
  "manufacturer": "Some sensor manufacturer",
  "productCode": "soil m",
  "measures": {
    "soilMoisture": {
      "description": "measures soil moisture",
      "dataType": "Bool",
      "type": "sm",
      "unit": "none",
      "properties": {
        "abc": "def",
        "elevation": 5
      }
    }
  },
  "status": "new",
  "name": "my sdm for soil moisture",
  "description": "description goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

Risposta di esempio

Codice di stato:

200

{
  "type": "Sensor",
  "manufacturer": "Some sensor manufacturer",
  "productCode": "soil m",
  "measures": {
    "soilMoisture": {
      "description": "measures soil moisture",
      "dataType": "Bool",
      "type": "sm",
      "unit": "none",
      "properties": {
        "abc": "def",
        "elevation": 5
      }
    }
  },
  "sensorPartnerId": "sp1",
  "id": "sdm124",
  "status": "new",
  "createdDateTime": "2022-01-24T06:12:15Z",
  "modifiedDateTime": "2022-01-24T06:12:42Z",
  "eTag": "040161a2-0000-0700-0000-61ee435a0000",
  "name": "my sdm for soil moisture",
  "description": "description goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

Codice di stato:

201

{
  "type": "Sensor",
  "manufacturer": "Some sensor manufacturer",
  "productCode": "soil m",
  "measures": {
    "soilMoisture": {
      "description": "measures soil moisture",
      "dataType": "Bool",
      "type": "sm",
      "unit": "none",
      "properties": {
        "abc": "def",
        "elevation": 5
      }
    }
  },
  "sensorPartnerId": "sp1",
  "id": "sdm124",
  "status": "new",
  "createdDateTime": "2022-01-24T06:12:15Z",
  "modifiedDateTime": "2022-01-24T06:12:15Z",
  "eTag": "040158a0-0000-0700-0000-61ee433f0000",
  "name": "my sdm for soil moisture",
  "description": "description 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.
SensorDataModel	Modello API SensorModel.
SensorDataModelMeasure	Dettagli della misura del modello di sensore.
SensorDataType	Tipo di dati della misura del 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.

SensorDataModel

Modello API SensorModel.

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.
description	string	Descrizione testuale della risorsa.
eTag	string	Valore ETag per implementare la concorrenza ottimistica.
id	string	ID della risorsa.
manufacturer	string	Produttore del sensore.
measures	<string,  SensorDataModelMeasure>	Mappa del tipo di sensore alle misure del sensore.
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.
productCode	string	ProductCode del sensore.
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.
sensorPartnerId	string	ID del partner sensore associato.
status	string	Stato della risorsa.
type	string	Tipo di sensore.

SensorDataModelMeasure

Dettagli della misura del modello di sensore.

Nome	Tipo	Descrizione
dataType	SensorDataType	Tipo di dati della misura del sensore.
description	string	Descrizione della misura del sensore.
properties		Raccolta di coppie di valori chiave per il modello di dati del sensore. 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 un modello e solo per una stringa, un numero e una datatime (a-MM-ddTHH:mm:ssZ) sono supportati.
type	string	Tipo di misurazione dei dati del sensore.
unit	string	Unità di misura del sensore.

SensorDataType

Tipo di dati della misura del sensore.

Nome	Tipo	Descrizione
Bool	string
DateTime	string
Double	string
Long	string
String	string