Condividi tramite


Management Zones - List By Farmer Id

Restituisce un elenco impaginato di risorse della zona di gestione in un determinato agricoltore.

GET /farmers/{farmerId}/management-zones?api-version=2021-07-31-preview
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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
farmerId
path True

string

ID dell'agricoltore associato.

api-version
query True

string

Versione dell'API richiesta

$maxPageSize
query

integer

int32

Numero massimo di elementi necessari (inclusi). Minimo = 10, Massimo = 1000, Valore predefinito = 50.

$skipToken
query

string

Ignorare il token per ottenere il set di risultati successivo.

cropIds
query

string[]

CropIds di ManagementZone.

fieldIds
query

string[]

FieldIds di ManagementZone.

ids
query

string[]

ID della risorsa.

maxCreatedDateTime
query

string

date-time

Data massima di creazione della risorsa (inclusiva).

maxLastModifiedDateTime
query

string

date-time

Data massima modificata della risorsa (inclusiva).

minCreatedDateTime
query

string

date-time

Data minima di creazione della risorsa (inclusiva).

minLastModifiedDateTime
query

string

date-time

Data minima dell'ultima modifica della risorsa (inclusiva).

names
query

string[]

Nomi della risorsa.

propertyFilters
query

string[]

Filtra le coppie chiave-valore all'interno dell'oggetto Properties. Ad esempio: "{testKey} eq {testValue}".

seasonIds
query

string[]

SeasonIds di ManagementZone.

sources
query

string[]

Origini di ManagementZone.

statuses
query

string[]

Stati della risorsa.

types
query

string[]

Tipi di ManagementZone.

Intestazione della richiesta

Nome Necessario Tipo Descrizione
Authorization True

string

Specificare un token di connessione valido per le chiamate API autorizzate. Si noti che potrebbe essere necessario cancellare la cache del browser se si è tentato di eseguire chiamate non autenticate prima.

Risposte

Nome Tipo Descrizione
200 OK

ManagementZoneListResponse

Operazione completata

Other Status Codes

ErrorResponse

Errore

Intestazioni

x-ms-error-code: string

Sicurezza

Authorization

Specificare un token di connessione valido per le chiamate API autorizzate. Si noti che potrebbe essere necessario cancellare la cache del browser se si è tentato di eseguire chiamate non autenticate prima.

Tipo: apiKey
In: header

Esempio

ManagementZones_ListByFarmerId

Esempio di richiesta

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

Risposta di esempio

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

Definizioni

Nome Descrizione
Error

Errore del servizio Azure AgPlatform.

ErrorResponse

Risposta di errore dal servizio Azure AgPlatform. ErrorResponse reference document..

InnerError

Errore interno contenente l'elenco di errori. Documento di riferimento InnerError.

ManagementZone

Modello API per l'oggetto ManagementZone.

ManagementZoneListResponse

La risposta di paging contiene l'elenco di oggetti richiesti e un collegamento URL per ottenere il set di risultati successivo.

Error

Errore del servizio Azure AgPlatform.

Nome Tipo Descrizione
code

string

Set definito dal server di codici di errore.

details

Error[]

Matrice di dettagli sugli errori specifici che hanno causato questo errore segnalato.

innererror

InnerError

Errore interno contenente l'elenco di errori. Documento di riferimento InnerError.

message

string

Rappresentazione leggibile dell'errore.

target

string

Destinazione dell'errore.

ErrorResponse

Risposta di errore dal servizio Azure AgPlatform. ErrorResponse reference document..

Nome Tipo Descrizione
error

Error

Errore del servizio Azure AgPlatform.

traceId

string

ID di traccia univoco.

InnerError

Errore interno contenente l'elenco di errori. Documento di riferimento InnerError.

Nome Tipo Descrizione
code

string

Codice di errore specifico di quello fornito dall'errore che lo contiene.

innererror

InnerError

Errore interno contenente l'elenco di errori. Documento di riferimento InnerError.

ManagementZone

Modello API per l'oggetto ManagementZone.

Nome Tipo Descrizione
createdDateTime

string

Data e ora di creazione della risorsa, formato di esempio: a-MM-ggTHH:mm:ssZ.

cropId

string

ID ritaglio associato a ManagementZone.

description

string

Descrizione testuale della risorsa.

eTag

string

Valore ETag per implementare la concorrenza ottimistica.

farmerId

string

ID contadino associato a ManagementZone.

fieldId

string

ID campo associato a ManagementZone.

id

string

ID risorsa univoco.

modifiedDateTime

string

Data e ora dell'ultima modifica della risorsa, formato di esempio: aaaa-MM-ggTHH:mm:ssZ.

name

string

Nome che identifica la risorsa.

properties

Raccolta di coppie chiave-valore appartenenti alla risorsa. Ogni coppia non deve avere una chiave maggiore di 50 caratteri e non deve avere un valore maggiore di 150 caratteri. Nota: è possibile specificare un massimo di 25 coppie chiave-valore per una risorsa e sono supportati solo valori stringa, numerali e datetime (aa-MM-ggTHH:mm:ssZ).

seasonId

string

ID stagione associato a ManagementZone.

source

string

Origine della risorsa.

status

string

Stato della risorsa.

type

string

Tipo di ManagementZone.

ManagementZoneListResponse

La risposta di paging contiene l'elenco di oggetti richiesti e un collegamento URL per ottenere il set di risultati successivo.

Nome Tipo Descrizione
$skipToken

string

Token usato per recuperare la pagina successiva. Se null, non sono presenti pagine aggiuntive.

nextLink

string

Collegamento di continuità (URI assoluto) alla pagina successiva dell'elenco.

value

ManagementZone[]

Elenco di oggetti richiesti.