Sensor Data Models - Create Or Update

Referenz

Dienst:: Azure Data Manager for Agriculture

API-Version:: 2023-11-01-preview

Erstellen Sie eine Sensordatenmodellentität.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string uri	Der Hostname des Namespace, z. B. admaInstanceName.farmbeats.azure.net
sensorDataModelId	path	True	string	ID des Sensordatenmodells.
sensorPartnerId	path	True	string	ID des Sensorpartners.
api-version	query	True	string	Die angeforderte API-Version

Anforderungsheader

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

Name	Erforderlich	Typ	Beschreibung
Authorization	True	string	Geben Sie ein gültiges Bearertoken für autorisierte API-Aufrufe an. Beachten Sie, dass Sie ihren Browsercache möglicherweise löschen müssen, wenn Sie zuvor nicht authentifizierte Aufrufe ausprobiert haben.

Anforderungstext

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

Name	Erforderlich	Typ	Beschreibung
measures	True	<string, SensorDataModelMeasure>	Zuordnung des Sensortyps zu Sensormeasures.
description		string	Textbeschreibung der Ressource.
manufacturer		string	Sensorhersteller.
name		string	Der Name zur Identifizierung der Ressource.
productCode		string	Sensor productCode.
properties			Eine Auflistung von Schlüsselwertpaaren, die zur Ressource gehören. Jedes Paar darf keinen Schlüssel haben, der größer als 50 Zeichen ist, und darf keinen Wert größer als 150 Zeichen haben. Hinweis: Für eine Ressource können maximal 25 Schlüsselwertpaare bereitgestellt werden, und es werden nur Zeichenfolgen-, Numeral- und datetime-Werte (yyyy-MM-ddTHH:mm:ssZ) unterstützt.
status		string	Status der Ressource.
type		string	Typ des Sensors.

Antworten

Name	Typ	Beschreibung
200 OK	SensorDataModel	Erfolg
201 Created	SensorDataModel	Erstellt
Other Status Codes	ErrorResponse	Fehler Header x-ms-error-code: string

Name

Typ

Beschreibung

200 OK

SensorDataModel

Erfolg

201 Created

SensorDataModel

Erstellt

Other Status Codes

ErrorResponse

Fehler

Header

x-ms-error-code: string

Sicherheit

Authorization

Geben Sie ein gültiges Bearertoken für autorisierte API-Aufrufe an. Beachten Sie, dass Sie ihren Browsercache möglicherweise löschen müssen, wenn Sie zuvor nicht authentifizierte Aufrufe ausprobiert haben.

Typ: apiKey
In: header

Beispiele

SensorDataModels_CreateOrUpdate

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
Error	Ein Fehler vom Azure AgPlatform-Dienst.
ErrorResponse	Eine Fehlerantwort des Azure AgPlatform-Diensts. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses unter Referenzdokument zu ErrorResponse.
InnerError	Innerer Fehler, der eine Fehlerliste enthält. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object unter Referenzdokument zu InnerError.
SensorDataModel	SensorModel-API-Modell.
SensorDataModelMeasure	Details zum Messen des Sensormodells.
SensorDataType	Sensormeasurdatentyp.

Error

Ein Fehler vom Azure AgPlatform-Dienst.

Name	Typ	Beschreibung
code	string	Serverdefinierter Satz von Fehlercodes.
details	Error[]	Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	InnerError	Innerer Fehler, der eine Fehlerliste enthält. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object unter Referenzdokument zu InnerError.
message	string	Lesbare Darstellung des Fehlers.
target	string	Ziel des Fehlers.

ErrorResponse

Eine Fehlerantwort des Azure AgPlatform-Diensts. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses unter Referenzdokument zu ErrorResponse.

Name	Typ	Beschreibung
error	Error	Ein Fehler vom Azure AgPlatform-Dienst.
traceId	string	Eindeutige Ablaufverfolgungs-ID.

InnerError

Innerer Fehler, der eine Fehlerliste enthält. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object unter Referenzdokument zu InnerError.

Name	Typ	Beschreibung
code	string	Spezifischer Fehlercode, der vom enthaltenden Fehler bereitgestellt wurde.
innererror	InnerError	Innerer Fehler, der eine Fehlerliste enthält. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object unter Referenzdokument zu InnerError.

SensorDataModel

SensorModel-API-Modell.

Name	Typ	Beschreibung
createdBy	string	Erstellt von Benutzer-/Mandanten-ID.
createdDateTime	string	Datum und Uhrzeit der Erstellung der Ressource, Beispielformat: jjjj-MM-ttTHH:mm:ssZ.
description	string	Textbeschreibung der Ressource.
eTag	string	Der ETag-Wert, um optimistische Parallelität zu implementieren.
id	string	ID der Ressource.
manufacturer	string	Sensorhersteller.
measures	<string, SensorDataModelMeasure>	Zuordnung des Sensortyps zu Sensormeasures.
modifiedBy	string	Geändert durch Benutzer-/Mandanten-ID.
modifiedDateTime	string	Datum und Uhrzeit der letzten Änderung der Ressource, Beispielformat: jjjj-MM-ttTHH:mm:ssZ.
name	string	Der Name zur Identifizierung der Ressource.
productCode	string	Sensor productCode.
properties		Eine Auflistung von Schlüsselwertpaaren, die zur Ressource gehören. Jedes Paar darf keinen Schlüssel haben, der größer als 50 Zeichen ist, und darf keinen Wert größer als 150 Zeichen haben. Hinweis: Für eine Ressource können maximal 25 Schlüsselwertpaare bereitgestellt werden, und es werden nur Zeichenfolgen-, Numeral- und datetime-Werte (yyyy-MM-ddTHH:mm:ssZ) unterstützt.
sensorPartnerId	string	ID des zugeordneten Sensorpartners.
status	string	Status der Ressource.
type	string	Typ des Sensors.

SensorDataModelMeasure

Details zum Messen des Sensormodells.

Name	Typ	Beschreibung
dataType	SensorDataType	Sensormeasurdatentyp.
description	string	Beschreibung des Sensormeasures.
properties		Eine Sammlung von Schlüsselwertpaaren für das Sensordatenmodell. Jedes Paar darf keinen Schlüssel haben, der größer als 50 Zeichen ist, und darf keinen Wert größer als 150 Zeichen haben. Hinweis: Für ein Modell können maximal 25 Schlüsselwertpaare bereitgestellt werden, und es werden nur Zeichenfolgen-, Numeral- und datetime-Werte (yyyy-MM-ddTHH:mm:ssZ) unterstützt.
type	string	Messtyp der Sensordaten.
unit	string	Maßeinheit des Sensors.

SensorDataType

Sensormeasurdatentyp.

Name	Typ	Beschreibung
Bool	string
DateTime	string
Double	string
Long	string
String	string

Freigeben über

Sensor Data Models - Create Or Update

URI-Parameter

Anforderungsheader

Anforderungstext

Antworten

Sicherheit

Authorization

Beispiele

SensorDataModels_CreateOrUpdate

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Error

ErrorResponse

InnerError

SensorDataModel

SensorDataModelMeasure

SensorDataType

Zusätzliche Ressourcen