Boundaries - Search

Hizmet:: Azure Data Manager for Agriculture

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

Alanlara ve kesişen geometriye göre tüm taraflar arasındaki sınırları arayın.

POST /boundaries?api-version=2023-06-01-preview

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
api-version	query	True	string	İstenen API sürümü

İ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
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.
maxArea	number (double)	Sınırın maksimum oluşturması (dahil).
maxCreatedDateTime	string (date-time)	Kaynak oluşturma tarihi üst sınırı (dahil).
maxLastModifiedDateTime	string (date-time)	Kaynağın en son değiştirilme tarihi üst sınırı (dahil).
maxPageSize	integer (int32) minimum: 10 maximum: 1000	Gereken en fazla öğe sayısı (dahil). Minimum = 10, Maksimum = 1000, Varsayılan değer = 50.
minArea	number (double)	Sınırın minimum oluşturması (dahil).
minCreatedDateTime	string (date-time)	Kaynağın en düşük oluşturma tarihi (dahil).
minLastModifiedDateTime	string (date-time)	Kaynağın en son değiştirilme tarihi (dahil).
names	string[]	Kaynağın adları.
parentIds	string[]	Kaynağın üst kimlikleri.
parentType	BoundaryParentType	Ait olduğu üst öğe türü.
propertyFilters	string[]	Özellikler nesnesi içindeki anahtar-değer çiftlerini filtreler. Örneğin, "{testKey} eq {testValue}".
skipToken	string	Sonraki sonuç kümesini almak için belirteci atlayın.
statuses	string[]	Kaynağın durumları.
type	string	Ait olduğu yazın.

Yanıtlar

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

Name

Tür

Description

200 OK

BoundaryMetadataListResponse

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

Boundaries_Search

Örnek isteği

HTTP

POST /boundaries?api-version=2023-06-01-preview

{
  "ids": [
    "BOUNDARY123"
  ],
  "names": [
    "John Smith's Boundary"
  ],
  "propertyFilters": [
    "RetailerId"
  ],
  "statuses": [
    "Active"
  ],
  "minCreatedDateTime": "2021-04-22T12:53:39Z",
  "maxCreatedDateTime": "2021-04-22T12:53:39Z",
  "minLastModifiedDateTime": "2021-04-22T12:53:39Z",
  "maxLastModifiedDateTime": "2021-04-22T12:53:39Z",
  "maxPageSize": 50,
  "skipToken": "string",
  "parentType": "Field",
  "parentIds": [
    "FIELD123"
  ],
  "intersectsWithGeometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          10.98958969116211,
          45.284911882713146
        ],
        [
          11.004695892333984,
          45.284911882713146
        ],
        [
          11.004695892333984,
          45.29360722000945
        ],
        [
          10.98958969116211,
          45.29360722000945
        ],
        [
          10.98958969116211,
          45.284911882713146
        ]
      ]
    ]
  }
}

Örnek yanıt

Durum kodu:: 200

