Harvest Data - List
Tüm taraflar genelindeki hasat veri kaynaklarının sayfalandırılmış bir listesini döndürür.
GET /harvest-data?api-version=2023-06-01-preview
GET /harvest-data?minTotalYield={minTotalYield}&maxTotalYield={maxTotalYield}&minAvgYield={minAvgYield}&maxAvgYield={maxAvgYield}&minTotalWetMass={minTotalWetMass}&maxTotalWetMass={maxTotalWetMass}&minAvgWetMass={minAvgWetMass}&maxAvgWetMass={maxAvgWetMass}&minAvgMoisture={minAvgMoisture}&maxAvgMoisture={maxAvgMoisture}&minAvgSpeed={minAvgSpeed}&maxAvgSpeed={maxAvgSpeed}&sources={sources}&associatedBoundaryIds={associatedBoundaryIds}&minOperationStartDateTime={minOperationStartDateTime}&maxOperationStartDateTime={maxOperationStartDateTime}&minOperationEndDateTime={minOperationEndDateTime}&maxOperationEndDateTime={maxOperationEndDateTime}&minOperationModifiedDateTime={minOperationModifiedDateTime}&maxOperationModifiedDateTime={maxOperationModifiedDateTime}&minArea={minArea}&maxArea={maxArea}&ids={ids}&names={names}&propertyFilters={propertyFilters}&statuses={statuses}&minCreatedDateTime={minCreatedDateTime}&maxCreatedDateTime={maxCreatedDateTime}&minLastModifiedDateTime={minLastModifiedDateTime}&maxLastModifiedDateTime={maxLastModifiedDateTime}&maxPageSize={maxPageSize}&skipToken={skipToken}&api-version=2023-06-01-preview
URI Parametreleri
| Name | İçinde | Gerekli | Tür | Description |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
İstenen API sürümü |
|
associated
|
query |
string[] |
İşlem verileriyle ilişkili sınır kimlikleri. |
|
|
ids
|
query |
string[] |
Kaynağın kimlikleri. |
|
|
max
|
query |
number (double) |
İşlemin uygulandığı maksimum alan (dahil). |
|
|
max
|
query |
number (double) |
Maksimum AvgMoisture değeri (dahil). |
|
|
max
|
query |
number (double) |
Maksimum AvgSpeed değeri (dahil). |
|
|
max
|
query |
number (double) |
Maksimum AvgWetMass değeri (dahil). |
|
|
max
|
query |
number (double) |
Maksimum AvgYield değeri (dahil). |
|
|
max
|
query |
string (date-time) |
Kaynak oluşturma tarihi üst sınırı (dahil). |
|
|
max
|
query |
string (date-time) |
Kaynağın en son değiştirilme tarihi üst sınırı (dahil). |
|
|
max
|
query |
string (date-time) |
İşlem verilerinin en yüksek bitiş tarihi-saati, örnek biçimi: yyyy-MM-ddTHH:mm:ssZ (dahil). |
|
|
max
|
query |
string (date-time) |
İşlem verilerinin değiştirme tarihi-saati üst sınırı, örnek biçimi: yyyy-MM-ddTHH:mm:ssZ (dahil). |
|
|
max
|
query |
string (date-time) |
İşlem verilerinin başlangıç tarihi-saati üst sınırı, örnek biçimi: yyyy-MM-ddTHH:mm:ssZ (dahil). |
|
|
max
|
query |
integer (int32) minimum: 10maximum: 1000 |
Gereken en fazla öğe sayısı (dahil). Minimum = 10, Maksimum = 1000, Varsayılan değer = 50. |
|
|
max
|
query |
number (double) |
Maksimum Toplam WetMass değeri (dahil). |
|
|
max
|
query |
number (double) |
Maksimum Verim değeri (dahil). |
|
|
min
|
query |
number (double) |
İşlemin uygulandığı en düşük alan (dahil). |
|
|
min
|
query |
number (double) |
Minimum AvgMoisture değeri (dahil). |
|
|
min
|
query |
number (double) |
Minimum AvgSpeed değeri (dahil). |
|
|
min
|
query |
number (double) |
Minimum AvgWetMass değeri (dahil). |
|
|
min
|
query |
number (double) |
Minimum AvgYield değeri (dahil). |
|
|
min
|
query |
string (date-time) |
Kaynağın en düşük oluşturma tarihi (dahil). |
|
|
min
|
query |
string (date-time) |
Kaynağın en son değiştirilme tarihi (dahil). |
|
|
min
|
query |
string (date-time) |
İşlem verilerinin en düşük bitiş tarihi-saati, örnek biçimi: yyyy-MM-ddTHH:mm:ssZ (dahil). |
|
|
min
|
query |
string (date-time) |
İşlem verilerinin en düşük değiştirme tarihi-saati, örnek biçimi: yyyy-MM-ddTHH:mm:ssZ (dahil). |
|
|
min
|
query |
string (date-time) |
İşlem verilerinin en düşük başlangıç tarihi-saati, örnek biçimi: yyyy-MM-ddTHH:mm:ssZ (dahil). |
|
|
min
|
query |
number (double) |
Minimum Toplam WetMass değeri (dahil). |
|
|
min
|
query |
number (double) |
Minimum Verim değeri (dahil). |
|
|
names
|
query |
string[] |
Kaynağın adları. |
|
|
property
|
query |
string[] |
Özellikler nesnesi içindeki anahtar-değer çiftlerini filtreler. örneğin. "{testKey} eq {testValue}". |
|
|
skip
|
query |
string |
Sonraki sonuç kümesini almak için belirteci atlayın. |
|
|
sources
|
query |
string[] |
İşlem verilerinin kaynakları. |
|
|
statuses
|
query |
string[] |
Kaynağın durumları. |
İstek Başlığı
| 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. |
Yanıtlar
| Name | Tür | Description |
|---|---|---|
| 200 OK |
Başarı |
|
| 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
HarvestData_List
Örnek isteği
GET /harvest-data?api-version=2023-06-01-preview
Örnek yanıt
{
"value": [
{
"partyId": "PARTY123",
"id": "HARVESTOP123",
"source": "Manual",
"name": "Harvest data for North Farm",
"description": "some description",
"status": "Active",
"operationStartDateTime": "2021-04-21T06:49:30Z",
"operationEndDateTime": "2021-04-21T06:49:30Z",
"operationModifiedDateTime": "2021-04-21T06:49:30Z",
"associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY",
"area": {
"unit": "acre",
"value": 50
},
"totalYield": {
"unit": "kilos",
"value": 1400
},
"avgYield": {
"unit": "kilosperacre",
"value": 28
},
"totalWetMass": {
"unit": "kilos",
"value": 500
},
"avgWetMass": {
"unit": "kilosperacre",
"value": 10
},
"avgMoisture": {
"unit": "percent",
"value": 14.61
},
"avgSpeed": {
"unit": "kmsperhour",
"value": 7.2
},
"harvestProductDetails": [
{
"productName": "VAR1",
"area": {
"unit": "acre",
"value": 30
},
"totalYield": {
"unit": "kilos",
"value": 900
},
"avgYield": {
"unit": "kilosperacre",
"value": 30
},
"totalWetMass": {
"unit": "kilos",
"value": 300
},
"avgWetMass": {
"unit": "kilosperacre",
"value": 10
},
"avgMoisture": {
"unit": "percent",
"value": 16.4
}
}
],
"properties": {
"Region": "Europe",
"CountyCode": 123
},
"attachmentsLink": "https://<resource-name>.farmbeats.azure.net/party/{{partyId}}/attachments?api-version={{apiVersion}}&resourceIds={{harvestDataId}}&resourceTypes=HarvestData",
"createdDateTime": "2021-04-21T06:49:30Z",
"modifiedDateTime": "2021-04-21T06:49:30Z",
"eTag": "cb00a3ac-0000-0100-0000-601d21ec0000"
}
],
"skipToken": "string",
"nextLink": "https:/{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/harvestData?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7ehK8eAKzdo1MNnwcAAAAAAA%3d%3d%23RT%3a1%23TRC%3a10%23ISV%3a2%23IEO%3a65551%23FPC%3aAQ2fBwAAAAAAD58HAAAAAAA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d"
}
Tanımlar
| Name | Description |
|---|---|
| Error |
Azure AgPlatform hizmetinden bir hata. |
|
Error |
Azure AgPlatform hizmetinden bir hata yanıtı. ErrorResponse başvuru belgesi için https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses bakın. |
|
Harvest |
Veri toplama kaynağının şeması. |
|
Harvest |
Disk belleğine alınan yanıt, istenen nesnelerin listesini ve sonraki sonuç kümesini almak için bir URL bağlantısı içerir. |
|
Harvest |
Hasat sırasında kullanılan ürünün şeması. |
|
Inner |
Hata listesini içeren iç hata. InnerError başvuru belgesi için https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object bakın. |
| Measure |
Ölçüm okuma ve birimi depolama şeması. |
Error
Azure AgPlatform hizmetinden bir hata.
| Name | Tür | Description |
|---|---|---|
| code |
string minLength: 1 |
Sunucu tanımlı hata kodları kümesi. |
| details |
Error[] |
Bu bildirilen hataya neden olan belirli hatalar hakkındaki ayrıntılar dizisi. |
| innererror |
Hata listesini içeren iç hata. InnerError başvuru belgesi için https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object bakın. |
|
| message |
string minLength: 1 |
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 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses bakın.
| Name | Tür | Description |
|---|---|---|
| error |
Azure AgPlatform hizmetinden bir hata. |
|
| traceId |
string |
Benzersiz izleme kimliği. |
HarvestData
Veri toplama kaynağının şeması.
| Name | Tür | Description |
|---|---|---|
| area |
Ölçüm okuma ve birimi depolama şeması. |
|
| associatedBoundaryId |
string |
İşlemin uygulandığı alanın isteğe bağlı sınır kimliği. |
| attachmentsLink |
string |
Eklerin bağlantısı. |
| avgMoisture |
Ölçüm okuma ve birimi depolama şeması. |
|
| avgSpeed |
Ölçüm okuma ve birimi depolama şeması. |
|
| avgWetMass |
Ölçüm okuma ve birimi depolama şeması. |
|
| avgYield |
Ölçüm okuma ve birimi depolama şeması. |
|
| createdBy |
string |
Kullanıcı/kiracı kimliği tarafından oluşturulur. |
| createdDateTime |
string (date-time) |
Kaynağın oluşturulduğu tarih-saat, örnek biçim: yyyy-MM-ddTHH:mm:ssZ. |
| description |
string minLength: 0maxLength: 500 |
Kaynağın metinsel açıklaması. |
| eTag |
string |
İyimser eşzamanlılık uygulamak için ETag değeri. |
| harvestProductDetails |
Ürün ayrıntılarını hasat edin. |
|
| id |
string |
Benzersiz kaynak kimliği. |
| modifiedBy |
string |
Kullanıcı/kiracı kimliği tarafından değiştirildi. |
| modifiedDateTime |
string (date-time) |
Kaynağın en son değiştirildiği tarih-saat, örnek biçim: yyyy-MM-ddTHH:mm:ssZ. |
| name |
string minLength: 0maxLength: 100 |
Kaynağı tanımlamak için ad. |
| operationEndDateTime |
string (date-time) |
İşlem verilerinin bitiş tarih-saati, örnek biçimi: yyyy-MM-ddTHH:mm:ssZ. |
| operationModifiedDateTime |
string (date-time) |
İşlem verilerinin tarih-saati değiştirildi, örnek biçimi: yyyy-MM-ddTHH:mm:ssZ. Not: Bu, kaynak sağlayıcının kendisi tarafından belirtilir. |
| operationStartDateTime |
string (date-time) |
İşlem verilerinin başlangıç tarih-saati, örnek biçimi: yyyy-MM-ddTHH:mm:ssZ. |
| partyId |
string |
İşlem verilerine ait olan taraf kimliği. |
| 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 tarih saat (yyyy-MM-ddTHH:mm:ssZ) değerleri desteklenir. |
|
| source |
string minLength: 2maxLength: 100 |
Kaynağın kaynağı. |
| status |
string minLength: 0maxLength: 100 |
Kaynağın durumu. |
| totalWetMass |
Ölçüm okuma ve birimi depolama şeması. |
|
| totalYield |
Ölçüm okuma ve birimi depolama şeması. |
HarvestDataListResponse
Disk belleğine alınan yanıt, istenen nesnelerin listesini ve sonraki sonuç kümesini almak için bir URL bağlantısı içerir.
| Name | Tür | Description |
|---|---|---|
| nextLink |
string |
Listede sonuçların sonraki sayfasına devam bağlantısı (mutlak URI). |
| skipToken |
string |
Sonraki sayfayı alırken kullanılan belirteç. Null ise, başka sayfa yoktur. |
| value |
İstenen nesnelerin listesi. |
HarvestProductDetail
Hasat sırasında kullanılan ürünün şeması.
| Name | Tür | Description |
|---|---|---|
| area |
Ölçüm okuma ve birimi depolama şeması. |
|
| avgMoisture |
Ölçüm okuma ve birimi depolama şeması. |
|
| avgWetMass |
Ölçüm okuma ve birimi depolama şeması. |
|
| avgYield |
Ölçüm okuma ve birimi depolama şeması. |
|
| productName |
string minLength: 1maxLength: 100 |
Ürünün adı. |
| totalWetMass |
Ölçüm okuma ve birimi depolama şeması. |
|
| totalYield |
Ölçüm okuma ve birimi depolama şeması. |
InnerError
Hata listesini içeren iç hata. InnerError başvuru belgesi için https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object bakın.
| Name | Tür | Description |
|---|---|---|
| code |
string |
İçeren hata tarafından sağlanandan belirli bir hata kodu. |
| innererror |
Hata listesini içeren iç hata. InnerError başvuru belgesi için https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object bakın. |
Measure
Ölçüm okuma ve birimi depolama şeması.
| Name | Tür | Description |
|---|---|---|
| unit |
string minLength: 1maxLength: 50 |
Veri birimi. |
| value |
number (double) |
Veri değeri. |