Harvest Data - List

Usługa:: Azure Data Manager for Agriculture

Wersja interfejsu API:: 2023-06-01-preview

Zwraca listę podzielonych na strony zasobów danych zbierania we wszystkich partiach.

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
api-version	query	True	string	Żądana wersja interfejsu API
associatedBoundaryIds	query		string[]	Identyfikatory granic skojarzone z danymi operacji.
ids	query		string[]	Identyfikatory zasobu.
maxArea	query		number (double)	Maksymalny obszar, dla którego zastosowano operację (włącznie).
maxAvgMoisture	query		number (double)	Maksymalna wartość avgMoisture (włącznie).
maxAvgSpeed	query		number (double)	Maksymalna wartość AvgSpeed (włącznie).
maxAvgWetMass	query		number (double)	Maksymalna wartość AvgWetMass (włącznie).
maxAvgYield	query		number (double)	Maksymalna wartość avgYield (włącznie).
maxCreatedDateTime	query		string (date-time)	Maksymalna data utworzenia zasobu (włącznie).
maxLastModifiedDateTime	query		string (date-time)	Maksymalna data ostatniej modyfikacji zasobu (włącznie).
maxOperationEndDateTime	query		string (date-time)	Maksymalna data zakończenia danych operacji, format próbki: rrrr-MM-ddTHH:mm:ssZ (włącznie).
maxOperationModifiedDateTime	query		string (date-time)	Maksymalna data-godzina modyfikacji danych operacji, format próbki: rrrr-MM-ddTHH:mm:ssZ (włącznie).
maxOperationStartDateTime	query		string (date-time)	Maksymalna data rozpoczęcia danych operacji, format próbki: rrrr-MM-ddTHH:mm:ssZ (włącznie).
maxPageSize	query		integer (int32) minimum: 10 maximum: 1000	Maksymalna liczba potrzebnych elementów (włącznie). Minimum = 10, Maksimum = 1000, Wartość domyślna = 50.
maxTotalWetMass	query		number (double)	Maksymalna wartość Total WetMass (włącznie).
maxTotalYield	query		number (double)	Maksymalna wartość wydajności (włącznie).
minArea	query		number (double)	Minimalny obszar, dla którego zastosowano operację (włącznie).
minAvgMoisture	query		number (double)	Minimalna wartość avgMoisture (włącznie).
minAvgSpeed	query		number (double)	Minimalna wartość AvgSpeed (włącznie).
minAvgWetMass	query		number (double)	Minimalna wartość AvgWetMass (włącznie).
minAvgYield	query		number (double)	Minimalna wartość avgYield (włącznie).
minCreatedDateTime	query		string (date-time)	Minimalna data utworzenia zasobu (włącznie).
minLastModifiedDateTime	query		string (date-time)	Minimalna data ostatniej modyfikacji zasobu (włącznie).
minOperationEndDateTime	query		string (date-time)	Minimalna data zakończenia danych operacji, format próbki: rrrr-MM-ddTHH:mm:ssZ (włącznie).
minOperationModifiedDateTime	query		string (date-time)	Minimalna zmodyfikowana data/godzina danych operacji, format próbki: rrrr-MM-ddTHH:mm:ssZ (włącznie).
minOperationStartDateTime	query		string (date-time)	Minimalna data rozpoczęcia danych operacji, format próbki: rrrr-MM-ddTHH:mm:ssZ (włącznie).
minTotalWetMass	query		number (double)	Minimalna wartość Total WetMass (włącznie).
minTotalYield	query		number (double)	Minimalna wartość wydajności (włącznie).
names	query		string[]	Nazwy zasobu.
propertyFilters	query		string[]	Filtry par klucz-wartość w obiekcie Properties. Np. "{testKey} eq {testValue}".
skipToken	query		string	Pomiń token w celu uzyskania następnego zestawu wyników.
sources	query		string[]	Źródła danych operacji.
statuses	query		string[]	Stan zasobu.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Authorization	True	string	Podaj prawidłowy token elementu nośnego dla autoryzowanych wywołań interfejsu API. Pamiętaj, że może być konieczne wyczyszczenie pamięci podręcznej przeglądarki, jeśli wcześniej próbowano wykonać nieuwierzytelnione wywołania.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	HarvestDataListResponse	Powodzenie
Other Status Codes	ErrorResponse	Błąd Nagłówki x-ms-error-code: string

Nazwa

Typ

Opis

200 OK

HarvestDataListResponse

Powodzenie

Other Status Codes

ErrorResponse

Błąd

Nagłówki

x-ms-error-code: string

Zabezpieczenia

Authorization

Podaj prawidłowy token elementu nośnego dla autoryzowanych wywołań interfejsu API. Pamiętaj, że może być konieczne wyczyszczenie pamięci podręcznej przeglądarki, jeśli wcześniej próbowano wykonać nieuwierzytelnione wywołania.

Typ: apiKey
W: header

Przykłady

HarvestData_List

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

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

Definicje

Nazwa	Opis
Error	Błąd usługi Azure AgPlatform.
ErrorResponse	Odpowiedź na błąd z usługi Azure AgPlatform. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses, aby zapoznać się z dokumentem referencyjnym ErrorResponse.
HarvestData	Schemat zasobu danych zbierania.
HarvestDataListResponse	Odpowiedź stronicowana zawiera listę żądanych obiektów i link adresu URL, aby uzyskać następny zestaw wyników.
HarvestProductDetail	Schemat produktu używanego podczas zbierania.
InnerError	Wewnętrzny błąd zawierający listę błędów. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object, aby zapoznać się z dokumentem referencyjnym InnerError.
Measure	Schemat przechowywania odczytu i jednostki miary.

