Condividi tramite


Harvest Data - List

Restituisce un elenco impaginato delle risorse dati di raccolta in tutte le parti.

GET /harvest-data?api-version=2023-06-01-preview
GET /harvest-data?minTotalYield={minTotalYield}&maxTotalYield={maxTotalYield}&minAvgYield={minAvgYield}&maxAvgYield={maxAvgYield}&minTotalWetMass={minTotalWetMass}&maxTotalWetMass={maxTotalWetMass}&minAvgWetMass={minAvgWetMass}&maxAvgWetMass={maxAvgWetMass}&minAvgMoisture={minAvgMoisture}&maxAvgMoisture={maxAvgMoisture}&minAvgSpeed={minAvgSpeed}&maxAvgSpeed={maxAvgSpeed}&sources={sources}&associatedBoundaryIds={associatedBoundaryIds}&minOperationStartDateTime={minOperationStartDateTime}&maxOperationStartDateTime={maxOperationStartDateTime}&minOperationEndDateTime={minOperationEndDateTime}&maxOperationEndDateTime={maxOperationEndDateTime}&minOperationModifiedDateTime={minOperationModifiedDateTime}&maxOperationModifiedDateTime={maxOperationModifiedDateTime}&minArea={minArea}&maxArea={maxArea}&ids={ids}&names={names}&propertyFilters={propertyFilters}&statuses={statuses}&minCreatedDateTime={minCreatedDateTime}&maxCreatedDateTime={maxCreatedDateTime}&minLastModifiedDateTime={minLastModifiedDateTime}&maxLastModifiedDateTime={maxLastModifiedDateTime}&maxPageSize={maxPageSize}&skipToken={skipToken}&api-version=2023-06-01-preview

Parametri dell'URI

Nome In Necessario Tipo Descrizione
api-version
query True

string

Versione dell'API richiesta

associatedBoundaryIds
query

string[]

ID limite associati ai dati dell'operazione.

ids
query

string[]

ID della risorsa.

maxArea
query

number

double

Area massima per cui è stata applicata l'operazione (inclusiva).

maxAvgMoisture
query

number

double

Valore massimo di AvgMoisture (inclusivo).

maxAvgSpeed
query

number

double

Valore MedioSpeed massimo (inclusivo).

maxAvgWetMass
query

number

double

Valore MedioWetMass massimo (inclusivo).

maxAvgYield
query

number

double

Valore medio massimo di AvgYield (inclusivo).

maxCreatedDateTime
query

string

date-time

Data massima di creazione della risorsa (inclusiva).

maxLastModifiedDateTime
query

string

date-time

Data massima modificata della risorsa (inclusiva).

maxOperationEndDateTime
query

string

date-time

Data di fine massima dei dati dell'operazione, formato di esempio: aaaa-MM-ddTHH:mm:ssZ (inclusivo).

maxOperationModifiedDateTime
query

string

date-time

Data massima modificata dei dati dell'operazione, formato di esempio: aaaa-MM-ddTHH:mm:ssZ (inclusivo).

maxOperationStartDateTime
query

string

date-time

Data di inizio massima dei dati dell'operazione, formato di esempio: aaaa-MM-ddTHH:mm:ssZ (inclusivo).

maxPageSize
query

integer

int32

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

maxTotalWetMass
query

number

double

Valore massimo di WetMass (inclusivo).

maxTotalYield
query

number

double

Valore massimo di rendimento (inclusivo).

minArea
query

number

double

Area minima per cui è stata applicata l'operazione (inclusiva).

minAvgMoisture
query

number

double

Valore minimo avgMoisture(inclusivo).

minAvgSpeed
query

number

double

Valore di AvgSpeed minimo(inclusivo).

minAvgWetMass
query

number

double

Valore minimo avgWetMass(inclusivo).

minAvgYield
query

number

double

Valore minimo avgYield(inclusivo).

minCreatedDateTime
query

string

date-time

Data minima di creazione della risorsa (inclusiva).

minLastModifiedDateTime
query

string

date-time

Data minima modificata della risorsa (inclusiva).

minOperationEndDateTime
query

string

date-time

Data di fine minima dei dati dell'operazione, formato di esempio: aaaa-MM-ddTHH:mm:ssZ (inclusivo).

minOperationModifiedDateTime
query

string

date-time

Data minima modificata dei dati dell'operazione, formato di esempio: aaaa-MM-ddTHH:mm:ssZ (inclusivo).

minOperationStartDateTime
query

string

date-time

Data di inizio minima dei dati dell'operazione, formato di esempio: a-MM-ddTHH:mm:ssZ (inclusivo).

minTotalWetMass
query

number

double

Valore minimo di WetMass(inclusivo).

minTotalYield
query

number

double

Valore minimo di rendimento(inclusivo).

names
query

string[]

Nomi della risorsa.

propertyFilters
query

string[]

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

skipToken
query

string

Ignorare il token per ottenere il set successivo di risultati.

sources
query

string[]

Origini dei dati dell'operazione.

statuses
query

string[]

Stato 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

HarvestDataListResponse

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

HarvestData_List

Esempio di richiesta

GET /harvest-data?api-version=2023-06-01-preview

Risposta di esempio

