Dela via


Harvest Data - List

Returnerar en sidnumrerad lista över skördedataresurser för alla parter.

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

URI-parametrar

Name I Obligatorisk Typ Description
api-version
query True

string

Den begärda API-versionen

associatedBoundaryIds
query

string[]

Gräns-ID:t som är associerade med åtgärdsdata.

ids
query

string[]

ID:t för resursen.

maxArea
query

number

double

Maximalt område för vilket åtgärden tillämpades (inklusive).

maxAvgMoisture
query

number

double

Maximalt värde för genomsnittlig fukt (inklusivt).

maxAvgSpeed
query

number

double

Maximalt värde för AvgSpeed (inklusive).

maxAvgWetMass
query

number

double

Maximalt värde för AvgWetMass (inklusive).

maxAvgYield
query

number

double

Maximalt värde för AvgYield (inklusive).

maxCreatedDateTime
query

string

date-time

Maximalt skapandedatum för resursen (inklusive).

maxLastModifiedDateTime
query

string

date-time

Maximalt senast ändrat datum för resursen (inklusive).

maxOperationEndDateTime
query

string

date-time

Maximal slutdatumtid för åtgärdsdata, exempelformat: åå-MM-ddTHH:mm:ssZ (inklusive).

maxOperationModifiedDateTime
query

string

date-time

Maximal ändrad datum-tid för åtgärdsdata, exempelformat: åååå-MM-ddTHH:mm:ssZ (inklusive).

maxOperationStartDateTime
query

string

date-time

Maximal startdatumtid för åtgärdsdata, exempelformat: åå-MM-ddTHH:mm:ssZ (inklusive).

maxPageSize
query

integer

int32

Maximalt antal objekt som behövs (inklusive). Minimum = 10, Maximum = 1000, Standardvärde = 50.

maxTotalWetMass
query

number

double

Maximalt totalt WetMass-värde (inklusivt).

maxTotalYield
query

number

double

Maximum Yield value (inklusivt).

minArea
query

number

double

Minsta område för vilket åtgärden tillämpades (inklusive).

minAvgMoisture
query

number

double

Minsta avgMoisture-värde (inklusivt).

minAvgSpeed
query

number

double

Minimum AvgSpeed value(inclusive).

minAvgWetMass
query

number

double

Minimum AvgWetMass value(inclusive).

minAvgYield
query

number

double

Minimum AvgYield value(inclusive).

minCreatedDateTime
query

string

date-time

Minsta skapandedatum för resursen (inklusive).

minLastModifiedDateTime
query

string

date-time

Minsta senaste ändringsdatum för resursen (inklusive).

minOperationEndDateTime
query

string

date-time

Minsta slutdatum för åtgärdsdata, exempelformat: åå-MM-ddTHH:mm:ssZ (inklusivt).

minOperationModifiedDateTime
query

string

date-time

Minsta ändrade datum/tid för åtgärdsdata, exempelformat: åååå-MM-ddTHH:mm:ssZ (inklusive).

minOperationStartDateTime
query

string

date-time

Minsta startdatumtid för åtgärdsdata, exempelformat: åå-MM-ddTHH:mm:ssZ (inklusive).

minTotalWetMass
query

number

double

Minimum Total WetMass value(inclusive).

minTotalYield
query

number

double

Minsta avkastningsvärde (inklusive).

names
query

string[]

Namn på resursen.

propertyFilters
query

string[]

Filtrerar på nyckel/värde-par i objektet Egenskaper. t.ex. "{testKey} eq {testValue}".

skipToken
query

string

Hoppa över token för att hämta nästa uppsättning resultat.

sources
query

string[]

Källor till åtgärdsdata.

statuses
query

string[]

Status för resursen.

Begärandehuvud

Name Obligatorisk Typ Description
Authorization True

string

Ange en giltig ägartoken för auktoriserade API-anrop. Observera att du kan behöva rensa webbläsarens cacheminne om du har provat oautentiserade anrop tidigare.

Svar

Name Typ Description
200 OK

HarvestDataListResponse

Klart

Other Status Codes

ErrorResponse

Fel

Sidhuvuden

x-ms-error-code: string

Säkerhet

Authorization

Ange en giltig ägartoken för auktoriserade API-anrop. Observera att du kan behöva rensa webbläsarens cacheminne om du har provat oautentiserade anrop tidigare.

Typ: apiKey
I: header

Exempel

HarvestData_List

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
Error

Ett fel från Azure AgPlatform-tjänsten.

ErrorResponse

Ett felsvar från Azure AgPlatform-tjänsten. Se https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses för ErrorResponse-referensdokument.

HarvestData

Schema för skördedataresurs.

HarvestDataListResponse

Det sidvända svaret innehåller en lista över begärda objekt och en URL-länk för att hämta nästa uppsättning resultat.

HarvestProductDetail

Schema för produkten som används under skörden.

