Management Zones - List

Referencia

Szolgáltatás:: Azure Data Manager for Agriculture

API-verzió:: 2023-11-01-preview

A felügyeleti zóna erőforrásainak lapszámozott listáját adja vissza az összes fél számára.

GET {endpoint}/management-zones?api-version=2023-11-01-preview

Opcionális paraméterekkel:

GET {endpoint}/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=2023-11-01-preview

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string (uri)	A névtér gazdagépneve, például admaInstanceName.farmbeats.azure.net
api-version	query	True	string	A kért API-verzió
cropIds	query		string[]	A ManagementZone CropIds azonosítójai.
fieldIds	query		string[]	A ManagementZone mezőazonosítói.
ids	query		string[]	Az erőforrás azonosítói.
maxCreatedDateTime	query		string (date-time)	Az erőforrás létrehozásának maximális dátuma (beleértve az erőforrást is).
maxLastModifiedDateTime	query		string (date-time)	Az erőforrás utolsó módosításának maximális dátuma (beleértve az erőforrást is).
maxPageSize	query		integer (int32) minimum: 10 maximum: 1000	A szükséges elemek maximális száma (beleértve a elemet is). Minimum = 10, Maximum = 1000, Alapértelmezett érték = 50.
minCreatedDateTime	query		string (date-time)	Az erőforrás minimális létrehozási dátuma (beleértve az erőforrást is).
minLastModifiedDateTime	query		string (date-time)	Az erőforrás utolsó módosításának minimális dátuma (beleértve az erőforrást is).
names	query		string[]	Az erőforrás nevei.
propertyFilters	query		string[]	A Tulajdonságok objektumon belüli kulcs-érték párokra vonatkozó szűrők. Pl.. "{testKey} eq {testValue}".
seasonIds	query		string[]	A ManagementZone SeasonIds azonosítójai.
skipToken	query		string	A következő találatkészlet lekéréséhez hagyja ki a jogkivonatot.
sources	query		string[]	A ManagementZone forrásai.
statuses	query		string[]	Az erőforrás állapota.
types	query		string[]	A ManagementZone típusai.

Kérelem fejléce

Name	Kötelező	Típus	Description
Authorization	True	string	Adjon meg érvényes tulajdonosi jogkivonatot az engedélyezett API-hívásokhoz. Vegye figyelembe, hogy előfordulhat, hogy törölnie kell a böngésző gyorsítótárát, ha korábban nem hitelesített hívásokat próbált meg.

Válaszok

Name	Típus	Description
200 OK	ManagementZoneListResponse	Siker
Other Status Codes	ErrorResponse	Hiba Fejlécek x-ms-error-code: string

Name

Típus

Description

200 OK

ManagementZoneListResponse

Siker

Other Status Codes

ErrorResponse

Hiba

Fejlécek

x-ms-error-code: string

Biztonság

Authorization

Adjon meg érvényes tulajdonosi jogkivonatot az engedélyezett API-hívásokhoz. Vegye figyelembe, hogy előfordulhat, hogy törölnie kell a böngésző gyorsítótárát, ha korábban nem hitelesített hívásokat próbált meg.

Típus: apiKey
In: header

Példák

ManagementZones_List

Mintakérelem

HTTP

GET {endpoint}/management-zones?api-version=2023-11-01-preview

Mintaválasz

Állapotkód:: 200

{
  "value": [
    {
      "partyId": "PARTY123",
      "id": "ManagementZone123",
      "type": "Nutrient rich",
      "seasonId": "Season123",
      "cropId": "Crop123",
      "fieldId": "Field123",
      "name": "John Smith's ManagementZone",
      "status": "Active",
      "description": "Some description",
      "source": "source",
      "properties": {
        "Irrigated": "Yes"
      },
      "createdDateTime": "2021-04-21T06:49:30Z",
      "modifiedDateTime": "2021-04-21T06:49:30Z",
      "createdBy": "00000000-0000-0000-0000-000000000000",
      "modifiedBy": "00000000-0000-0000-0000-000000000000",
      "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e"
    }
  ],
  "skipToken": "string",
  "nextLink": "https://{{resourceName}}.farmbeats.azure.net/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"
}

Definíciók

