Boundaries - Search

Layanan:: Azure Data Manager for Agriculture

Versi API:: 2023-06-01-preview

Cari batasan di semua pihak berdasarkan bidang dan geometri yang bersinggungan.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
api-version	query	True	string	Versi API yang diminta

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
Authorization	True	string	Harap berikan token pembawa yang valid untuk panggilan API resmi. Perhatikan bahwa Anda mungkin perlu menghapus cache browser jika Anda mencoba panggilan yang tidak diautentikasi sebelumnya.

Isi Permintaan

Nama	Jenis	Deskripsi
ids	string[]	Id sumber daya.
intersectsWithGeometry	GeoJsonObject: MultiPolygon Point Polygon	GeoJSON (Untuk detail selengkapnya: https://geojson.org/). Catatan: Koordinat diharapkan dalam format [Bujur, Lintang].
maxArea	number (double)	Akrease maksimum batas (inklusif).
maxCreatedDateTime	string (date-time)	Tanggal pembuatan sumber daya maksimum (inklusif).
maxLastModifiedDateTime	string (date-time)	Tanggal maksimum sumber daya terakhir diubah (inklusif).
maxPageSize	integer (int32) minimum: 10 maximum: 1000	Jumlah maksimum item yang diperlukan (inklusif). Minimum = 10, Maksimum = 1000, Nilai default = 50.
minArea	number (double)	Akrease minimum batas (inklusif).
minCreatedDateTime	string (date-time)	Tanggal pembuatan sumber daya minimum (inklusif).
minLastModifiedDateTime	string (date-time)	Tanggal minimum sumber daya terakhir diubah (inklusif).
names	string[]	Nama sumber daya.
parentIds	string[]	Id induk sumber daya.
parentType	BoundaryParentType	Jenis induk miliknya.
propertyFilters	string[]	Filter pada pasangan kunci-nilai dalam objek Properti. misalnya "{testKey} eq {testValue}".
skipToken	string	Lewati token untuk mendapatkan serangkaian hasil berikutnya.
statuses	string[]	Status sumber daya.
type	string	Ketik miliknya.

Respons

Nama	Jenis	Deskripsi
200 OK	BoundaryMetadataListResponse	Keberhasilan
Other Status Codes	ErrorResponse	Kesalahan Header x-ms-error-code: string

Nama

Jenis

Deskripsi

200 OK

BoundaryMetadataListResponse

Keberhasilan

Other Status Codes

ErrorResponse

Kesalahan

Header

x-ms-error-code: string

Keamanan

Authorization

Harap berikan token pembawa yang valid untuk panggilan API resmi. Perhatikan bahwa Anda mungkin perlu menghapus cache browser jika Anda mencoba panggilan yang tidak diautentikasi sebelumnya.

Jenis: apiKey
Dalam: header

Contoh

Boundaries_Search

Permintaan sampel

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

Respon sampel

Kode status:: 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"
}

Definisi

Nama	Deskripsi
BoundaryMetadata	Skema metadata sumber daya batas.
BoundaryMetadataListResponse	Respons halaman berisi daftar objek yang diminta dan tautan URL untuk mendapatkan kumpulan hasil berikutnya.
BoundaryParentType	Jenis induk miliknya. Yaitu Lapangan, SeasonalField, Zona, Resep, PlantTissueAnalysis, ApplicationData, HarvestData, TillageData, PlantingData.
Error	Kesalahan dari layanan Azure AgPlatform.
ErrorResponse	Respons kesalahan dari layanan Azure AgPlatform. Lihat https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses untuk dokumen referensi ErrorResponse.
GeoJsonObjectType	Jenis objek GeoJSON.
InnerError	Kesalahan dalam yang berisi daftar kesalahan. Lihat https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object untuk dokumen referensi InnerError.
Measure	Skema untuk menyimpan pembacaan dan unit pengukuran.
MultiPolygon	Geometri MultiPolygon.
Point	Geometri titik.
Polygon	Geometri poligon.
SearchBoundaryQuery	Parameter SearchAllBoundaries dan SearchBoundaries.

