Sensors - Create Or Update

Hizmet:

Azure Data Manager for Agriculture

API Sürümü:

2023-11-01-preview

Bir algılayıcı varlığı oluşturun.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
endpoint	path	True	string uri	Ad alanının ana bilgisayar adı, örneğin admaInstanceName.farmbeats.azure.net
sensorId	path	True	string	Algılayıcı kaynağının kimliği.
sensorPartnerId	path	True	string	Algılayıcı iş ortağının kimliği.
api-version	query	True	string	İstenen API sürümü

İstek Başlığı

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

Name	Gerekli	Tür	Description
Authorization	True	string	Lütfen yetkili API çağrıları için geçerli bir taşıyıcı belirteci sağlayın. Kimliği doğrulanmamış çağrıları daha önce denediyseniz tarayıcı önbelleğinizi temizlemeniz gerekebileceğini unutmayın.

İstek Gövdesi

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

Name	Tür	Description
depthInMeters	number[]	Ölçümlerdeki her algılayıcı ölçüsünün derinliği. 2m, 4m, 6m'de sensör nemi gibi.
description	string	Kaynağın metinsel açıklaması.
deviceId	string	İlişkili cihazın kimliği.
hardwareId	string	İlişkili donanımın kimliği.
integrationId	string	Cihazın tümleştirme kimliği.
location	Location	Konum modeli sınıfı.
name	string	Kaynağı tanımlamak için ad.
port	Port	Bağlantı noktası değerlerini depolama şeması.
properties		Kaynağa ait anahtar değer çiftleri koleksiyonu. Her çiftin 50 karakterden büyük bir anahtarı olmamalıdır ve 150 karakterden büyük bir değere sahip olmamalıdır. Not: Bir kaynak için en fazla 25 anahtar değer çifti sağlanabilir ve yalnızca dize, sayı ve datetime (yyyy-MM-ddTHH:mm:ssZ) değerleri desteklenir.
sensorDataModelId	string	İlişkili algılayıcı veri modelinin kimliği.
status	string	Kaynağın durumu.
type	string	Algılayıcı türü.

Yanıtlar

Name	Tür	Description
200 OK	Sensor	Başarılı
201 Created	Sensor	Oluşturulan
Other Status Codes	ErrorResponse	Hata Üst Bilgiler x-ms-error-code: string

Güvenlik

Authorization

Lütfen yetkili API çağrıları için geçerli bir taşıyıcı belirteci sağlayın. Kimliği doğrulanmamış çağrıları daha önce denediyseniz tarayıcı önbelleğinizi temizlemeniz gerekebileceğini unutmayın.

Tür: apiKey
İçinde: header

Örnekler

Sensors_CreateOrUpdate

Örnek isteği

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

Örnek yanıt

Durum kodu:

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

Durum kodu:

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

Tanımlar

Name	Description
Error	Azure AgPlatform hizmetinden bir hata.
ErrorResponse	Azure AgPlatform hizmetinden bir hata yanıtı. ErrorResponse başvuru belgesi için bkz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses .
InnerError	Hata listesini içeren iç hata. InnerError başvuru belgesi için bkz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object .
Location	Konum modeli sınıfı.
Port	Bağlantı noktası değerlerini depolama şeması.
Sensor	Algılayıcı API'si modeli.

Error

Azure AgPlatform hizmetinden bir hata.

Name	Tür	Description
code	string	Sunucu tanımlı hata kodları kümesi.
details	Error[]	Bu bildirilen hataya yol açan belirli hatalarla ilgili ayrıntılar dizisi.
innererror	InnerError	Hata listesini içeren iç hata. InnerError başvuru belgesi için bkz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object .
message	string	Hatanın insan tarafından okunabilir gösterimi.
target	string	Hatanın hedefi.

ErrorResponse

Azure AgPlatform hizmetinden bir hata yanıtı. ErrorResponse başvuru belgesi için bkz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses .

Name	Tür	Description
error	Error	Azure AgPlatform hizmetinden bir hata.
traceId	string	Benzersiz izleme kimliği.

InnerError

Hata listesini içeren iç hata. InnerError başvuru belgesi için bkz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object .

Name	Tür	Description
code	string	İçeren hata tarafından sağlanandan özel hata kodu.
innererror	InnerError	Hata listesini içeren iç hata. InnerError başvuru belgesi için bkz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object .

Location

Konum modeli sınıfı.

Name	Tür	Description
latitude	number	Konumun enlemi.
longitude	number	Konumun boylamı.

Port

Bağlantı noktası değerlerini depolama şeması.

Name	Tür	Description
name	string	Bağlantı noktasının adı.
type	string	Dijital/analog bağlantı noktası türü.

Sensor

Algılayıcı API'si modeli.

Name	Tür	Description
createdBy	string	Kullanıcı/kiracı kimliği tarafından oluşturulur.
createdDateTime	string	Kaynağın oluşturulduğu tarih-saat, örnek biçim: yyyy-MM-ddTHH:mm:ssZ.
depthInMeters	number[]	Ölçümlerdeki her algılayıcı ölçüsünün derinliği. 2m, 4m, 6m'de sensör nemi gibi.
description	string	Kaynağın metinsel açıklaması.
deviceId	string	İlişkili cihazın kimliği.
eTag	string	İyimser eşzamanlılık uygulamak için ETag değeri.
hardwareId	string	İlişkili donanımın kimliği.
id	string	Kaynağın kimliği.
integrationId	string	Cihazın tümleştirme kimliği.
location	Location	Konum modeli sınıfı.
modifiedBy	string	Kullanıcı/kiracı kimliği tarafından değiştirildi.
modifiedDateTime	string	Kaynağın en son değiştirildiği tarih-saat, örnek biçim: yyyy-MM-ddTHH:mm:ssZ.
name	string	Kaynağı tanımlamak için ad.
port	Port	Bağlantı noktası değerlerini depolama şeması.
properties		Kaynağa ait anahtar değer çiftleri koleksiyonu. Her çiftin 50 karakterden büyük bir anahtarı olmamalıdır ve 150 karakterden büyük bir değere sahip olmamalıdır. Not: Bir kaynak için en fazla 25 anahtar değer çifti sağlanabilir ve yalnızca dize, sayı ve datetime (yyyy-MM-ddTHH:mm:ssZ) değerleri desteklenir.
sensorDataModelId	string	İlişkili algılayıcı veri modelinin kimliği.
sensorPartnerId	string	İlişkili algılayıcı iş ortağının kimliği.
status	string	Kaynağın durumu.
type	string	Algılayıcı türü.