Name	Description
Error	Az Azure AgPlatform szolgáltatás hibája.
ErrorResponse	Hibaválasz az Azure AgPlatform szolgáltatástól. Az ErrorResponse referenciadokumentumának https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
InnerError	A hibák listáját tartalmazó belső hiba. Lásd az InnerError-referenciadokumentum https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object.
ManagementZone	Api Model for ManagementZone objektum.
ManagementZoneListResponse	A lapozott válasz a kért objektumok listáját és egy URL-hivatkozást tartalmaz a következő találatkészlet lekéréséhez.

Error

Objektum

Az Azure AgPlatform szolgáltatás hibája.

Name	Típus	Description
code	string minLength: 1	Kiszolgáló által definiált hibakódok.
details	Error[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
innererror	InnerError	A hibák listáját tartalmazó belső hiba. Lásd az InnerError-referenciadokumentum https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object.
message	string minLength: 1	A hiba emberi olvasásra alkalmas ábrázolása.
target	string	A hiba célja.

ErrorResponse

Objektum

Hibaválasz az Azure AgPlatform szolgáltatástól. Az ErrorResponse referenciadokumentumának https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Típus	Description
error	Error	Az Azure AgPlatform szolgáltatás hibája.
traceId	string	Egyedi nyomkövetési azonosító.

InnerError

Objektum

A hibák listáját tartalmazó belső hiba. Lásd az InnerError-referenciadokumentum https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object.

Name	Típus	Description
code	string	A hibát tartalmazó hiba által megadottnál meghatározott hibakód.
innererror	InnerError	A hibák listáját tartalmazó belső hiba. Lásd az InnerError-referenciadokumentum https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object.

ManagementZone

Objektum

Api Model for ManagementZone objektum.

Name	Típus	Description
createdBy	string	A felhasználó/bérlő azonosítója hozza létre.
createdDateTime	string (date-time)	Az erőforrás létrehozásának dátuma, mintaformátum: yyyy-MM-ddTHH:mm:ssZ.
cropId	string	A ManagementZone-hoz társított körülvágásazonosító.
description	string minLength: 0 maxLength: 500	Az erőforrás szöveges leírása.
eTag	string	Az ETag értéke az optimista egyidejűség megvalósításához.
fieldId	string	A ManagementZone-hoz társított mezőazonosító.
id	string	Egyedi erőforrás-azonosító.
modifiedBy	string	Módosítva a felhasználó/bérlő azonosítója.
modifiedDateTime	string (date-time)	Az erőforrás utolsó módosításának dátuma, mintaformátum: yyyy-MM-ddTHH:mm:ssZ.
name	string minLength: 0 maxLength: 100	Az erőforrás azonosítására szolgáló név.
partyId	string	A ManagementZone-hoz társított félazonosító.
properties		Az erőforráshoz tartozó kulcsértékpárok gyűjteménye. Minden párnak nem lehet 50 karakternél nagyobb kulcsa, és nem lehet 150 karakternél nagyobb érték. Megjegyzés: Egy erőforráshoz legfeljebb 25 kulcsértékpár adható meg, és csak a sztring, a szám és a datetime (yyyy-MM-ddTHH:mm:ssZ) értékek támogatottak.
seasonId	string	A ManagementZone-hoz társított szezonazonosító.
source	string minLength: 2 maxLength: 100	Az erőforrás forrása.
status	string minLength: 0 maxLength: 100	Az erőforrás állapota.
type	string minLength: 0 maxLength: 100	A ManagementZone típusa.

ManagementZoneListResponse

Objektum

A lapozott válasz a kért objektumok listáját és egy URL-hivatkozást tartalmaz a következő találatkészlet lekéréséhez.

Name	Típus	Description
nextLink	string	Folytatási hivatkozás (abszolút URI) a lista következő találatoldalára.
skipToken	string	A következő oldal beolvasásához használt jogkivonat. Null érték esetén nincsenek további lapok.
value	ManagementZone[]	A kért objektumok listája.

Megosztás a következőn keresztül:

Management Zones - List

URI-paraméterek

Kérelem fejléce

Válaszok

Biztonság

Authorization

Példák

ManagementZones_List

Mintakérelem

Mintaválasz

Definíciók

Error

ErrorResponse

InnerError

ManagementZone

ManagementZoneListResponse