Sensor Data Models - Create Or Update

Referentie

Service:: Azure Data Manager for Agriculture

API-versie:: 2023-11-01-preview

Maak een entiteit sensorgegevensmodel.

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string uri	De hostnaam van de naamruimte, bijvoorbeeld admaInstanceName.farmbeats.azure.net
sensorDataModelId	path	True	string	Id van het sensorgegevensmodel.
sensorPartnerId	path	True	string	Id van de sensorpartner.
api-version	query	True	string	De aangevraagde API-versie

Aanvraagkoptekst

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

Name	Vereist	Type	Description
Authorization	True	string	Geef een geldig Bearer-token op voor geautoriseerde API-aanroepen. Houd er rekening mee dat u mogelijk uw browsercache moet wissen als u eerder niet-geverifieerde aanroepen hebt geprobeerd.

Aanvraagbody

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

Name	Vereist	Type	Description
measures	True	<string, SensorDataModelMeasure>	Toewijzing van sensortype aan sensormetingen.
description		string	Tekstuele beschrijving van de resource.
manufacturer		string	Sensorfabrikant.
name		string	Naam om de resource te identificeren.
productCode		string	SensorproductCode.
properties			Een verzameling sleutelwaardeparen die deel uitmaakt van de resource. Elk paar mag geen sleutel hebben die langer is dan 50 tekens en mag geen waarde van meer dan 150 tekens hebben. Opmerking: er kunnen maximaal 25 sleutelwaardeparen worden opgegeven voor een resource en alleen waarden voor tekenreeks, numeriek en datum/tijd (jjjj-MM-ddTHH:mm:ssZ) worden ondersteund.
status		string	Status van de resource.
type		string	Type sensor.

Antwoorden

Name	Type	Description
200 OK	SensorDataModel	Geslaagd
201 Created	SensorDataModel	Gemaakt
Other Status Codes	ErrorResponse	Fout Kopteksten x-ms-error-code: string

Name

Type

Description

200 OK

SensorDataModel

Geslaagd

201 Created

SensorDataModel

Gemaakt

Other Status Codes

ErrorResponse

Fout

Kopteksten

x-ms-error-code: string

Beveiliging

Authorization

Geef een geldig Bearer-token op voor geautoriseerde API-aanroepen. Houd er rekening mee dat u mogelijk uw browsercache moet wissen als u eerder niet-geverifieerde aanroepen hebt geprobeerd.

Type: apiKey
In: header

Voorbeelden

SensorDataModels_CreateOrUpdate

Voorbeeldaanvraag

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

Voorbeeldrespons

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

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

Definities

Name	Description
Error	Een fout van de Azure AgPlatform-service.
ErrorResponse	Een foutreactie van de Azure AgPlatform-service. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses voor het referentiedocument ErrorResponse.
InnerError	Interne fout met een lijst met fouten. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object het referentiedocument innerError voor meer informatie.
SensorDataModel	SensorModel API-model.
SensorDataModelMeasure	Metingdetails van sensormodel.
SensorDataType	Gegevenstype sensormeting.

Error

Een fout van de Azure AgPlatform-service.

Name	Type	Description
code	string	Door de server gedefinieerde set foutcodes.
details	Error[]	Matrix met details over specifieke fouten die tot deze gerapporteerde fout hebben geleid.
innererror	InnerError	Interne fout met een lijst met fouten. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object het referentiedocument innerError voor meer informatie.
message	string	Door mensen leesbare weergave van de fout.
target	string	Doel van de fout.

ErrorResponse

Een foutreactie van de Azure AgPlatform-service. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses voor het referentiedocument ErrorResponse.

Name	Type	Description
error	Error	Een fout van de Azure AgPlatform-service.
traceId	string	Unieke tracerings-id.

InnerError

Interne fout met een lijst met fouten. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object het referentiedocument innerError voor meer informatie.

Name	Type	Description
code	string	Specifieke foutcode dan is opgegeven door de betreffende fout.
innererror	InnerError	Interne fout met een lijst met fouten. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object het referentiedocument innerError voor meer informatie.

SensorDataModel

SensorModel API-model.

Name	Type	Description
createdBy	string	Gemaakt door de gebruiker/tenant-id.
createdDateTime	string	Datum/tijd waarop de resource is gemaakt, voorbeeldindeling: jjjj-MM-ddTHH:mm:ssZ.
description	string	Tekstuele beschrijving van de resource.
eTag	string	De ETag-waarde voor het implementeren van optimistische gelijktijdigheid.
id	string	Id van de resource.
manufacturer	string	Sensorfabrikant.
measures	<string, SensorDataModelMeasure>	Toewijzing van sensortype aan sensormetingen.
modifiedBy	string	Gewijzigd door de gebruiker/tenant-id.
modifiedDateTime	string	Datum/tijd waarop de resource voor het laatst is gewijzigd, voorbeeldindeling: jjjj-MM-ddTHH:mm:ssZ.
name	string	Naam om de resource te identificeren.
productCode	string	SensorproductCode.
properties		Een verzameling sleutelwaardeparen die deel uitmaakt van de resource. Elk paar mag geen sleutel hebben die langer is dan 50 tekens en mag geen waarde van meer dan 150 tekens hebben. Opmerking: er kunnen maximaal 25 sleutelwaardeparen worden opgegeven voor een resource en alleen waarden voor tekenreeks, numeriek en datum/tijd (jjjj-MM-ddTHH:mm:ssZ) worden ondersteund.
sensorPartnerId	string	Id van de gekoppelde sensorpartner.
status	string	Status van de resource.
type	string	Type sensor.

SensorDataModelMeasure

Metingdetails van sensormodel.

Name	Type	Description
dataType	SensorDataType	Gegevenstype sensormeting.
description	string	Beschrijving van sensormeting.
properties		Een verzameling sleutelwaardeparen voor het sensorgegevensmodel. Elk paar mag geen sleutel hebben die langer is dan 50 tekens en mag geen waarde van meer dan 150 tekens hebben. Opmerking: er kunnen maximaal 25 sleutelwaardeparen worden opgegeven voor een model en alleen waarden voor tekenreeks, numeriek en datum/tijd (jjjj-MM-ddTHH:mm:ssZ) worden ondersteund.
type	string	Meettype van sensorgegevens.
unit	string	Eenheid van sensormeting.

SensorDataType

Gegevenstype sensormeting.

Name	Type	Description
Bool	string
DateTime	string
Double	string
Long	string
String	string

Delen via

Sensor Data Models - Create Or Update

URI-parameters

Aanvraagkoptekst

Aanvraagbody

Antwoorden

Beveiliging

Authorization

Voorbeelden

SensorDataModels_CreateOrUpdate

Voorbeeldaanvraag

Voorbeeldrespons

Definities

Error

ErrorResponse

InnerError

SensorDataModel

SensorDataModelMeasure

SensorDataType

Aanvullende resources