Fields - Get

Servizio:

Azure Data Manager for Agriculture

Versione API:

2023-11-01-preview

Ottiene una risorsa di campo specificata in una determinata parte.

GET {endpoint}/parties/{partyId}/fields/{fieldId}?api-version=2023-11-01-preview

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string uri	Nome host dello spazio dei nomi, ad esempio admaInstanceName.farmbeats.azure.net
fieldId	path	True	string	ID del campo.
partyId	path	True	string	ID della parte associata.
api-version	query	True	string	Versione dell'API richiesta

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	Field	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

Fields_Get

Esempio di richiesta

HTTP

GET {endpoint}/parties/PARTY123/fields/FIELD123?api-version=2023-11-01-preview

Risposta di esempio

Codice di stato:

200

{
  "id": "FIELD123",
  "partyId": "PARTY123",
  "farmId": "FARM123",
  "name": "John Smith's Field",
  "status": "Active",
  "description": "Some description",
  "source": "source",
  "properties": {
    "Irrigated": "Yes",
    "RetailerId": "Retailer123"
  },
  "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"
}

Definizioni

Nome	Descrizione
Error	Errore del servizio Azure AgPlatform.
ErrorResponse	Risposta di errore dal servizio Azure AgPlatform. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses il documento di riferimento ErrorResponse.
Field	Schema della risorsa campo.
GeoJsonObjectType	Tipo di oggetto GeoJSON.
InnerError	Errore interno contenente l'elenco di errori. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object il documento di riferimento per InnerError.
MultiPolygon	Geometria multipolygon.
Point	Geometria del punto.
Polygon	Geometria poligono.

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. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object il documento di riferimento per InnerError.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

ErrorResponse

Risposta di errore dal servizio Azure AgPlatform. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses il documento di riferimento ErrorResponse.

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

Field

Schema della risorsa campo.

Nome	Tipo	Descrizione
createdBy	string	Creato dall'ID utente/tenant.
createdDateTime	string	Data e ora di creazione della risorsa, formato di esempio: a-MM-ggTHH:mm:ssZ.
description	string	Descrizione testuale della risorsa.
eTag	string	Valore ETag per implementare la concorrenza ottimistica.
farmId	string	ID della farm associata.
geometry	GeoJsonObject: MultiPolygon Point Polygon	GeoJSON (per altri dettagli: https://geojson.org/). Nota: le coordinate sono previste in formato [Longitudine, Latitudine].
id	string	ID risorsa univoco.
modifiedBy	string	Modificato dall'ID utente/tenant.
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.
partyId	string	ID entità.
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).
source	string	Origine della risorsa.
status	string	Stato della risorsa.

GeoJsonObjectType

Tipo di oggetto GeoJSON.

Nome	Tipo	Descrizione
MultiPolygon	string
Point	string
Polygon	string

InnerError

Errore interno contenente l'elenco di errori. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object il documento di riferimento per 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. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object il documento di riferimento per InnerError.

MultiPolygon

Geometria multipolygon.

Nome	Tipo	Descrizione
coordinates	number[]	Ottiene o imposta le coordinate dell'oggetto GeoJSON. Deve essere una matrice di poligoni, ogni poligono contiene un elenco di anelli lineari. Per i poligoni con più anelli, il primo DEVE essere l'anello esterno e tutti gli altri devono essere anelli interni.
type	string: MultiPolygon	Tipo di oggetto GeoJSON.

Point

Geometria del punto.

Nome	Tipo	Descrizione
coordinates	number[]	Ottiene o imposta la coordinata di questo punto. Deve essere una matrice di 2 o 3 elementi per un sistema 2D o 3D.
type	string: Point	Tipo di oggetto GeoJSON.

Polygon

Geometria poligono.

Nome	Tipo	Descrizione
coordinates	number[]	Ottiene o imposta il tipo di oggetto GeoJSON. Deve essere una matrice di matrici di coordinate circolari lineari. Per i poligoni con più anelli, il primo DEVE essere l'anello esterno e tutti gli altri devono essere anelli interni.
type	string: Polygon	Tipo di oggetto GeoJSON.