Farms - Get

Servizio:

Azure Data Manager for Agriculture

Versione API:

2023-11-01-preview

Ottiene una risorsa farm specificata in una determinata parte.

GET {endpoint}/parties/{partyId}/farms/{farmId}?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
farmId	path	True	string	ID della risorsa farm.
partyId	path	True	string	ID della risorsa di entità 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	Farm	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

Farms_Get

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:

200

{
  "id": "FARM123",
  "partyId": "PARTY123",
  "name": "John Smith's Farm",
  "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.
Farm	Schema della risorsa farm.
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.

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.

Farm

Schema della risorsa farm.

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

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.