Bagikan melalui


Boundaries - Search

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:

GeoJSON (Untuk detail selengkapnya: https://geojson.org/). Catatan: Koordinat diharapkan dalam format [Bujur, Lintang].

maxArea

number

Akreta maksimum batas (inklusif).

maxCreatedDateTime

string

Tanggal pembuatan sumber daya maksimum (inklusif).

maxLastModifiedDateTime

string

Tanggal maksimum sumber daya yang terakhir diubah (inklusif).

maxPageSize

integer

Jumlah maksimum item yang diperlukan (inklusif). Minimum = 10, Maksimum = 1000, Nilai default = 50.

minArea

number

Akrease minimum batas (inklusif).

minCreatedDateTime

string

Tanggal pembuatan minimum sumber daya (inklusif).

minLastModifiedDateTime

string

Tanggal modifikasi terakhir minimum sumber daya (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

Berhasil

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

Permintaan sampel

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

{
  "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 serangkaian 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

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

Tanggal-waktu ketika sumber daya dibuat, format sampel: yyyy-MM-ddTHH:mm:ssZ.

description

string

Deskripsi tekstual dari 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

Tanggal-waktu ketika sumber daya terakhir dimodifikasi, format sampel: yyyy-MM-ddTHH:mm:ssZ.

name

string

Nama untuk mengidentifikasi sumber daya.

parentId

string

Id induk miliknya.

parentType

BoundaryParentType

Jenis induk miliknya.

partyId

string

Id Pesta.

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

Sumber sumber daya.

status

string

Status sumber daya.

type

string

Ketik miliknya.

BoundaryMetadataListResponse

Respons halaman berisi daftar objek yang diminta dan tautan URL untuk mendapatkan serangkaian 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

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

Nama Jenis Deskripsi
ApplicationData

string

Field

string

HarvestData

string

PlantTissueAnalysis

string

PlantingData

string

Prescription

string

SeasonalField

string

TillageData

string

Zone

string

Error

Kesalahan dari layanan Azure AgPlatform.

Nama Jenis Deskripsi
code

string

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

Representasi kesalahan yang dapat dibaca manusia.

target

string

Target kesalahan.

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.

Nama Jenis Deskripsi
error

Error

Kesalahan dari layanan Azure AgPlatform.

traceId

string

Id pelacakan unik.

GeoJsonObjectType

Jenis objek GeoJSON.

Nama Jenis Deskripsi
MultiPolygon

string

Point

string

Polygon

string

InnerError

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

Skema untuk menyimpan pembacaan dan unit pengukuran.

Nama Jenis Deskripsi
unit

string

Unit data.

value

number

Nilai data.

MultiPolygon

Geometri multiPolygon.

Nama Jenis Deskripsi
coordinates

number[]

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

Geometri titik.

Nama Jenis Deskripsi
coordinates

number[]

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

Geometri poligon.

Nama Jenis Deskripsi
coordinates

number[]

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

Parameter SearchAllBoundaries dan SearchBoundaries.

Nama Jenis Nilai default Deskripsi
ids

string[]

Id sumber daya.

intersectsWithGeometry GeoJsonObject:

GeoJSON (Untuk detail selengkapnya: https://geojson.org/). Catatan: Koordinat diharapkan dalam format [Bujur, Lintang].

maxArea

number

Akreta maksimum batas (inklusif).

maxCreatedDateTime

string

Tanggal pembuatan sumber daya maksimum (inklusif).

maxLastModifiedDateTime

string

Tanggal maksimum sumber daya yang terakhir diubah (inklusif).

maxPageSize

integer

50

Jumlah maksimum item yang diperlukan (inklusif). Minimum = 10, Maksimum = 1000, Nilai default = 50.

minArea

number

Akrease minimum batas (inklusif).

minCreatedDateTime

string

Tanggal pembuatan minimum sumber daya (inklusif).

minLastModifiedDateTime

string

Tanggal modifikasi terakhir minimum sumber daya (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.