BoundaryMetadata

Objek

Skema metadata sumber daya batas.

Nama	Jenis	Deskripsi
area	Measure	Skema untuk menyimpan pembacaan dan unit pengukuran.
createdBy	string	Dibuat oleh id pengguna/penyewa.
createdDateTime	string (date-time)	Tanggal-waktu saat sumber daya dibuat, format sampel: yyyy-MM-ddTHH:mm:ssZ.
description	string minLength: 0 maxLength: 500	Deskripsi tekstual sumber daya.
eTag	string	Nilai ETag untuk menerapkan konkurensi optimis.
id	string	ID sumber daya unik.
modifiedBy	string	Dimodifikasi oleh id pengguna/penyewa.
modifiedDateTime	string (date-time)	Tanggal-waktu ketika sumber daya terakhir diubah, format sampel: yyyy-MM-ddTHH:mm:ssZ.
name	string minLength: 0 maxLength: 100	Nama untuk mengidentifikasi sumber daya.
parentId	string	Id induk miliknya.
parentType	BoundaryParentType	Jenis induk miliknya.
partyId	string	Id Partai.
properties		Kumpulan pasangan nilai kunci milik sumber daya. Setiap pasangan tidak boleh memiliki kunci yang lebih besar dari 50 karakter dan tidak boleh memiliki nilai yang lebih besar dari 150 karakter. Catatan: Maksimal 25 pasangan nilai kunci dapat disediakan untuk sumber daya dan hanya nilai string, angka, dan tanggalwaktu (yyyy-MM-ddTHH:mm:ssZ) yang didukung.
source	string minLength: 2 maxLength: 100	Sumber sumber daya.
status	string minLength: 0 maxLength: 100	Status sumber daya.
type	string	Ketik miliknya.

BoundaryMetadataListResponse

Objek

Respons halaman berisi daftar objek yang diminta dan tautan URL untuk mendapatkan kumpulan hasil berikutnya.

Nama	Jenis	Deskripsi
nextLink	string	Tautan kelanjutan (URI absolut) ke halaman hasil berikutnya dalam daftar.
skipToken	string	Token yang digunakan dalam mengambil halaman berikutnya. Jika null, tidak ada halaman tambahan.
value	BoundaryMetadata[]	Daftar objek yang diminta.

BoundaryParentType

Enumeration

Jenis induk miliknya. Yaitu Lapangan, SeasonalField, Zona, Resep, PlantTissueAnalysis, ApplicationData, HarvestData, TillageData, PlantingData.

Nilai	Deskripsi
Field
SeasonalField
Zone
Prescription
PlantTissueAnalysis
ApplicationData
PlantingData
TillageData
HarvestData

Error

Objek

Kesalahan dari layanan Azure AgPlatform.

Nama	Jenis	Deskripsi
code	string minLength: 1	Sekumpulan kode kesalahan yang ditentukan server.
details	Error[]	Array detail tentang kesalahan tertentu yang menyebabkan kesalahan yang dilaporkan ini.
innererror	InnerError	Kesalahan dalam yang berisi daftar kesalahan. Lihat https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object untuk dokumen referensi InnerError.
message	string minLength: 1	Representasi kesalahan yang dapat dibaca manusia.
target	string	Target kesalahan.

ErrorResponse

Objek

Respons kesalahan dari layanan Azure AgPlatform. Lihat https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses untuk dokumen referensi ErrorResponse.

Nama	Jenis	Deskripsi
error	Error	Kesalahan dari layanan Azure AgPlatform.
traceId	string	Id pelacakan unik.

GeoJsonObjectType

Enumeration

Jenis objek GeoJSON.

Nilai	Deskripsi
Point
Polygon
MultiPolygon

InnerError

Objek