{
  "value": [
    {
      "partyId": "PARTY123",
      "id": "HARVESTOP123",
      "source": "Manual",
      "name": "Harvest data for North Farm",
      "description": "some description",
      "status": "Active",
      "operationStartDateTime": "2021-04-21T06:49:30Z",
      "operationEndDateTime": "2021-04-21T06:49:30Z",
      "operationModifiedDateTime": "2021-04-21T06:49:30Z",
      "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY",
      "area": {
        "unit": "acre",
        "value": 50
      },
      "totalYield": {
        "unit": "kilos",
        "value": 1400
      },
      "avgYield": {
        "unit": "kilosperacre",
        "value": 28
      },
      "totalWetMass": {
        "unit": "kilos",
        "value": 500
      },
      "avgWetMass": {
        "unit": "kilosperacre",
        "value": 10
      },
      "avgMoisture": {
        "unit": "percent",
        "value": 14.61
      },
      "avgSpeed": {
        "unit": "kmsperhour",
        "value": 7.2
      },
      "harvestProductDetails": [
        {
          "productName": "VAR1",
          "area": {
            "unit": "acre",
            "value": 30
          },
          "totalYield": {
            "unit": "kilos",
            "value": 900
          },
          "avgYield": {
            "unit": "kilosperacre",
            "value": 30
          },
          "totalWetMass": {
            "unit": "kilos",
            "value": 300
          },
          "avgWetMass": {
            "unit": "kilosperacre",
            "value": 10
          },
          "avgMoisture": {
            "unit": "percent",
            "value": 16.4
          }
        }
      ],
      "properties": {
        "Region": "Europe",
        "CountyCode": 123
      },
      "attachmentsLink": "https://<resource-name>.farmbeats.azure.net/party/{{partyId}}/attachments?api-version={{apiVersion}}&resourceIds={{harvestDataId}}&resourceTypes=HarvestData",
      "createdDateTime": "2021-04-21T06:49:30Z",
      "modifiedDateTime": "2021-04-21T06:49:30Z",
      "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000"
    }
  ],
  "skipToken": "string",
  "nextLink": "https:/{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/harvestData?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7ehK8eAKzdo1MNnwcAAAAAAA%3d%3d%23RT%3a1%23TRC%3a10%23ISV%3a2%23IEO%3a65551%23FPC%3aAQ2fBwAAAAAAD58HAAAAAAA%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. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses per il documento di riferimento ErrorResponse.

HarvestData

Schema della risorsa dati di raccolta.

HarvestDataListResponse

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

HarvestProductDetail

Schema del prodotto usato durante la raccolta.

InnerError

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

Measure

Schema per archiviare la lettura e l'unità di misurazione.

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 l'errore segnalato.

innererror

InnerError

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

Nome Tipo Descrizione
error

Error

Errore del servizio Azure AgPlatform.

traceId

string

ID traccia univoco.

HarvestData

Schema della risorsa dati di raccolta.

Nome Tipo Descrizione
area

Measure

Schema per archiviare la lettura e l'unità di misurazione.

associatedBoundaryId

string

ID limite facoltativo del campo per cui è stata applicata l'operazione.

attachmentsLink

string

Collegamento per gli allegati.

avgMoisture

Measure

Schema per archiviare la lettura e l'unità di misurazione.

avgSpeed

Measure

Schema per archiviare la lettura e l'unità di misurazione.

avgWetMass

Measure

Schema per archiviare la lettura e l'unità di misurazione.

avgYield

Measure

Schema per archiviare la lettura e l'unità di misurazione.

createdBy

string

Creato dall'ID utente/tenant.

createdDateTime

string

Data-ora in cui è stata creata la risorsa, formato di esempio: aaaa-MM-ddTHH:mm:ssZ.

description

string

Descrizione testuale della risorsa.

eTag

string

Valore ETag per implementare la concorrenza ottimistica.

harvestProductDetails

HarvestProductDetail[]

Raccogliere i dettagli del prodotto.

id

string

ID risorsa univoco.

modifiedBy

string

Modificato dall'ID utente/tenant.

modifiedDateTime

string

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

name

string

Nome che identifica la risorsa.

operationEndDateTime

string

Data di fine dei dati dell'operazione, formato di esempio: aaaa-MM-ddTHH:mm:ssZ.

operationModifiedDateTime

string

Data-ora modificata dei dati dell'operazione, formato di esempio: aaaa-MM-ddTHH:mm:ssZ. Nota: verrà specificato dal provider di origine stesso.

operationStartDateTime

string

Data di inizio dei dati dell'operazione, formato di esempio: aaaa-MM-ddTHH:mm:ssZ.

partyId

string

ID parte che appartiene ai dati dell'operazione.

properties

Raccolta di coppie di valori chiave 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 di valori chiave per una risorsa e solo una stringa, un numero e una datatime (aaaa-MM-ddTHH:mm:ssZ) sono supportati.

source

string

Origine della risorsa.

status

string

Stato della risorsa.

totalWetMass

Measure

Schema per archiviare la lettura e l'unità di misurazione.

totalYield

Measure

Schema per archiviare la lettura e l'unità di misurazione.

HarvestDataListResponse

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

Nome Tipo Descrizione
nextLink

string

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

skipToken

string

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

value

HarvestData[]

Elenco degli oggetti richiesti.

HarvestProductDetail

Schema del prodotto usato durante la raccolta.

Nome Tipo Descrizione
area

Measure

Schema per archiviare la lettura e l'unità di misurazione.

avgMoisture

Measure

Schema per archiviare la lettura e l'unità di misurazione.

avgWetMass

Measure

Schema per archiviare la lettura e l'unità di misurazione.

avgYield

Measure

Schema per archiviare la lettura e l'unità di misurazione.

productName

string

Nome del prodotto.

totalWetMass

Measure

Schema per archiviare la lettura e l'unità di misurazione.

totalYield

Measure

Schema per archiviare la lettura e l'unità di misurazione.

InnerError

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

Nome Tipo Descrizione
code

string

Codice di errore specifico rispetto a quello fornito dall'errore contenente.

innererror

InnerError

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

Measure

Schema per archiviare la lettura e l'unità di misurazione.

Nome Tipo Descrizione
unit

string

Unità dati.

value

number

Valore dei dati.