Sensor Data Models - Create Or Update

Usługa:

Azure Data Manager for Agriculture

Wersja interfejsu API:

2023-11-01-preview

Utwórz jednostkę modelu danych czujnika.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string uri	Nazwa hosta przestrzeni nazw, np. admaInstanceName.farmbeats.azure.net
sensorDataModelId	path	True	string	Identyfikator modelu danych czujnika.
sensorPartnerId	path	True	string	Identyfikator partnera czujnika.
api-version	query	True	string	Żądana wersja interfejsu API

Nagłówek żądania

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

Nazwa	Wymagane	Typ	Opis
Authorization	True	string	Podaj prawidłowy token elementu nośnego dla autoryzowanych wywołań interfejsu API. Pamiętaj, że może być konieczne wyczyszczenie pamięci podręcznej przeglądarki, jeśli wcześniej podjęto próbę nieuwierzytelnionego wywołania.

Treść żądania

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

Nazwa	Wymagane	Typ	Opis
measures	True	<string,  SensorDataModelMeasure>	Mapuj typ czujnika na miary czujników.
description		string	Tekstowy opis zasobu.
manufacturer		string	Producent czujnika.
name		string	Nazwa identyfikującego zasób.
productCode		string	Kod produktu czujnika.
properties			Kolekcja par klucz wartości, które należą do zasobu. Każda para nie może mieć klucza większego niż 50 znaków i nie może mieć wartości większej niż 150 znaków. Uwaga: dla zasobu można podać maksymalnie 25 par wartości klucza, a obsługiwane są tylko wartości ciągu, liczb i daty/godziny (rrrr-MM-ddTHH:mm:ssZ).
status		string	Stan zasobu.
type		string	Typ czujnika.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	SensorDataModel	Powodzenie
201 Created	SensorDataModel	Utworzone
Other Status Codes	ErrorResponse	Błąd Nagłówki x-ms-error-code: string

Zabezpieczenia

Authorization

Podaj prawidłowy token elementu nośnego dla autoryzowanych wywołań interfejsu API. Pamiętaj, że może być konieczne wyczyszczenie pamięci podręcznej przeglądarki, jeśli wcześniej podjęto próbę nieuwierzytelnionego wywołania.

Typ: apiKey
W: header

Przykłady

SensorDataModels_CreateOrUpdate

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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

Kod stanu:

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

Definicje

Nazwa	Opis
Error	Błąd usługi Azure AgPlatform.
ErrorResponse	Odpowiedź o błędzie z usługi Azure AgPlatform. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses dokument referencyjny ErrorResponse.
InnerError	Wewnętrzny błąd zawierający listę błędów. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object dokument referencyjny InnerError.
SensorDataModel	Model interfejsu API SensorModel.
SensorDataModelMeasure	Szczegóły miary modelu czujnika.
SensorDataType	Typ danych miary czujnika.

Error

Błąd usługi Azure AgPlatform.

Nazwa	Typ	Opis
code	string	Zestaw kodów błędów zdefiniowanych przez serwer.
details	Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	InnerError	Wewnętrzny błąd zawierający listę błędów. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object dokument referencyjny InnerError.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź o błędzie z usługi Azure AgPlatform. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses dokument referencyjny ErrorResponse.

Nazwa	Typ	Opis
error	Error	Błąd usługi Azure AgPlatform.
traceId	string	Unikatowy identyfikator śledzenia.

InnerError

Wewnętrzny błąd zawierający listę błędów. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object dokument referencyjny InnerError.

Nazwa	Typ	Opis
code	string	Określony kod błędu niż został dostarczony przez błąd zawierający.
innererror	InnerError	Wewnętrzny błąd zawierający listę błędów. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object dokument referencyjny InnerError.

SensorDataModel

Model interfejsu API SensorModel.

Nazwa	Typ	Opis
createdBy	string	Utworzony przez identyfikator użytkownika/dzierżawy.
createdDateTime	string	Data i godzina utworzenia zasobu, przykładowy format: rrrr-MM-ddTHH:mm:ssZ.
description	string	Tekstowy opis zasobu.
eTag	string	Wartość ETag do zaimplementowania optymistycznej współbieżności.
id	string	Identyfikator zasobu.
manufacturer	string	Producent czujnika.
measures	<string,  SensorDataModelMeasure>	Mapuj typ czujnika na miary czujników.
modifiedBy	string	Zmodyfikowane przez identyfikator użytkownika/dzierżawy.
modifiedDateTime	string	Data i godzina ostatniej modyfikacji zasobu, format próbki: rrrr-MM-ddTHH:mm:ssZ.
name	string	Nazwa identyfikującego zasób.
productCode	string	Kod produktu czujnika.
properties		Kolekcja par klucz wartości, które należą do zasobu. Każda para nie może mieć klucza większego niż 50 znaków i nie może mieć wartości większej niż 150 znaków. Uwaga: dla zasobu można podać maksymalnie 25 par wartości klucza, a obsługiwane są tylko wartości ciągu, liczb i daty/godziny (rrrr-MM-ddTHH:mm:ssZ).
sensorPartnerId	string	Identyfikator skojarzonego partnera czujnika.
status	string	Stan zasobu.
type	string	Typ czujnika.

SensorDataModelMeasure

Szczegóły miary modelu czujnika.

Nazwa	Typ	Opis
dataType	SensorDataType	Typ danych miary czujnika.
description	string	Opis miary czujnika.
properties		Kolekcja par klucz wartości dla modelu danych czujnika. Każda para nie może mieć klucza większego niż 50 znaków i nie może mieć wartości większej niż 150 znaków. Uwaga: dla modelu można podać maksymalnie 25 par wartości klucza, a obsługiwane są tylko wartości ciągu, liczb i daty/godziny (rrrr-MM-ddTHH:mm:ssZ).
type	string	Typ pomiaru danych czujnika.
unit	string	Jednostka miary czujnika.

SensorDataType

Typ danych miary czujnika.

Nazwa	Typ	Opis
Bool	string
DateTime	string
Double	string
Long	string
String	string