Fields - Search

Başvuru

Hizmet:: Azure Data Manager for Agriculture

API Sürümü:: 2023-11-01-preview

Geometriyi kesiştirerek tüm taraflar genelinde Alanlar'ı arayın.

POST {endpoint}/fields:search?api-version=2023-11-01-preview

İsteğe bağlı parametrelerle:

POST {endpoint}/fields:search?skipToken={skipToken}&maxPageSize={maxPageSize}&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
api-version	query	True	string	İstenen API sürümü
maxPageSize	query		integer int32	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.

İ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.

İstek Gövdesi

Name	Tür	Description
farmIds	string[]	Kaynağın FarmId değerleri.
ids	string[]	Kaynağın kimlikleri.
intersectsWithGeometry	GeoJsonObject: MultiPolygon Point Polygon	GeoJSON (Daha fazla ayrıntı için: https://geojson.org/). Not: Koordinatlar [Boylam, Enlem] biçiminde beklenir.
maxCreatedDateTime	string	Kaynağın oluşturma tarihi üst sınırı (dahil).
maxLastModifiedDateTime	string	Kaynağın son değiştirme tarihi üst sınırı (dahil).
minCreatedDateTime	string	Kaynağın en düşük oluşturma tarihi (dahil).
minLastModifiedDateTime	string	Kaynağın en düşük son değiştirme tarihi (dahil).
names	string[]	Kaynağın adları.
partyId	string	İşlem verilerine ait olan Taraf Kimliği.
propertyFilters	string[]	Özellikler nesnesi içindeki anahtar-değer çiftlerinde filtreler. Örneğin, "{testKey} eq {testValue}".
statuses	string[]	Kaynağın durumları.

Yanıtlar

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

Name

Tür

Description

200 OK

FieldMetaDataListResponse

Başarılı

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

Fields_Search

Örnek isteği

HTTP

POST {endpoint}/fields:search?maxPageSize=50&api-version=2023-11-01-preview

{
  "intersectsWithGeometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          73.70457172393799,
          20.545385304358106
        ],
        [
          73.70457172393799,
          20.545385304358106
        ],
        [
          73.70448589324951,
          20.542411534243367
        ],
        [
          73.70877742767334,
          20.541688176010233
        ],
        [
          73.71023654937744,
          20.545083911372505
        ],
        [
          73.70663166046143,
          20.546992723579137
        ],
        [
          73.70457172393799,
          20.545385304358106
        ]
      ]
    ]
  }
}

Örnek yanıt

Durum kodu:: 200

{
  "value": [
    {
      "id": "FIELD123",
      "partyId": "FARMER123",
      "farmId": "FARM123",
      "name": "John Smith's Field",
      "status": "Active",
      "description": "Some description",
      "properties": {
        "Irrigated": "Yes",
        "RetailerId": "Retailer123"
      },
      "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/{{partyId}}/seasonalFields/{{seasonalFieldId}}?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ı. ErrorResponse başvuru belgesi için bkz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses .
FieldMetaData	Alan kaynağının şeması.
FieldMetaDataListResponse	Disk belleğine alınan yanıt, istenen nesnelerin listesini ve sonraki sonuç kümesini almak için bir skipToken içerir.
GeoJsonObjectType	GeoJSON nesne türü.
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 .
MultiPolygon	MultiPolygon geometrisi.
Point	Nokta geometrisi.
Polygon	Çokgen geometri.
SearchFieldQuery	SearchAllBoundaries ve SearchBoundaries parametreleri.

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.

FieldMetaData

Alan kaynağının şeması.

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.
farmId	string	İlişkili Grubun kimliği.
id	string	Benzersiz kaynak kimliği.
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.
partyId	string	Grup 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 datetime (yyyy-MM-ddTHH:mm:ssZ) değerleri desteklenir.
source	string	Kaynağın kaynağı.
status	string	Kaynağın durumu.

FieldMetaDataListResponse

Disk belleğine alınan yanıt, istenen nesnelerin listesini ve sonraki sonuç kümesini almak için bir skipToken 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	FieldMetaData[]	İstenen nesnelerin listesi.

GeoJsonObjectType

GeoJSON nesne türü.

Name	Tür	Description
MultiPolygon	string
Point	string
Polygon	string

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 .

MultiPolygon

MultiPolygon geometrisi.

Name	Tür	Description
coordinates	number[]	GeoJSON Nesnesinin Koordinatlarını alır veya ayarlar. Bu bir çokgen dizisi olmalıdır, her çokgen doğrusal halkaların listesini içerir. Bu halkalardan birden fazlasına sahip Çokgenler için, ilki dış halka, diğerleri iç halkaLAR OLMALIDIR.
type	string: MultiPolygon	GeoJSON nesne türü.

Point

Nokta geometrisi.

Name	Tür	Description
coordinates	number[]	Bu noktanın koordinatını alır veya ayarlar. Bir 2B veya 3B sistem için 2 veya 3 öğeden oluşan bir dizi olmalıdır.
type	string: Point	GeoJSON nesne türü.

Polygon

Çokgen geometri.

Name	Tür	Description
coordinates	number[]	GeoJSON Nesnesinin türünü alır veya ayarlar. Doğrusal halka koordinat dizilerinden oluşan bir dizi olmalıdır. Bu halkalardan birden fazlasına sahip Çokgenler için, ilki dış halka, diğerleri iç halkaLAR OLMALIDIR.
type	string: Polygon	GeoJSON nesne türü.

SearchFieldQuery

SearchAllBoundaries ve SearchBoundaries parametreleri.

Name	Tür	Description
farmIds	string[]	Kaynağın FarmId değerleri.
ids	string[]	Kaynağın kimlikleri.
intersectsWithGeometry	GeoJsonObject: MultiPolygon Point Polygon	GeoJSON (Daha fazla ayrıntı için: https://geojson.org/). Not: Koordinatlar [Boylam, Enlem] biçiminde beklenir.
maxCreatedDateTime	string	Kaynağın oluşturma tarihi üst sınırı (dahil).
maxLastModifiedDateTime	string	Kaynağın son değiştirme tarihi üst sınırı (dahil).
minCreatedDateTime	string	Kaynağın en düşük oluşturma tarihi (dahil).
minLastModifiedDateTime	string	Kaynağın en düşük son değiştirme tarihi (dahil).
names	string[]	Kaynağın adları.
partyId	string	İşlem verilerine ait olan Taraf Kimliği.
propertyFilters	string[]	Özellikler nesnesi içindeki anahtar-değer çiftlerinde filtreler. Örneğin, "{testKey} eq {testValue}".
statuses	string[]	Kaynağın durumları.

Aracılığıyla paylaş

Fields - Search

URI Parametreleri

İstek Başlığı

İstek Gövdesi

Yanıtlar

Güvenlik

Authorization

Örnekler

Fields_Search

Örnek isteği

Örnek yanıt

Tanımlar

Error

ErrorResponse

FieldMetaData

FieldMetaDataListResponse

GeoJsonObjectType

InnerError

MultiPolygon

Point

Polygon

SearchFieldQuery

Ek kaynaklar