Sdílet prostřednictvím


Harvest Data - List

Vrátí stránkovaný seznam prostředků dat pro sběr dat napříč všemi stranami.

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

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 byla operace použita (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í koncové datum a čas dat operace, ukázkový formát: yyyy-MM-ddTHH:mm:ssZ (včetně).

maxOperationModifiedDateTime
query

string

date-time

Maximální změněné datum a čas dat operace, vzorový formát: yyyy-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: yyyy-MM-ddTHH:mm:ssZ (včetně).

maxPageSize
query

integer

int32

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 se operace použila (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í koncové datum a čas dat operace, ukázkový formát: rrrr-MM-ddTHH:mm:ssZ (včetně).

minOperationModifiedDateTime
query

string

date-time

Minimální změněné datum a čas dat operace, ukázkový formát: yyyy-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 objektu Properties. např. {testKey} eq {testValue}.

skipToken
query

string

Pokud chcete získat další sadu výsledků, přeskočte token.

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. Upozorňujeme, že pokud jste se předtím pokusili o neověřené volání, možná budete muset vymazat mezipaměť prohlížeče.

Odpovědi

Name Typ Description
200 OK

HarvestDataListResponse

Success

Other Status Codes

ErrorResponse

Chybová

Hlavičky

x-ms-error-code: string

Zabezpečení

Authorization

Zadejte platný nosný token pro autorizovaná volání rozhraní API. Upozorňujeme, že pokud jste se předtím pokusili o neověřené volání, možná budete muset vymazat mezipaměť prohlížeče.

Typ: apiKey
V: header

Příklady

HarvestData_List

Ukázkový požadavek

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

Ukázková odpověď

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

Chybová odpověď ze služby Azure AgPlatform. Viz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses referenční dokument ErrorResponse.

HarvestData

Schéma datového prostředku pro sběr 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 produktu použitého při sklizni.

InnerError

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

Measure

Schéma pro ukládání naměřených hodnot a jednotek.

Error

Chyba ze služby Azure AgPlatform.

Name Typ Description
code

string

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 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object referenční dokument InnerError.

message

string

Znázornění chyby čitelné pro člověka

target

string

Cíl chyby.

ErrorResponse

Chybová odpověď ze služby Azure AgPlatform. Viz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses referenční dokument ErrorResponse.

Name Typ Description
error

Error

Chyba ze služby Azure AgPlatform.

traceId

string

Jedinečné ID trasování.

HarvestData

Schéma datového prostředku pro sběr dat

Name Typ Description
area

Measure

Schéma pro ukládání naměřených hodnot a jednotek.

associatedBoundaryId

string

Volitelné ID hranice pole, pro které byla operace použita.

attachmentsLink

string

Odkaz na přílohy.

avgMoisture

Measure

Schéma pro ukládání naměřených hodnot a jednotek.

avgSpeed

Measure

Schéma pro ukládání naměřených hodnot a jednotek.

avgWetMass

Measure

Schéma pro ukládání naměřených hodnot a jednotek.

avgYield

Measure

Schéma pro ukládání naměřených hodnot a jednotek.

createdBy

string

Vytvořeno podle ID uživatele nebo tenanta.

createdDateTime

string

Datum a čas vytvoření prostředku, ukázkový formát: yyyy-MM-ddTHH:mm:ssZ.

description

string

Textový popis prostředku.

eTag

string

Hodnota ETag pro implementaci optimistické souběžnosti

harvestProductDetails

HarvestProductDetail[]

Podrobnosti o produktech pro sklizeň.

id

string

Jedinečné ID prostředku.

modifiedBy

string

Upraveno podle ID uživatele nebo tenanta.

modifiedDateTime

string

Datum a čas poslední změny prostředku, ukázkový formát: yyyy-MM-ddTHH:mm:ssZ.

name

string

Název pro identifikaci prostředku

operationEndDateTime

string

Koncové datum a čas dat operace, ukázkový formát: yyyy-MM-ddTHH:mm:ssZ.

operationModifiedDateTime

string

Změněné datum a čas dat operace, ukázkový formát: yyyy-MM-ddTHH:mm:ssZ. Poznámka: To bude určeno samotným poskytovatelem zdroje.

operationStartDateTime

string

Počáteční datum a čas dat operace, ukázkový formát: yyyy-MM-ddTHH:mm:ssZ.

partyId

string

ID strany, které patří k datům operace.

properties

Kolekce párů hodnot klíčů, které patří do 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 je možné zadat maximálně 25 párů hodnot klíčů a podporují se pouze hodnoty string, numeral a datetime (yyyy-MM-ddTHH:mm:ssZ).

source

string

Zdroj prostředku.

status

string

Stav prostředku.

totalWetMass

Measure

Schéma pro ukládání naměřených hodnot a jednotek.

totalYield

Measure

Schéma pro ukládání naměřených hodnot a jednotek.

HarvestDataListResponse

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

Schéma produktu použitého při sklizni.

Name Typ Description
area

Measure

Schéma pro ukládání naměřených hodnot a jednotek.

avgMoisture

Measure

Schéma pro ukládání naměřených hodnot a jednotek.

avgWetMass

Measure

Schéma pro ukládání naměřených hodnot a jednotek.

avgYield

Measure

Schéma pro ukládání naměřených hodnot a jednotek.

productName

string

Název produktu

totalWetMass

Measure

Schéma pro ukládání naměřených hodnot a jednotek.

totalYield

Measure

Schéma pro ukládání naměřených hodnot a jednotek.

InnerError

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

Name Typ Description
code

string

Konkrétní kód chyby, než byl poskytnut chybou obsahující chybu.

innererror

InnerError

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

Measure

Schéma pro ukládání naměřených hodnot a jednotek.

Name Typ Description
unit

string

Datová jednotka.

value

number

Datová hodnota.