Management Zones - List By Farmer Id

Layanan:

Azure Data Manager for Agriculture

Versi API:

2021-07-31-preview

Mengembalikan daftar sumber daya zona manajemen yang dipaginasi di bawah petani tertentu.

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

Dengan parameter opsional:

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
farmerId	path	True	string	Id petani terkait.
api-version	query	True	string	Versi API yang diminta
$maxPageSize	query		integer (int32) minimum: 10 maximum: 1000	Jumlah maksimum item yang diperlukan (inklusif). Minimum = 10, Maksimum = 1000, Nilai default = 50.
$skipToken	query		string	Lewati token untuk mendapatkan serangkaian hasil berikutnya.
cropIds	query		string[]	CropIds dari ManagementZone.
fieldIds	query		string[]	FieldIds dari ManagementZone.
ids	query		string[]	Id sumber daya.
maxCreatedDateTime	query		string (date-time)	Tanggal pembuatan sumber daya maksimum (inklusif).
maxLastModifiedDateTime	query		string (date-time)	Tanggal maksimum sumber daya terakhir diubah (inklusif).
minCreatedDateTime	query		string (date-time)	Tanggal pembuatan sumber daya minimum (inklusif).
minLastModifiedDateTime	query		string (date-time)	Tanggal minimum sumber daya terakhir diubah (inklusif).
names	query		string[]	Nama sumber daya.
propertyFilters	query		string[]	Filter pada pasangan kunci-nilai dalam objek Properti. misalnya. "{testKey} eq {testValue}".
seasonIds	query		string[]	SeasonIds dari ManagementZone.
sources	query		string[]	Sumber ManagementZone.
statuses	query		string[]	Status sumber daya.
types	query		string[]	Jenis ManagementZone.

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.

Respons

Nama	Jenis	Deskripsi
200 OK	ManagementZoneListResponse	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

ManagementZones_ListByFarmerId

Permintaan sampel

HTTP

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

Respon sampel

Kode status:

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

Definisi

Nama	Deskripsi
Error	Kesalahan dari layanan Azure AgPlatform.
ErrorResponse	Respons kesalahan dari layanan Azure AgPlatform. <lihat href="https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses">Dokumen referensi ErrorResponse.</lihat>.
InnerError	Kesalahan dalam yang berisi daftar kesalahan. <lihat href="https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object">Dokumen< referensi InnerError/lihat>.
ManagementZone	Api Model untuk objek ManagementZone.
ManagementZoneListResponse	Respons halaman berisi daftar objek yang diminta dan tautan URL untuk mendapatkan kumpulan hasil berikutnya.

Error

Objek

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 href="https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object">Dokumen< referensi InnerError/lihat>.
message	string	Representasi kesalahan yang dapat dibaca manusia.
target	string	Target kesalahan.

ErrorResponse

Objek

Respons kesalahan dari layanan Azure AgPlatform. <lihat href="https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses">Dokumen referensi ErrorResponse.</lihat>.

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

InnerError

Objek

Kesalahan dalam yang berisi daftar kesalahan. <lihat href="https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object">Dokumen< referensi InnerError/lihat>.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan tertentu daripada yang disediakan oleh kesalahan yang berisi.
innererror	InnerError	Kesalahan dalam yang berisi daftar kesalahan. <lihat href="https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object">Dokumen< referensi InnerError/lihat>.

ManagementZone

Objek

Api Model untuk objek ManagementZone.

Nama	Jenis	Deskripsi
createdDateTime	string (date-time)	Tanggal-waktu saat sumber daya dibuat, format sampel: yyyy-MM-ddTHH:mm:ssZ.
cropId	string	Id Potong yang terkait dengan ManagementZone.
description	string minLength: 0 maxLength: 500	Deskripsi tekstual sumber daya.
eTag	string	Nilai ETag untuk menerapkan konkurensi optimis.
farmerId	string	Id Petani yang terkait dengan ManagementZone.
fieldId	string	Id Bidang yang terkait dengan ManagementZone.
id	string	ID sumber daya unik.
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.
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.
seasonId	string	Id Musim yang terkait dengan ManagementZone.
source	string minLength: 2 maxLength: 100	Sumber sumber daya.
status	string minLength: 0 maxLength: 100	Status sumber daya.
type	string minLength: 0 maxLength: 100	Jenis ManagementZone.

ManagementZoneListResponse

Objek

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

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