Sensor Data Models - Create Or Update
Algılayıcı veri modeli varlığı oluşturma.
PATCH {endpoint}/sensor-partners/{sensorPartnerId}/sensor-data-models/{sensorDataModelId}?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 |
sensor
|
path | True |
string |
Algılayıcı veri modelinin kimliği. |
sensor
|
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 | Gerekli | Tür | Description |
---|---|---|---|
measures | True |
<string,
Sensor |
Algılayıcı türünün sensör ölçülerine haritası. |
description |
string |
Kaynağın metinsel açıklaması. |
|
manufacturer |
string |
Algılayıcı üreticisi. |
|
name |
string |
Kaynağı tanımlamak için ad. |
|
productCode |
string |
Algılayıcı productCode. |
|
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. |
||
status |
string |
Kaynağın durumu. |
|
type |
string |
Algılayıcı türü. |
Yanıtlar
Name | Tür | Description |
---|---|---|
200 OK |
Başarılı |
|
201 Created |
Oluşturulan |
|
Other Status Codes |
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
SensorDataModels_CreateOrUpdate
Örnek isteği
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
}
}
Örnek yanıt
{
"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
}
}
{
"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
}
}
Tanımlar
Name | Description |
---|---|
Error |
Azure AgPlatform hizmetinden bir hata. |
Error |
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 . |
Inner |
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 . |
Sensor |
SensorModel API modeli. |
Sensor |
Algılayıcı modeli ölçüm ayrıntıları. |
Sensor |
Algılayıcı ölçü veri türü. |
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 |
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 |
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 |
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 . |
SensorDataModel
SensorModel API 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. |
description |
string |
Kaynağın metinsel açıklaması. |
eTag |
string |
İyimser eşzamanlılık uygulamak için ETag değeri. |
id |
string |
Kaynağın kimliği. |
manufacturer |
string |
Algılayıcı üreticisi. |
measures |
<string,
Sensor |
Algılayıcı türünün sensör ölçülerine haritası. |
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. |
productCode |
string |
Algılayıcı productCode. |
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. |
|
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ü. |
SensorDataModelMeasure
Algılayıcı modeli ölçüm ayrıntıları.
Name | Tür | Description |
---|---|---|
dataType |
Algılayıcı ölçü veri türü. |
|
description |
string |
Algılayıcı ölçüsünün açıklaması. |
properties |
Algılayıcı veri modeli için anahtar değer çiftlerinden oluşan bir koleksiyon. 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: Model için en fazla 25 anahtar değer çifti sağlanabilir ve yalnızca dize, sayı ve tarih saat (yyyy-AA-ggTHH:mm:ssZ) değerleri desteklenir. |
|
type |
string |
Sensör verilerinin ölçüm türü. |
unit |
string |
Algılayıcı ölçüsü birimi. |
SensorDataType
Algılayıcı ölçü veri türü.
Name | Tür | Description |
---|---|---|
Bool |
string |
|
DateTime |
string |
|
Double |
string |
|
Long |
string |
|
String |
string |