{
  "value": [
    {
      "parentId": "FIELD123",
      "parentType": "Field",
      "area": {
        "unit": "Acre",
        "value": 60.405
      },
      "name": "John Smith's Boundary",
      "description": "Some description"
    }
  ],
  "skipToken": "string",
  "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{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
BoundaryMetadata	Sınır kaynağı meta verilerinin şeması.
BoundaryMetadataListResponse	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.
BoundaryParentType	Ait olduğu üst öğe türü. Örneğin Field, SeasonalField, Zone, Prescription, PlantTissueAnalysis, ApplicationData, HarvestData, TillageData, PlantingData.
Error	Azure AgPlatform hizmetinden bir hata.
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.
GeoJsonObjectType	GeoJSON nesne türü.
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ı.
MultiPolygon	MultiPolygon geometrisi.
Point	Nokta geometrisi.
Polygon	Çokgen geometri.
SearchBoundaryQuery	SearchAllBoundaries ve SearchBoundaries parametreleri.

BoundaryMetadata

Object

Sınır kaynağı meta verilerinin şeması.

Name	Tür	Description
area	Measure	Ö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: 0 maxLength: 500	Kaynağın metinsel açıklaması.
eTag	string	İyimser eşzamanlılık uygulamak için ETag değeri.
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: 0 maxLength: 100	Kaynağı tanımlamak için ad.
parentId	string	Ait olduğu üst öğe kimliği.
parentType	BoundaryParentType	Ait olduğu üst öğe türü.
partyId	string	Parti 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: 2 maxLength: 100	Kaynağın kaynağı.
status	string minLength: 0 maxLength: 100	Kaynağın durumu.
type	string	Ait olduğu yazın.

BoundaryMetadataListResponse

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
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	BoundaryMetadata[]	İstenen nesnelerin listesi.

BoundaryParentType

Listeleme

Ait olduğu üst öğe türü. Örneğin Field, SeasonalField, Zone, Prescription, PlantTissueAnalysis, ApplicationData, HarvestData, TillageData, PlantingData.

Değer	Description
Field
SeasonalField
Zone
Prescription
PlantTissueAnalysis
ApplicationData
PlantingData
TillageData
HarvestData

Error

Object

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

Object

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	Error	Azure AgPlatform hizmetinden bir hata.
traceId	string	Benzersiz izleme kimliği.

GeoJsonObjectType

Listeleme

GeoJSON nesne türü.

Değer	Description
Point
Polygon
MultiPolygon

InnerError

Object

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

Object

Ölçüm okuma ve birimi depolama şeması.

Name	Tür	Description
unit	string minLength: 1 maxLength: 50	Veri birimi.
value	number (double)	Veri değeri.

MultiPolygon

Object

MultiPolygon geometrisi.

Name	Tür	Description
coordinates	number[] (double)	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, ilk dış halka olmalı ve diğerleri iç halka olmalıdır.
type	string: MultiPolygon	GeoJSON nesne türü.

Point

Object

Nokta geometrisi.

Name	Tür	Description
coordinates	number[] (double)	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

Object

Çokgen geometri.

Name	Tür	Description
coordinates	number[] (double)	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, ilk dış halka olmalı ve diğerleri iç halka olmalıdır.
type	string: Polygon	GeoJSON nesne türü.

SearchBoundaryQuery

Object

SearchAllBoundaries ve SearchBoundaries parametreleri.

Name	Tür	Default value	Description
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.
maxArea	number (double)		Sınırın maksimum oluşturması (dahil).
maxCreatedDateTime	string (date-time)		Kaynak oluşturma tarihi üst sınırı (dahil).
maxLastModifiedDateTime	string (date-time)		Kaynağın en son değiştirilme tarihi üst sınırı (dahil).
maxPageSize	integer (int32) minimum: 10 maximum: 1000	50	Gereken en fazla öğe sayısı (dahil). Minimum = 10, Maksimum = 1000, Varsayılan değer = 50.
minArea	number (double)		Sınırın minimum oluşturması (dahil).
minCreatedDateTime	string (date-time)		Kaynağın en düşük oluşturma tarihi (dahil).
minLastModifiedDateTime	string (date-time)		Kaynağın en son değiştirilme tarihi (dahil).
names	string[]		Kaynağın adları.
parentIds	string[]		Kaynağın üst kimlikleri.
parentType	BoundaryParentType		Ait olduğu üst öğe türü.
propertyFilters	string[]		Özellikler nesnesi içindeki anahtar-değer çiftlerini filtreler. Örneğin, "{testKey} eq {testValue}".
skipToken	string		Sonraki sonuç kümesini almak için belirteci atlayın.
statuses	string[]		Kaynağın durumları.
type	string		Ait olduğu yazın.

Aracılığıyla paylaş

Boundaries - Search

URI Parametreleri

İstek Başlığı

İstek Gövdesi

Yanıtlar

Güvenlik

Authorization

Örnekler

Boundaries_Search

Örnek isteği

Örnek yanıt

Tanımlar

BoundaryMetadata

BoundaryMetadataListResponse

BoundaryParentType

Error

ErrorResponse

GeoJsonObjectType

InnerError

Measure

MultiPolygon

Point

Polygon

SearchBoundaryQuery