Kesalahan dalam yang berisi daftar kesalahan. Lihat https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object untuk dokumen referensi InnerError.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan tertentu daripada yang disediakan oleh kesalahan yang berisi.
innererror	InnerError	Kesalahan dalam yang berisi daftar kesalahan. Lihat https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object untuk dokumen referensi InnerError.

Measure

Objek

Skema untuk menyimpan pembacaan dan unit pengukuran.

Nama	Jenis	Deskripsi
unit	string minLength: 1 maxLength: 50	Unit data.
value	number (double)	Nilai data.

MultiPolygon

Objek

Geometri MultiPolygon.

Nama	Jenis	Deskripsi
coordinates	number[] (double)	Mendapatkan atau mengatur Koordinat Objek GeoJSON. Ini harus berupa array poligon, setiap poligon berisi daftar cincin linier. Untuk Poligon dengan lebih dari satu cincin ini, yang pertama HARUS menjadi cincin eksterior, dan yang lain HARUS berupa cincin interior.
type	string: MultiPolygon	Jenis objek GeoJSON.

Point

Objek

Geometri titik.

Nama	Jenis	Deskripsi
coordinates	number[] (double)	Mendapatkan atau mengatur koordinat titik ini. Ini harus berupa array 2 atau 3 elemen untuk sistem 2D atau 3D.
type	string: Point	Jenis objek GeoJSON.

Polygon

Objek

Geometri poligon.

Nama	Jenis	Deskripsi
coordinates	number[] (double)	Mendapatkan atau mengatur jenis Objek GeoJSON. Ini harus berupa array koordinat cincin linier. Untuk Poligon dengan lebih dari satu cincin ini, yang pertama HARUS menjadi cincin eksterior, dan yang lain HARUS berupa cincin interior.
type	string: Polygon	Jenis objek GeoJSON.

SearchBoundaryQuery

Objek

Parameter SearchAllBoundaries dan SearchBoundaries.

Nama	Jenis	Nilai default	Deskripsi
ids	string[]		Id sumber daya.
intersectsWithGeometry	GeoJsonObject: MultiPolygon Point Polygon		GeoJSON (Untuk detail selengkapnya: https://geojson.org/). Catatan: Koordinat diharapkan dalam format [Bujur, Lintang].
maxArea	number (double)		Akrease maksimum batas (inklusif).
maxCreatedDateTime	string (date-time)		Tanggal pembuatan sumber daya maksimum (inklusif).
maxLastModifiedDateTime	string (date-time)		Tanggal maksimum sumber daya terakhir diubah (inklusif).
maxPageSize	integer (int32) minimum: 10 maximum: 1000	50	Jumlah maksimum item yang diperlukan (inklusif). Minimum = 10, Maksimum = 1000, Nilai default = 50.
minArea	number (double)		Akrease minimum batas (inklusif).
minCreatedDateTime	string (date-time)		Tanggal pembuatan sumber daya minimum (inklusif).
minLastModifiedDateTime	string (date-time)		Tanggal minimum sumber daya terakhir diubah (inklusif).
names	string[]		Nama sumber daya.
parentIds	string[]		Id induk sumber daya.
parentType	BoundaryParentType		Jenis induk miliknya.
propertyFilters	string[]		Filter pada pasangan kunci-nilai dalam objek Properti. misalnya "{testKey} eq {testValue}".
skipToken	string		Lewati token untuk mendapatkan serangkaian hasil berikutnya.
statuses	string[]		Status sumber daya.
type	string		Ketik miliknya.

Bagikan melalui

Boundaries - Search

Parameter URI

Header Permintaan

Isi Permintaan

Respons

Keamanan

Authorization

Contoh

Boundaries_Search

Permintaan sampel

Respon sampel

Definisi

BoundaryMetadata

BoundaryMetadataListResponse

BoundaryParentType

Error

ErrorResponse

GeoJsonObjectType

InnerError

Measure

MultiPolygon

Point

Polygon

SearchBoundaryQuery