Management Zones - List By Farmer Id

Tjänst:: Azure Data Manager for Agriculture

API-version:: 2021-07-31-preview

Returnerar en sidnumrerad lista över resurser i hanteringszonen under en viss jordbrukare.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
farmerId	path	True	string	ID för den associerade bonden.
api-version	query	True	string	Den begärda API-versionen
$maxPageSize	query		integer (int32) minimum: 10 maximum: 1000	Maximalt antal objekt som behövs (inklusive). Minimum = 10, Maximum = 1000, Standardvärde = 50.
$skipToken	query		string	Hoppa över token för att hämta nästa uppsättning resultat.
cropIds	query		string[]	CropIds för ManagementZone.
fieldIds	query		string[]	FieldIds för ManagementZone.
ids	query		string[]	ID:t för resursen.
maxCreatedDateTime	query		string (date-time)	Maximalt skapandedatum för resurs (inklusive).
maxLastModifiedDateTime	query		string (date-time)	Maximalt senast ändrat datum för resursen (inklusive).
minCreatedDateTime	query		string (date-time)	Minsta skapandedatum för resursen (inklusive).
minLastModifiedDateTime	query		string (date-time)	Minsta senaste ändringsdatum för resursen (inklusive).
names	query		string[]	Namn på resursen.
propertyFilters	query		string[]	Filtrerar på nyckel/värde-par i objektet Egenskaper. T.ex. "{testKey} eq {testValue}".
seasonIds	query		string[]	SeasonIds för ManagementZone.
sources	query		string[]	Källor för ManagementZone.
statuses	query		string[]	Status för resursen.
types	query		string[]	Typer av ManagementZone.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Authorization	True	string	Ange en giltig ägartoken för auktoriserade API-anrop. Observera att du kan behöva rensa webbläsarens cacheminne om du har provat oautentiserade anrop tidigare.

Svar

Name	Typ	Description
200 OK	ManagementZoneListResponse	Framgång
Other Status Codes	ErrorResponse	Fel Sidhuvuden x-ms-error-code: string

Name

Typ

Description

200 OK

ManagementZoneListResponse

Framgång

Other Status Codes

ErrorResponse

Fel

Sidhuvuden

x-ms-error-code: string

Säkerhet

Authorization

Ange en giltig ägartoken för auktoriserade API-anrop. Observera att du kan behöva rensa webbläsarens cacheminne om du har provat oautentiserade anrop tidigare.

Typ: apiKey
I: header

Exempel

ManagementZones_ListByFarmerId

Exempelbegäran

HTTP

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

Exempelsvar

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

Definitioner

Name	Description
Error	Ett fel från Azure AgPlatform-tjänsten.
ErrorResponse	Ett felsvar från Azure AgPlatform-tjänsten. <se href="https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses">Referensdokument för ErrorResponse.</se>.
InnerError	Inre fel som innehåller en lista över fel. <se href="https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object">InnerError referensdokument</se>.
ManagementZone	API-modell för ManagementZone-objekt.
ManagementZoneListResponse	Sidsidigt svar innehåller en lista över begärda objekt och en URL-länk för att hämta nästa uppsättning resultat.

Error

Objekt

Ett fel från Azure AgPlatform-tjänsten.

Name	Typ	Description
code	string	Serverdefinierad uppsättning felkoder.
details	Error[]	Matris med information om specifika fel som ledde till det rapporterade felet.
innererror	InnerError	Inre fel som innehåller en lista över fel. <se href="https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object">InnerError referensdokument</se>.
message	string	Mänsklig läsbar representation av felet.
target	string	Målet för felet.

ErrorResponse

Objekt

Ett felsvar från Azure AgPlatform-tjänsten. <se href="https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses">Referensdokument för ErrorResponse.</se>.

Name	Typ	Description
error	Error	Ett fel från Azure AgPlatform-tjänsten.
traceId	string	Unikt spårnings-ID.

InnerError

Objekt

Inre fel som innehåller en lista över fel. <se href="https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object">InnerError referensdokument</se>.

Name	Typ	Description
code	string	Specifik felkod än vad som angavs av det innehållande felet.
innererror	InnerError	Inre fel som innehåller en lista över fel. <se href="https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object">InnerError referensdokument</se>.

ManagementZone

Objekt

API-modell för ManagementZone-objekt.

Name	Typ	Description
createdDateTime	string (date-time)	Datum-tid när resursen skapades, exempelformat: åååå-MM-ddTHH:mm:ssZ.
cropId	string	Beskärnings-ID som är associerat med ManagementZone.
description	string minLength: 0 maxLength: 500	Textbeskrivning av resursen.
eTag	string	ETag-värdet för att implementera optimistisk samtidighet.
farmerId	string	Bonde-ID som är associerat med ManagementZone.
fieldId	string	Fält-ID som är associerat med ManagementZone.
id	string	Unikt resurs-ID.
modifiedDateTime	string (date-time)	Datum-tid när resursen senast ändrades, exempelformat: åååå-MM-ddTHH:mm:ssZ.
name	string minLength: 0 maxLength: 100	Namn för att identifiera resursen.
properties		En samling nyckelvärdepar som tillhör resursen. Varje par får inte ha en nyckel som är större än 50 tecken och får inte ha ett värde som är större än 150 tecken. Obs! Högst 25 nyckelvärdepar kan anges för en resurs och endast värden för sträng, siffror och datetime (åååå-MM-ddTHH:mm:ssZ) stöds.
seasonId	string	Säsongs-ID som är associerat med ManagementZone.
source	string minLength: 2 maxLength: 100	Resursens källa.
status	string minLength: 0 maxLength: 100	Status för resursen.
type	string minLength: 0 maxLength: 100	Typ av Hanteringszon.

ManagementZoneListResponse

Objekt

Sidsidigt svar innehåller en lista över begärda objekt och en URL-länk för att hämta nästa uppsättning resultat.

Name	Typ	Description
$skipToken	string	Token som används för att hämta nästa sida. Om värdet är null finns det inga ytterligare sidor.
nextLink	string	Fortsättningslänk (absolut URI) till nästa sida med resultat i listan.
value	ManagementZone[]	Lista över begärda objekt.

Dela via

Management Zones - List By Farmer Id

URI-parametrar

Begärandehuvud

Svar

Säkerhet

Authorization

Exempel

ManagementZones_ListByFarmerId

Exempelbegäran

Exempelsvar

Definitioner

Error

ErrorResponse

InnerError

ManagementZone

ManagementZoneListResponse