Harvest Data - List

Služba:: Azure Data Manager for Agriculture

Verze rozhraní API:: 2023-06-01-preview

Vrátí stránkovaný seznam prostředků dat pro získávání dat napříč všemi stranami.

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

S volitelnými parametry:

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 identifikátoru URI

Name	V	Vyžadováno	Typ	Description
api-version	query	True	string	Požadovaná verze rozhraní API
associatedBoundaryIds	query		string[]	ID hranic přidružená k datům operace.
ids	query		string[]	ID prostředku.
maxArea	query		number (double)	Maximální oblast, pro kterou se operace použila (včetně).
maxAvgMoisture	query		number (double)	Maximální hodnota AvgMoisture (včetně).
maxAvgSpeed	query		number (double)	Maximální hodnota AvgSpeed (včetně).
maxAvgWetMass	query		number (double)	Maximální hodnota AvgWetMass (včetně).
maxAvgYield	query		number (double)	Maximální hodnota AvgYield (včetně).
maxCreatedDateTime	query		string (date-time)	Maximální datum vytvoření prostředku (včetně).
maxLastModifiedDateTime	query		string (date-time)	Maximální datum poslední změny prostředku (včetně).
maxOperationEndDateTime	query		string (date-time)	Maximální datum a čas ukončení dat operace, ukázkový formát: rrrr-MM-ddTHH:mm:ssZ (včetně).
maxOperationModifiedDateTime	query		string (date-time)	Maximální datum-čas změny dat operace, ukázkový formát: rrrr-MM-ddTHH:mm:ssZ (včetně).
maxOperationStartDateTime	query		string (date-time)	Maximální počáteční datum a čas dat operace, ukázkový formát: rrrr-MM-ddTHH:mm:ssZ (včetně).
maxPageSize	query		integer (int32) minimum: 10 maximum: 1000	Maximální počet potřebných položek (včetně). Minimum = 10, Maximum = 1000, Výchozí hodnota = 50.
maxTotalWetMass	query		number (double)	Maximální celková hodnota WetMass (včetně).
maxTotalYield	query		number (double)	Maximální hodnota výnosu (včetně).
minArea	query		number (double)	Minimální oblast, pro kterou byla operace použita (včetně).
minAvgMoisture	query		number (double)	Minimální hodnota AvgMoisture (včetně).
minAvgSpeed	query		number (double)	Minimální hodnota AvgSpeed (včetně).
minAvgWetMass	query		number (double)	Minimální hodnota AvgWetMass (včetně).
minAvgYield	query		number (double)	Minimální hodnota AvgYield (včetně).
minCreatedDateTime	query		string (date-time)	Minimální datum vytvoření prostředku (včetně).
minLastModifiedDateTime	query		string (date-time)	Minimální datum poslední změny prostředku (včetně).
minOperationEndDateTime	query		string (date-time)	Minimální datum ukončení dat operace, ukázkový formát: rrrr-MM-ddTHH:mm:ssZ (včetně).
minOperationModifiedDateTime	query		string (date-time)	Minimální datum a čas změny dat operace, ukázkový formát: rrrr-MM-ddTHH:mm:ssZ (včetně).
minOperationStartDateTime	query		string (date-time)	Minimální počáteční datum a čas dat operace, ukázkový formát: rrrr-MM-ddTHH:mm:ssZ (včetně).
minTotalWetMass	query		number (double)	Minimální celková hodnota WetMass (včetně).
minTotalYield	query		number (double)	Minimální hodnota výnosu (včetně).
names	query		string[]	Názvy prostředku
propertyFilters	query		string[]	Filtruje páry klíč-hodnota v rámci objektu Properties. Např. {testKey} eq {testValue}.
skipToken	query		string	Přeskočte token pro získání další sady výsledků.
sources	query		string[]	Zdroje dat operace.
statuses	query		string[]	Stavy prostředku

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Authorization	True	string	Zadejte platný nosný token pro autorizovaná volání rozhraní API. Mějte na paměti, že pokud jste zkusili neověřené volání dříve, možná budete muset vymazat mezipaměť prohlížeče.

Odpovědi

Name	Typ	Description
200 OK	HarvestDataListResponse	Úspěch
Other Status Codes	ErrorResponse	Chyba Hlavičky x-ms-error-code: string

Name

Typ

Description

200 OK

HarvestDataListResponse

Úspěch

Other Status Codes

ErrorResponse

Chyba

Hlavičky

x-ms-error-code: string

Zabezpečení

Authorization

Zadejte platný nosný token pro autorizovaná volání rozhraní API. Mějte na paměti, že pokud jste zkusili neověřené volání dříve, možná budete muset vymazat mezipaměť prohlížeče.

Typ: apiKey
V: header

Příklady

HarvestData_List

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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"
}

Definice

Name	Description
Error	Chyba ze služby Azure AgPlatform.
ErrorResponse	Odpověď na chybu ze služby Azure AgPlatform. Viz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses referenčního dokumentu ErrorResponse.
HarvestData	Schéma zdroje dat pro získávání dat
HarvestDataListResponse	Stránkovaná odpověď obsahuje seznam požadovaných objektů a odkaz URL pro získání další sady výsledků.
HarvestProductDetail	Schéma výrobku použitého během sběru.
InnerError	Vnitřní chyba obsahující seznam chyb Viz referenční dokument https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object pro InnerError.
Measure	Schéma pro ukládání měření čtení a jednotky