InnerError

Inre fel som innehåller listan över fel. Mer information https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object finns i referensdokumentet för InnerError.

Measure

Schema för lagring av mätningsavläsning och -enhet.

Error

Ett fel från Azure AgPlatform-tjänsten.

Name Typ Description
code

string

Serverdefinierad uppsättning felkoder.

details

Error[]

Matris med information om specifika fel som ledde till det rapporterade felet.

innererror

InnerError

Inre fel som innehåller listan över fel. Mer information https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object finns i referensdokumentet för InnerError.

message

string

Mänsklig läsbar representation av felet.

target

string

Målet för felet.

ErrorResponse

Ett felsvar från Azure AgPlatform-tjänsten. Se https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses för ErrorResponse-referensdokument.

Name Typ Description
error

Error

Ett fel från Azure AgPlatform-tjänsten.

traceId

string

Unikt spårnings-ID.

HarvestData

Schema för skördedataresurs.

Name Typ Description
area

Measure

Schema för lagring av mätningsavläsning och -enhet.

associatedBoundaryId

string

Valfritt gräns-ID för det fält som åtgärden tillämpades för.

attachmentsLink

string

Länk för bifogade filer.

avgMoisture

Measure

Schema för lagring av mätningsavläsning och -enhet.

avgSpeed

Measure

Schema för lagring av mätningsavläsning och -enhet.

avgWetMass

Measure

Schema för lagring av mätningsavläsning och -enhet.

avgYield

Measure

Schema för lagring av mätningsavläsning och -enhet.

createdBy

string

Skapat av användar-/klientorganisations-ID.

createdDateTime

string

Datum-tid när resursen skapades, exempelformat: åååå-MM-ddTHH:mm:ssZ.

description

string

Textbeskrivning av resursen.

eTag

string

ETag-värdet för att implementera optimistisk samtidighet.

harvestProductDetails

HarvestProductDetail[]

Information om skördeprodukter.

id

string

Unikt resurs-ID.

modifiedBy

string

Ändrat av användar-/klientorganisations-ID.

modifiedDateTime

string

Datum-tid när resursen senast ändrades, exempelformat: åååå-MM-ddTHH:mm:ssZ.

name

string

Namn för att identifiera resursen.

operationEndDateTime

string

Slutdatum för åtgärdsdata, exempelformat: åå-MM-ddTHH:mm:ssZ.

operationModifiedDateTime

string

Ändrad datum/tid för åtgärdsdata, exempelformat: åååå-MM-ddTHH:mm:ssZ. Obs! Detta anges av själva källprovidern.

operationStartDateTime

string

Startdatum för åtgärdsdata, exempelformat: åå-MM-ddTHH:mm:ssZ.

partyId

string

Part-ID som tillhör åtgärdsdata.

properties

En samling nyckel/värde-par som tillhör resursen. Varje par får inte ha en nyckel som är större än 50 tecken och får inte ha ett värde som är större än 150 tecken. Obs! Högst 25 nyckel/värde-par kan anges för en resurs och endast värden för sträng, siffror och datetime (åå-MM-ddTHH:mm:ssZ) stöds.

source

string

Resursens källa.

status

string

Status för resursen.

totalWetMass

Measure

Schema för lagring av mätningsavläsning och -enhet.

totalYield

Measure

Schema för lagring av mätningsavläsning och -enhet.

HarvestDataListResponse

Det sidvända svaret innehåller en lista över begärda objekt och en URL-länk för att hämta nästa uppsättning resultat.

Name Typ Description
nextLink

string

Fortsättningslänk (absolut URI) till nästa sida med resultat i listan.

skipToken

string

Token som används för att hämta nästa sida. Om värdet är null finns det inga ytterligare sidor.

value

HarvestData[]

Lista över begärda objekt.

HarvestProductDetail

Schema för produkten som används under skörden.

Name Typ Description
area

Measure

Schema för lagring av mätningsavläsning och -enhet.

avgMoisture

Measure

Schema för lagring av mätningsavläsning och -enhet.

avgWetMass

Measure

Schema för lagring av mätningsavläsning och -enhet.

avgYield

Measure

Schema för lagring av mätningsavläsning och -enhet.

productName

string

Namn på produkten.

totalWetMass

Measure

Schema för lagring av mätningsavläsning och -enhet.

totalYield

Measure

Schema för lagring av mätningsavläsning och -enhet.

InnerError

Inre fel som innehåller listan över fel. Mer information https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object finns i referensdokumentet för InnerError.

Name Typ Description
code

string

Specifik felkod än vad som angavs av det innehållande felet.

innererror

InnerError

Inre fel som innehåller listan över fel. Mer information https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object finns i referensdokumentet för InnerError.

Measure

Schema för lagring av mätningsavläsning och -enhet.

Name Typ Description
unit

string

Dataenhet.

value

number

Datavärde.