Sensors - Create Or Update

Service:

Azure Data Manager for Agriculture

API-versie:

2023-11-01-preview

Maak een sensorentiteit.

PATCH {endpoint}/sensor-partners/{sensorPartnerId}/sensors/{sensorId}?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
sensorId	path	True	string	Id van de sensorresource.
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	Type	Description
depthInMeters	number[]	Diepte van elke sensormeting in meters. Zoals sensorvochtigheid op 2m, 4m, 6m.
description	string	Tekstuele beschrijving van de resource.
deviceId	string	Id van het gekoppelde apparaat.
hardwareId	string	Id van de bijbehorende hardware.
integrationId	string	Integratie-id voor het apparaat.
location	Location	Locatiemodelklasse.
name	string	Naam om resource te identificeren.
port	Port	Schema voor het opslaan van poortwaarden.
properties		Een verzameling sleutelwaardeparen die deel uitmaakt van de resource. Elk paar mag geen sleutel hebben die groter 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 tekenreeks-, numerieke en datum/tijd-waarden (jjjj-MM-ddTHH:mm:ssZ) worden ondersteund.
sensorDataModelId	string	Id van het bijbehorende sensorgegevensmodel.
status	string	Status van de resource.
type	string	Type sensor.

Antwoorden

Name	Type	Description
200 OK	Sensor	Geslaagd
201 Created	Sensor	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

Sensors_CreateOrUpdate

Voorbeeldaanvraag

HTTP

PATCH {endpoint}/sensor-partners/sp1/sensors/s124?api-version=2023-11-01-preview

{
  "sensorDataModelId": "sdm124",
  "integrationId": "string",
  "hardwareId": "SMHD 456",
  "deviceId": "d124",
  "type": "SM",
  "location": {
    "latitude": 23.5,
    "longitude": 42.7
  },
  "port": {
    "name": "measure",
    "type": "digital"
  },
  "status": "sm created",
  "name": "my new sm",
  "description": "description for sensor goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

Voorbeeldrespons

Statuscode:

200

{
  "sensorDataModelId": "sdm124",
  "integrationId": "string",
  "hardwareId": "SMHD-456",
  "deviceId": "d124",
  "type": "SM",
  "location": {
    "latitude": 23.5,
    "longitude": 42.7
  },
  "port": {
    "name": "measure",
    "type": "digital"
  },
  "sensorPartnerId": "sp1",
  "id": "s124",
  "status": "sm created",
  "createdDateTime": "2022-01-24T06:27:05Z",
  "modifiedDateTime": "2022-01-24T06:27:05Z",
  "eTag": "040139eb-0000-0700-0000-61ee46b90000",
  "name": "my new sm",
  "description": "description for sensor goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

Statuscode:

201

{
  "sensorDataModelId": "sdm124",
  "integrationId": "string",
  "hardwareId": "SMHD-456",
  "deviceId": "d124",
  "type": "SM",
  "location": {
    "latitude": 23.5,
    "longitude": 42.7
  },
  "port": {
    "name": "measure",
    "type": "digital"
  },
  "sensorPartnerId": "sp1",
  "id": "s124",
  "status": "sm created",
  "createdDateTime": "2022-01-24T06:27:05Z",
  "modifiedDateTime": "2022-01-24T06:27:05Z",
  "eTag": "040139eb-0000-0700-0000-61ee46b90000",
  "name": "my new sm",
  "description": "description for sensor 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 voor innerError-referentiedocument.
Location	Locatiemodelklasse.
Port	Schema voor het opslaan van poortwaarden.
Sensor	Sensor-API-model.

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 voor innerError-referentiedocument.
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 voor innerError-referentiedocument.

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 voor innerError-referentiedocument.

Location

Locatiemodelklasse.

Name	Type	Description
latitude	number	Breedtegraad van de locatie.
longitude	number	Lengtegraad van de locatie.

Port

Schema voor het opslaan van poortwaarden.

Name	Type	Description
name	string	Naam van de poort.
type	string	Type poort digitaal/analoog.

Sensor

Sensor-API-model.

Name	Type	Description
createdBy	string	Gemaakt door gebruikers-/tenant-id.
createdDateTime	string	Datum-tijd waarop de resource is gemaakt, voorbeeldindeling: jjjj-MM-ddTHH:mm:ssZ.
depthInMeters	number[]	Diepte van elke sensormeting in meters. Zoals sensorvochtigheid op 2m, 4m, 6m.
description	string	Tekstuele beschrijving van de resource.
deviceId	string	Id van het gekoppelde apparaat.
eTag	string	De ETag-waarde voor het implementeren van optimistische gelijktijdigheid.
hardwareId	string	Id van de bijbehorende hardware.
id	string	Id van de resource.
integrationId	string	Integratie-id voor het apparaat.
location	Location	Locatiemodelklasse.
modifiedBy	string	Gewijzigd door 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 resource te identificeren.
port	Port	Schema voor het opslaan van poortwaarden.
properties		Een verzameling sleutelwaardeparen die deel uitmaakt van de resource. Elk paar mag geen sleutel hebben die groter 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 tekenreeks-, numerieke en datum/tijd-waarden (jjjj-MM-ddTHH:mm:ssZ) worden ondersteund.
sensorDataModelId	string	Id van het bijbehorende sensorgegevensmodel.
sensorPartnerId	string	Id van de gekoppelde sensorpartner.
status	string	Status van de resource.
type	string	Type sensor.