Management Zones - List By Farmer Id

Hizmet:

Azure Data Manager for Agriculture

API Sürümü:

2021-07-31-preview

Belirli bir çiftçinin altındaki yönetim bölgesi kaynaklarının sayfalandırılmış listesini döndürür.

GET /farmers/{farmerId}/management-zones?api-version=2021-07-31-preview

İsteğe bağlı parametrelerle:

GET /farmers/{farmerId}/management-zones?types={types}&cropIds={cropIds}&seasonIds={seasonIds}&fieldIds={fieldIds}&sources={sources}&ids={ids}&names={names}&propertyFilters={propertyFilters}&statuses={statuses}&minCreatedDateTime={minCreatedDateTime}&maxCreatedDateTime={maxCreatedDateTime}&minLastModifiedDateTime={minLastModifiedDateTime}&maxLastModifiedDateTime={maxLastModifiedDateTime}&$maxPageSize={$maxPageSize}&$skipToken={$skipToken}&api-version=2021-07-31-preview

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
farmerId	path	True	string	İlişkili çiftçinin kimliği.
api-version	query	True	string	İstenen API sürümü
$maxPageSize	query		integer (int32) minimum: 10 maximum: 1000	Gereken en fazla öğe sayısı (dahil). Minimum = 10, Maksimum = 1000, Varsayılan değer = 50.
$skipToken	query		string	Sonraki sonuç kümesini almak için belirteci atlayın.
cropIds	query		string[]	ManagementZone'un CropId'leri.
fieldIds	query		string[]	ManagementZone'un FieldId'leri.
ids	query		string[]	Kaynağın kimlikleri.
maxCreatedDateTime	query		string (date-time)	Kaynak oluşturma tarihi üst sınırı (dahil).
maxLastModifiedDateTime	query		string (date-time)	Kaynağın en son değiştirilme tarihi üst sınırı (dahil).
minCreatedDateTime	query		string (date-time)	Kaynağın en düşük oluşturma tarihi (dahil).
minLastModifiedDateTime	query		string (date-time)	Kaynağın en son değiştirilme tarihi (dahil).
names	query		string[]	Kaynağın adları.
propertyFilters	query		string[]	Özellikler nesnesi içindeki anahtar-değer çiftlerini filtreler. örneğin. "{testKey} eq {testValue}".
seasonIds	query		string[]	ManagementZone'un SeasonId'leri.
sources	query		string[]	ManagementZone kaynakları.
statuses	query		string[]	Kaynağın durumları.
types	query		string[]	ManagementZone türleri.

İ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	ManagementZoneListResponse	Başarı
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

ManagementZones_ListByFarmerId

Örnek isteği

HTTP

GET /farmers/FARMER123/management-zones?api-version=2021-07-31-preview

Örnek yanıt

Durum kodu:

200

{
  "value": [
    {
      "farmerId": "FARMER123",
      "id": "ManagementZone123",
      "type": "Nutrient rich",
      "seasonId": "Season123",
      "cropId": "Crop123",
      "fieldId": "Field123",
      "source": "Agronomist",
      "name": "John Smith's ManagementZone",
      "status": "Active",
      "description": "Some description",
      "properties": {
        "Irrigated": "Yes"
      },
      "createdDateTime": "2021-04-21T06:49:30Z",
      "modifiedDateTime": "2021-04-21T06:49:30Z",
      "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e"
    }
  ],
  "$skipToken": "string",
  "nextLink": "https://{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/management-zones?api-version={{apiVersion}}&$skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%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.
ErrorResponse	Azure AgPlatform hizmetinden bir hata yanıtı. <bk. href="https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses">ErrorResponse başvuru belgesi.</bakınız>.
InnerError	Hata listesini içeren iç hata. <bk. href="https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object">InnerError referans belgesi</bkz>.
ManagementZone	ManagementZone nesnesi için Api Modeli.
ManagementZoneListResponse	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.

Error

Object

Azure AgPlatform hizmetinden bir hata.

Name	Tür	Description
code	string	Sunucu tanımlı hata kodları kümesi.
details	Error[]	Bu bildirilen hataya neden olan belirli hatalar hakkındaki ayrıntılar dizisi.
innererror	InnerError	Hata listesini içeren iç hata. <bk. href="https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object">InnerError referans belgesi</bkz>.
message	string	Hatanın insan tarafından okunabilir gösterimi.
target	string	Hatanın hedefi.

ErrorResponse

Object

Azure AgPlatform hizmetinden bir hata yanıtı. <bk. href="https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses">ErrorResponse başvuru belgesi.</bakınız>.

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

InnerError

Object

Hata listesini içeren iç hata. <bk. href="https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object">InnerError referans belgesi</bkz>.

Name	Tür	Description
code	string	İçeren hata tarafından sağlanandan belirli bir hata kodu.
innererror	InnerError	Hata listesini içeren iç hata. <bk. href="https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object">InnerError referans belgesi</bkz>.

ManagementZone

Object

ManagementZone nesnesi için Api Modeli.

Name	Tür	Description
createdDateTime	string (date-time)	Kaynağın oluşturulduğu tarih-saat, örnek biçim: yyyy-MM-ddTHH:mm:ssZ.
cropId	string	ManagementZone ile ilişkili kırpma kimliği.
description	string minLength: 0 maxLength: 500	Kaynağın metinsel açıklaması.
eTag	string	İyimser eşzamanlılık uygulamak için ETag değeri.
farmerId	string	ManagementZone ile ilişkili Çiftçi Kimliği.
fieldId	string	ManagementZone ile ilişkili Alan Kimliği.
id	string	Benzersiz kaynak kimliği.
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: 0 maxLength: 100	Kaynağı tanımlamak için ad.
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.
seasonId	string	ManagementZone ile ilişkili sezon kimliği.
source	string minLength: 2 maxLength: 100	Kaynağın kaynağı.
status	string minLength: 0 maxLength: 100	Kaynağın durumu.
type	string minLength: 0 maxLength: 100	ManagementZone türü.

ManagementZoneListResponse

Object

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
$skipToken	string	Sonraki sayfayı alırken kullanılan belirteç. Null ise, başka sayfa yoktur.
nextLink	string	Listede sonuçların sonraki sayfasına devam bağlantısı (mutlak URI).
value	ManagementZone[]	İstenen nesnelerin listesi.