Sensor Data Models - Create Or Update

Referens

Tjänst:: Azure Data Manager for Agriculture

API-version:: 2023-11-01-preview

Skapa en sensordatamodellentitet.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string (uri)	Namnområdets värdnamn, t.ex. admaInstanceName.farmbeats.azure.net
sensorDataModelId	path	True	string	ID för sensordatamodellen.
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	Obligatorisk	Typ	Description
measures	True	<string, SensorDataModelMeasure>	Karta över sensortyp till sensormått.
description		string minLength: 0 maxLength: 500	Textbeskrivning av resursen.
manufacturer		string minLength: 0 maxLength: 100	Sensortillverkare.
name		string minLength: 0 maxLength: 100	Namn för att identifiera resursen.
productCode		string minLength: 0 maxLength: 100	Sensor productCode.
properties			En samling nyckelvärdepar 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 nyckelvärdepar kan anges för en resurs och endast värden för sträng, siffror och datetime (åååå-MM-ddTHH:mm:ssZ) stöds.
status		string minLength: 0 maxLength: 100	Status för resursen.
type		string minLength: 0 maxLength: 100	Typ av sensor.

Svar

Name	Typ	Description
200 OK	SensorDataModel	Framgång
201 Created	SensorDataModel	Skapad
Other Status Codes	ErrorResponse	Fel Sidhuvuden x-ms-error-code: string

Name

Typ

Description

200 OK

SensorDataModel

Framgång

201 Created

SensorDataModel

Skapad

Other Status Codes

ErrorResponse

Fel

Sidhuvuden

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.

Typ: apiKey
I: header

Exempel

SensorDataModels_CreateOrUpdate

Exempelbegäran

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

Exempelsvar

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

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

Definitioner

Name	Description
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-referensdokumentet.
InnerError	Inre fel som innehåller en lista över fel. Se referensdokumentet https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object för InnerError.
SensorDataModel	SensorModel API-modell.
SensorDataModelMeasure	Mätinformation för sensormodell.
SensorDataType	Sensormått för datatyp.

Error

Objekt

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

Name	Typ	Description
code	string minLength: 1	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 en lista över fel. Se referensdokumentet https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object för InnerError.
message	string minLength: 1	Mänsklig läsbar representation av felet.
target	string	Målet för felet.

ErrorResponse

Objekt

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-referensdokumentet.

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

InnerError

Objekt

Inre fel som innehåller en lista över fel. Se referensdokumentet https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 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 en lista över fel. Se referensdokumentet https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object för InnerError.

SensorDataModel

Objekt

SensorModel API-modell.

Name	Typ	Description
createdBy	string	Skapad av användar-/klient-ID.
createdDateTime	string (date-time)	Datum-tid när resursen skapades, exempelformat: åååå-MM-ddTHH:mm:ssZ.
description	string minLength: 0 maxLength: 500	Textbeskrivning av resursen.
eTag	string	ETag-värdet för att implementera optimistisk samtidighet.
id	string	ID för resursen.
manufacturer	string minLength: 0 maxLength: 100	Sensortillverkare.
measures	<string, SensorDataModelMeasure>	Karta över sensortyp till sensormått.
modifiedBy	string	Ändrat av användar-/klient-ID.
modifiedDateTime	string (date-time)	Datum-tid när resursen senast ändrades, exempelformat: åååå-MM-ddTHH:mm:ssZ.
name	string minLength: 0 maxLength: 100	Namn för att identifiera resursen.
productCode	string minLength: 0 maxLength: 100	Sensor productCode.
properties		En samling nyckelvärdepar 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 nyckelvärdepar kan anges för en resurs och endast värden för sträng, siffror och datetime (åååå-MM-ddTHH:mm:ssZ) stöds.
sensorPartnerId	string	ID för den associerade sensorpartnern.
status	string minLength: 0 maxLength: 100	Status för resursen.
type	string minLength: 0 maxLength: 100	Typ av sensor.

SensorDataModelMeasure

Objekt

Mätinformation för sensormodell.

Name	Typ	Description
dataType	SensorDataType minLength: 2 maxLength: 100	Sensormått för datatyp.
description	string minLength: 0 maxLength: 500	Beskrivning av sensormått.
properties		En samling nyckelvärdepar för sensordatamodellen. 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 nyckelvärdepar kan anges för en modell och endast värden för sträng, siffror och datetime (åååå-MM-ddTHH:mm:ssZ) stöds.
type	string minLength: 0 maxLength: 100	Mättyp för sensordata.
unit	string minLength: 0 maxLength: 100	Enheten för sensormått.

SensorDataType

Uppräkning

Sensormått för datatyp.

Värde	Description
Bool
DateTime
Double
Long
String

Dela via

Sensor Data Models - Create Or Update

URI-parametrar

Begärandehuvud

Begärandetext

Svar

Säkerhet

Authorization

Exempel

SensorDataModels_CreateOrUpdate

Exempelbegäran

Exempelsvar

Definitioner

Error

ErrorResponse

InnerError

SensorDataModel

SensorDataModelMeasure

SensorDataType

Ytterligare resurser