Management Zones - List By Farmer Id

Služba:: Azure Data Manager for Agriculture

Verze rozhraní API:: 2021-07-31-preview

Vrátí stránkovaný seznam prostředků zóny správy v rámci konkrétního farmáře.

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
farmerId	path	True	string	ID přidruženého farmáře.
api-version	query	True	string	Požadovaná verze rozhraní API
$maxPageSize	query		integer (int32) minimum: 10 maximum: 1000	Maximální počet potřebných položek (včetně). Minimum = 10, Maximum = 1000, Výchozí hodnota = 50.
$skipToken	query		string	Přeskočte token pro získání další sady výsledků.
cropIds	query		string[]	Identifikátory oříznutí zóny správy.
fieldIds	query		string[]	FieldIds zóny správy.
ids	query		string[]	ID prostředku.
maxCreatedDateTime	query		string (date-time)	Maximální datum vytvoření prostředku (včetně).
maxLastModifiedDateTime	query		string (date-time)	Maximální datum poslední změny prostředku (včetně).
minCreatedDateTime	query		string (date-time)	Minimální datum vytvoření prostředku (včetně).
minLastModifiedDateTime	query		string (date-time)	Minimální datum poslední změny prostředku (včetně).
names	query		string[]	Názvy prostředku
propertyFilters	query		string[]	Filtruje páry klíč-hodnota v rámci objektu Properties. Např. {testKey} eq {testValue}.
seasonIds	query		string[]	SeasonIds zóny správy.
sources	query		string[]	Zdroje ManagementZone.
statuses	query		string[]	Stavy prostředku
types	query		string[]	Typy ManagementZone.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Authorization	True	string	Zadejte platný nosný token pro autorizovaná volání rozhraní API. Mějte na paměti, že pokud jste zkusili neověřené volání dříve, možná budete muset vymazat mezipaměť prohlížeče.

Odpovědi

Name	Typ	Description
200 OK	ManagementZoneListResponse	Úspěch
Other Status Codes	ErrorResponse	Chyba Hlavičky x-ms-error-code: string

Name

Typ

Description

200 OK

ManagementZoneListResponse

Úspěch

Other Status Codes

ErrorResponse

Chyba

Hlavičky

x-ms-error-code: string

Zabezpečení

Authorization

Zadejte platný nosný token pro autorizovaná volání rozhraní API. Mějte na paměti, že pokud jste zkusili neověřené volání dříve, možná budete muset vymazat mezipaměť prohlížeče.

Typ: apiKey
V: header

Příklady

ManagementZones_ListByFarmerId

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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"
}

Definice

Name	Description
Error	Chyba ze služby Azure AgPlatform.
ErrorResponse	Odpověď na chybu ze služby Azure AgPlatform. <viz href="https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses">Referenční dokument ErrorResponse.</viz>.
InnerError	Vnitřní chyba obsahující seznam chyb <viz href="https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object">Referenční dokument< InnerError/viz>.
ManagementZone	Model api pro objekt ManagementZone
ManagementZoneListResponse	Stránkovaná odpověď obsahuje seznam požadovaných objektů a odkaz URL pro získání další sady výsledků.

Error

Objekt

Chyba ze služby Azure AgPlatform.

Name	Typ	Description
code	string	Sada kódů chyb definovaná serverem
details	Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	InnerError	Vnitřní chyba obsahující seznam chyb <viz href="https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object">Referenční dokument< InnerError/viz>.
message	string	Čitelné znázornění chyby člověkem
target	string	Cíl chyby.

ErrorResponse

Objekt

Odpověď na chybu ze služby Azure AgPlatform. <viz href="https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses">Referenční dokument ErrorResponse.</viz>.

Name	Typ	Description
error	Error	Chyba ze služby Azure AgPlatform.
traceId	string	Jedinečné ID trasování

InnerError

Objekt

Vnitřní chyba obsahující seznam chyb <viz href="https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object">Referenční dokument< InnerError/viz>.

Name	Typ	Description
code	string	Konkrétní kód chyby, než poskytla obsahující chyba.
innererror	InnerError	Vnitřní chyba obsahující seznam chyb <viz href="https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object">Referenční dokument< InnerError/viz>.

ManagementZone

Objekt

Model api pro objekt ManagementZone

Name	Typ	Description
createdDateTime	string (date-time)	Datum a čas vytvoření prostředku, ukázkový formát: rrrr-MM-ddTHH:mm:ssZ.
cropId	string	ID oříznutí přidružené k ManagementZone.
description	string minLength: 0 maxLength: 500	Textový popis prostředku
eTag	string	Hodnota ETag pro implementaci optimistické souběžnosti.
farmerId	string	Id zemědělce přidružené k ManagementZone.
fieldId	string	ID pole přidružené k ManagementZone.
id	string	Jedinečné ID prostředku
modifiedDateTime	string (date-time)	Datum a čas poslední změny prostředku, ukázkový formát: rrrr-MM-ddTHH:mm:ssZ.
name	string minLength: 0 maxLength: 100	Název k identifikaci prostředku
properties		Kolekce párů klíč-hodnota, které patří k prostředku. Každý pár nesmí mít klíč větší než 50 znaků a nesmí mít hodnotu větší než 150 znaků. Poznámka: Pro prostředek lze zadat maximálně 25 párů klíč-hodnota a jsou podporovány pouze hodnoty string, číslic a datetime (yyyy-MM-ddTHH:mm:ssZ).
seasonId	string	ID sezóny přidružené k ManagementZone.
source	string minLength: 2 maxLength: 100	Zdroj prostředku
status	string minLength: 0 maxLength: 100	Stav prostředku
type	string minLength: 0 maxLength: 100	Typ ManagementZone.

ManagementZoneListResponse

Objekt

Stránkovaná odpověď obsahuje seznam požadovaných objektů a odkaz URL pro získání další sady výsledků.

Name	Typ	Description
$skipToken	string	Token použitý při načítání další stránky. Pokud je hodnota null, nejsou k dispozici žádné další stránky.
nextLink	string	Odkaz na pokračování (absolutní identifikátor URI) na další stránku výsledků v seznamu.
value	ManagementZone[]	Seznam požadovaných objektů

Sdílet prostřednictvím

Management Zones - List By Farmer Id

Parametry identifikátoru URI

Hlavička požadavku

Odpovědi

Zabezpečení

Authorization

Příklady

ManagementZones_ListByFarmerId

Ukázkový požadavek

Ukázková odpověď

Definice

Error

ErrorResponse

InnerError

ManagementZone

ManagementZoneListResponse