Error

Objekt

Chyba ze služby Azure AgPlatform.

Name	Typ	Description
code	string minLength: 1	Sada kódů chyb definovaná serverem
details	Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	InnerError	Vnitřní chyba obsahující seznam chyb Viz referenční dokument https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object pro InnerError.
message	string minLength: 1	Čitelné znázornění chyby člověkem
target	string	Cíl chyby.

ErrorResponse

Objekt

Odpověď na chybu ze služby Azure AgPlatform. Viz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses referenčního dokumentu ErrorResponse.

Name	Typ	Description
error	Error	Chyba ze služby Azure AgPlatform.
traceId	string	Jedinečné ID trasování

HarvestData

Objekt

Schéma zdroje dat pro získávání dat

Name	Typ	Description
area	Measure	Schéma pro ukládání měření čtení a jednotky
associatedBoundaryId	string	Volitelné ID hranice pole, pro které byla použita operace.
attachmentsLink	string	Odkaz na přílohy
avgMoisture	Measure	Schéma pro ukládání měření čtení a jednotky
avgSpeed	Measure	Schéma pro ukládání měření čtení a jednotky
avgWetMass	Measure	Schéma pro ukládání měření čtení a jednotky
avgYield	Measure	Schéma pro ukládání měření čtení a jednotky
createdBy	string	Vytvořil(a) id uživatele nebo tenanta.
createdDateTime	string (date-time)	Datum a čas vytvoření prostředku, ukázkový formát: rrrr-MM-ddTHH:mm:ssZ.
description	string minLength: 0 maxLength: 500	Textový popis prostředku
eTag	string	Hodnota ETag pro implementaci optimistické souběžnosti.
harvestProductDetails	HarvestProductDetail[]	Podrobné informace o produktech.
id	string	Jedinečné ID prostředku
modifiedBy	string	Upravil(a) id uživatele nebo tenanta.
modifiedDateTime	string (date-time)	Datum a čas poslední změny prostředku, ukázkový formát: rrrr-MM-ddTHH:mm:ssZ.
name	string minLength: 0 maxLength: 100	Název k identifikaci prostředku
operationEndDateTime	string (date-time)	Koncové datum a čas dat operace, ukázkový formát: rrrr-MM-ddTHH:mm:ssZ.
operationModifiedDateTime	string (date-time)	Změna data a času operace, ukázkový formát: rrrr-MM-ddTHH:mm:ssZ. Poznámka: To bude určeno samotným poskytovatelem zdroje.
operationStartDateTime	string (date-time)	Počáteční datum a čas dat operace, ukázkový formát: rrrr-MM-ddTHH:mm:ssZ.
partyId	string	ID strany, které patří k datům operace.
properties		Kolekce párů klíč-hodnota, které patří k prostředku. Každý pár nesmí mít klíč větší než 50 znaků a nesmí mít hodnotu větší než 150 znaků. Poznámka: Pro prostředek lze zadat maximálně 25 párů klíč-hodnota a jsou podporovány pouze hodnoty string, číslic a datetime (yyyy-MM-ddTHH:mm:ssZ).
source	string minLength: 2 maxLength: 100	Zdroj prostředku
status	string minLength: 0 maxLength: 100	Stav prostředku
totalWetMass	Measure	Schéma pro ukládání měření čtení a jednotky
totalYield	Measure	Schéma pro ukládání měření čtení a jednotky

HarvestDataListResponse

Objekt

Stránkovaná odpověď obsahuje seznam požadovaných objektů a odkaz URL pro získání další sady výsledků.

Name	Typ	Description
nextLink	string	Odkaz na pokračování (absolutní identifikátor URI) na další stránku výsledků v seznamu.
skipToken	string	Token použitý při načítání další stránky. Pokud je hodnota null, nejsou k dispozici žádné další stránky.
value	HarvestData[]	Seznam požadovaných objektů

HarvestProductDetail

Objekt

Schéma výrobku použitého během sběru.

Name	Typ	Description
area	Measure	Schéma pro ukládání měření čtení a jednotky
avgMoisture	Measure	Schéma pro ukládání měření čtení a jednotky
avgWetMass	Measure	Schéma pro ukládání měření čtení a jednotky
avgYield	Measure	Schéma pro ukládání měření čtení a jednotky
productName	string minLength: 1 maxLength: 100	Název produktu
totalWetMass	Measure	Schéma pro ukládání měření čtení a jednotky
totalYield	Measure	Schéma pro ukládání měření čtení a jednotky

InnerError

Objekt

Vnitřní chyba obsahující seznam chyb Viz referenční dokument https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object pro InnerError.

Name	Typ	Description
code	string	Konkrétní kód chyby, než poskytla obsahující chyba.
innererror	InnerError	Vnitřní chyba obsahující seznam chyb Viz referenční dokument https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object pro InnerError.

Measure

Objekt

Schéma pro ukládání měření čtení a jednotky

Name	Typ	Description
unit	string minLength: 1 maxLength: 50	Datová jednotka.
value	number (double)	Datová hodnota.

Sdílet prostřednictvím

Harvest Data - List

Parametry identifikátoru URI

Hlavička požadavku

Odpovědi

Zabezpečení

Authorization

Příklady

HarvestData_List

Ukázkový požadavek

Ukázková odpověď

Definice

Error

ErrorResponse

HarvestData

HarvestDataListResponse

HarvestProductDetail

InnerError

Measure