Error

Objekt

Błąd usługi Azure AgPlatform.

Nazwa	Typ	Opis
code	string minLength: 1	Zdefiniowany przez serwer zestaw kodów błędów.
details	Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	InnerError	Wewnętrzny błąd zawierający listę błędów. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object, aby zapoznać się z dokumentem referencyjnym InnerError.
message	string minLength: 1	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd z usługi Azure AgPlatform. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses, aby zapoznać się z dokumentem referencyjnym ErrorResponse.

Nazwa	Typ	Opis
error	Error	Błąd usługi Azure AgPlatform.
traceId	string	Unikatowy identyfikator śledzenia.

HarvestData

Objekt

Schemat zasobu danych zbierania.

Nazwa	Typ	Opis
area	Measure	Schemat przechowywania odczytu i jednostki miary.
associatedBoundaryId	string	Opcjonalny identyfikator granicy pola, dla którego zastosowano operację.
attachmentsLink	string	Link do załączników.
avgMoisture	Measure	Schemat przechowywania odczytu i jednostki miary.
avgSpeed	Measure	Schemat przechowywania odczytu i jednostki miary.
avgWetMass	Measure	Schemat przechowywania odczytu i jednostki miary.
avgYield	Measure	Schemat przechowywania odczytu i jednostki miary.
createdBy	string	Utworzony przez identyfikator użytkownika/dzierżawy.
createdDateTime	string (date-time)	Data i godzina utworzenia zasobu, przykładowy format: rrrr-MM-ddTHH:mm:ssZ.
description	string minLength: 0 maxLength: 500	Tekstowy opis zasobu.
eTag	string	Wartość ETag w celu zaimplementowania optymistycznej współbieżności.
harvestProductDetails	HarvestProductDetail[]	Zbieranie szczegółów produktu.
id	string	Unikatowy identyfikator zasobu.
modifiedBy	string	Zmodyfikowany przez identyfikator użytkownika/dzierżawy.
modifiedDateTime	string (date-time)	Data i godzina ostatniej modyfikacji zasobu, format próbki: rrrr-MM-ddTHH:mm:ssZ.
name	string minLength: 0 maxLength: 100	Nazwa identyfikującego zasób.
operationEndDateTime	string (date-time)	Data zakończenia danych operacji, format próbki: rrrr-MM-ddTHH:mm:ssZ.
operationModifiedDateTime	string (date-time)	Zmodyfikowano datę i godzinę danych operacji, format próbki: rrrr-MM-ddTHH:mm:ssZ. Uwaga: zostanie to określone przez samego dostawcę źródłowego.
operationStartDateTime	string (date-time)	Data rozpoczęcia danych operacji, przykładowy format: rrrr-MM-ddTHH:mm:ssZ.
partyId	string	Identyfikator strony, który należy do danych operacji.
properties		Kolekcja par klucz-wartość, która należy do zasobu. Każda para nie może mieć klucza większego niż 50 znaków i nie może mieć wartości większej niż 150 znaków. Uwaga: Dla zasobu można podać maksymalnie 25 par wartości klucza, a obsługiwane są tylko wartości ciągu, liczb i daty/godziny (rrrr-MM-ddTHH:mm:ssZ).
source	string minLength: 2 maxLength: 100	Źródło zasobu.
status	string minLength: 0 maxLength: 100	Stan zasobu.
totalWetMass	Measure	Schemat przechowywania odczytu i jednostki miary.
totalYield	Measure	Schemat przechowywania odczytu i jednostki miary.

HarvestDataListResponse

Objekt

Odpowiedź stronicowana zawiera listę żądanych obiektów i link adresu URL, aby uzyskać następny zestaw wyników.

Nazwa	Typ	Opis
nextLink	string	Link kontynuacji (bezwzględny identyfikator URI) do następnej strony wyników na liście.
skipToken	string	Token używany podczas pobierania następnej strony. Jeśli wartość null, nie ma żadnych dodatkowych stron.
value	HarvestData[]	Lista żądanych obiektów.

HarvestProductDetail

Objekt

Schemat produktu używanego podczas zbierania.

Nazwa	Typ	Opis
area	Measure	Schemat przechowywania odczytu i jednostki miary.
avgMoisture	Measure	Schemat przechowywania odczytu i jednostki miary.
avgWetMass	Measure	Schemat przechowywania odczytu i jednostki miary.
avgYield	Measure	Schemat przechowywania odczytu i jednostki miary.
productName	string minLength: 1 maxLength: 100	Nazwa produktu.
totalWetMass	Measure	Schemat przechowywania odczytu i jednostki miary.
totalYield	Measure	Schemat przechowywania odczytu i jednostki miary.

InnerError

Objekt

Wewnętrzny błąd zawierający listę błędów. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object, aby zapoznać się z dokumentem referencyjnym InnerError.

Nazwa	Typ	Opis
code	string	Określony kod błędu niż został dostarczony przez błąd zawierający.
innererror	InnerError	Wewnętrzny błąd zawierający listę błędów. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object, aby zapoznać się z dokumentem referencyjnym InnerError.

Measure

Objekt

Schemat przechowywania odczytu i jednostki miary.

Nazwa	Typ	Opis
unit	string minLength: 1 maxLength: 50	Jednostka danych.
value	number (double)	Wartość danych.

Udostępnij za pośrednictwem

Harvest Data - List

Parametry identyfikatora URI

Nagłówek żądania

Odpowiedzi

Zabezpieczenia

Authorization

Przykłady

HarvestData_List

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

Error

ErrorResponse

HarvestData

HarvestDataListResponse

HarvestProductDetail

InnerError

Measure