Fields - List By Farmer Id

Servizio:

Azure Data Manager for Agriculture

Versione API:

2021-07-31-preview

Restituisce un elenco impaginato di risorse sul campo in un particolare agricoltore.

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

Con parametri facoltativi:

GET /farmers/{farmerId}/fields?farmIds={farmIds}&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) minimum: 10 maximum: 1000	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.
farmIds	query		string[]	ID farm della risorsa.
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 dell'ultima modifica della risorsa (inclusi).
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}".
statuses	query		string[]	Stati della risorsa.

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	FieldListResponse	Successo
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

Fields_ListByFarmerId

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:

200

{
  "value": [
    {
      "id": "FIELD123",
      "farmerId": "FARMER123",
      "farmId": "FARM123",
      "primaryBoundaryId": "BOUNDARY123",
      "boundaryIds": [
        "BOUNDARY123",
        "BOUNDARY456"
      ],
      "name": "John Smith's Field",
      "status": "Active",
      "description": "Some description",
      "properties": {
        "Irrigated": "Yes",
        "RetailerId": "Retailer123"
      },
      "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}}/seasonalFields/{{seasonalFieldId}}?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. Documento di riferimento ErrorResponse..
Field	Schema della risorsa campo.
FieldListResponse	La risposta a pagina contiene un elenco di oggetti richiesti e un collegamento URL per ottenere il set di risultati successivo.
InnerError	Errore interno contenente l'elenco degli errori. Documento di riferimento InnerError.

Error

Object

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 l'errore segnalato.
innererror	InnerError	Errore interno contenente l'elenco degli errori. Documento di riferimento InnerError.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

ErrorResponse

Object

Risposta di errore dal servizio Azure AgPlatform. Documento di riferimento ErrorResponse..

Nome	Tipo	Descrizione
error	Error	Errore del servizio Azure AgPlatform.
traceId	string	ID traccia univoco.

Field

Object

Schema della risorsa campo.

Nome	Tipo	Descrizione
boundaryIds	string[]	ID limite.
createdDateTime	string (date-time)	Data e ora di creazione della risorsa, formato di esempio: aaaa-MM-ggTHH:mm:ssZ.
description	string minLength: 0 maxLength: 500	Descrizione testuale della risorsa.
eTag	string	Valore ETag per implementare la concorrenza ottimistica.
farmId	string	ID della farm associata.
farmerId	string	Id contadino.
id	string	ID risorsa univoco.
modifiedDateTime	string (date-time)	Data e ora dell'ultima modifica della risorsa, formato di esempio: aaaa-MM-ggTHH:mm:ssZ.
name	string minLength: 0 maxLength: 100	Nome per identificare la risorsa.
primaryBoundaryId	string	ID limite primario.
properties		Raccolta di coppie chiave-valore che appartengono 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 di valori chiave per una risorsa e solo valori stringa, numerali e datetime (aaaa-MM-ggTHH:mm:ssZ).
source	string minLength: 2 maxLength: 100	Origine della risorsa.
status	string minLength: 0 maxLength: 100	Stato della risorsa.

FieldListResponse

Object

La risposta a pagina contiene un 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 continuazione (URI assoluto) alla pagina successiva dei risultati nell'elenco.
value	Field[]	Elenco di oggetti richiesti.

InnerError

Object

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

Nome	Tipo	Descrizione
code	string	Codice di errore specifico di quello fornito dall'errore contenitore.
innererror	InnerError	Errore interno contenente l'elenco degli errori. Documento di riferimento InnerError.