Delen via


Harvest Data - List

Retourneert een gepagineerde lijst met oogstgegevensbronnen voor alle partijen.

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-parameters

Name In Vereist Type Description
api-version
query True

string

De aangevraagde API-versie

associatedBoundaryIds
query

string[]

Grens-id's die zijn gekoppeld aan bewerkingsgegevens.

ids
query

string[]

Id's van de resource.

maxArea
query

number

double

Maximumgebied waarvoor bewerking is toegepast (inclusief).

maxAvgMoisture
query

number

double

Maximumwaarde AvgMoisture (inclusief).

maxAvgSpeed
query

number

double

Maximale AvgSpeed-waarde (inclusief).

maxAvgWetMass
query

number

double

Maximale avgWetMass-waarde (inclusief).

maxAvgYield
query

number

double

Maximum AvgYield-waarde (inclusief).

maxCreatedDateTime
query

string

date-time

Maximale aanmaakdatum van resource (inclusief).

maxLastModifiedDateTime
query

string

date-time

Maximale datum van laatste wijziging van resource (inclusief).

maxOperationEndDateTime
query

string

date-time

Maximale einddatum/tijd van de bewerkingsgegevens, voorbeeldindeling: jjjj-MM-ddTHH:mm:ssZ (inclusief).

maxOperationModifiedDateTime
query

string

date-time

Maximale gewijzigde datum-tijd van de bewerkingsgegevens, voorbeeldindeling: jjjj-MM-ddTHH:mm:ssZ (inclusief).

maxOperationStartDateTime
query

string

date-time

Maximale begindatum-tijd van de bewerkingsgegevens, voorbeeldindeling: jjjj-MM-ddTHH:mm:ssZ (inclusief).

maxPageSize
query

integer

int32

Maximum aantal benodigde items (inclusief). Minimum = 10, Maximum = 1000, Standaardwaarde = 50.

maxTotalWetMass
query

number

double

Maximumwaarde voor Totale WetMass (inclusief).

maxTotalYield
query

number

double

Maximale opbrengstwaarde (inclusief).

minArea
query

number

double

Minimumgebied waarvoor bewerking is toegepast (inclusief).

minAvgMoisture
query

number

double

Minimumwaarde AvgMoisture (inclusief).

minAvgSpeed
query

number

double

Minimum avgSpeed-waarde (inclusief).

minAvgWetMass
query

number

double

Minimale avgWetMass-waarde (inclusief).

minAvgYield
query

number

double

Minimum AvgYield-waarde (inclusief).

minCreatedDateTime
query

string

date-time

Minimale aanmaakdatum van resource (inclusief).

minLastModifiedDateTime
query

string

date-time

Minimale datum van laatste wijziging van resource (inclusief).

minOperationEndDateTime
query

string

date-time

Minimale einddatum/tijd van de bewerkingsgegevens, voorbeeldindeling: jjjj-MM-ddTHH:mm:ssZ (inclusief).

minOperationModifiedDateTime
query

string

date-time

Minimale gewijzigde datum-tijd van de bewerkingsgegevens, voorbeeldindeling: jjjj-MM-ddTHH:mm:ssZ (inclusief).

minOperationStartDateTime
query

string

date-time

Minimale begindatum-tijd van de bewerkingsgegevens, voorbeeldindeling: jjjj-MM-ddTHH:mm:ssZ (inclusief).

minTotalWetMass
query

number

double

Minimumwaarde voor Total WetMass (inclusief).

minTotalYield
query

number

double

Minimumrendementswaarde (inclusief).

names
query

string[]

Namen van de resource.

propertyFilters
query

string[]

Filters op sleutel-waardeparen binnen het object Eigenschappen. bijvoorbeeld "{testKey} eq {testValue}".

skipToken
query

string

Token overslaan voor het ophalen van de volgende set resultaten.

sources
query

string[]

Bronnen van de bewerkingsgegevens.

statuses
query

string[]

Statussen van de resource.

Aanvraagkoptekst

Name Vereist Type Description
Authorization True

string

Geef een geldig Bearer-token op voor geautoriseerde API-aanroepen. Houd er rekening mee dat u mogelijk uw browsercache moet wissen als u eerder niet-geverifieerde aanroepen hebt geprobeerd.

Antwoorden

Name Type Description
200 OK

HarvestDataListResponse

Geslaagd

Other Status Codes

ErrorResponse

Fout

Kopteksten

x-ms-error-code: string

Beveiliging

Authorization

Geef een geldig Bearer-token op voor geautoriseerde API-aanroepen. Houd er rekening mee dat u mogelijk uw browsercache moet wissen als u eerder niet-geverifieerde aanroepen hebt geprobeerd.

Type: apiKey
In: header

Voorbeelden

HarvestData_List

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
Error

Een fout van de Azure AgPlatform-service.

ErrorResponse

Een foutreactie van de Azure AgPlatform-service. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses voor het referentiedocument ErrorResponse.

HarvestData

Schema van oogstgegevensresource.

HarvestDataListResponse

Paginad-antwoord bevat een lijst met aangevraagde objecten en een URL-koppeling om de volgende set resultaten op te halen.

HarvestProductDetail

Schema van het product dat tijdens de oogst wordt gebruikt.

InnerError

Interne fout met een lijst met fouten. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object voor innerError-referentiedocument.

Measure

Schema voor het opslaan van meetwaarden en -eenheden.

Error

Een fout van de Azure AgPlatform-service.

Name Type Description
code

string

Door de server gedefinieerde set foutcodes.

details

Error[]

Matrix met details over specifieke fouten die tot deze gerapporteerde fout hebben geleid.

innererror

InnerError

Interne fout met een lijst met fouten. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object voor innerError-referentiedocument.

message

string

Door mensen leesbare weergave van de fout.

target

string

Doel van de fout.

ErrorResponse

Een foutreactie van de Azure AgPlatform-service. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses voor het referentiedocument ErrorResponse.

Name Type Description
error

Error

Een fout van de Azure AgPlatform-service.

traceId

string

Unieke tracerings-id.

HarvestData

Schema van oogstgegevensresource.

Name Type Description
area

Measure

Schema voor het opslaan van meetwaarden en -eenheden.

associatedBoundaryId

string

Optionele grens-id van het veld waarop de bewerking is toegepast.

attachmentsLink

string

Koppeling voor bijlagen.

avgMoisture

Measure

Schema voor het opslaan van meetwaarden en -eenheden.

avgSpeed

Measure

Schema voor het opslaan van meetwaarden en -eenheden.

avgWetMass

Measure

Schema voor het opslaan van meetwaarden en -eenheden.

avgYield

Measure

Schema voor het opslaan van meetwaarden en -eenheden.

createdBy

string

Gemaakt door gebruikers-/tenant-id.

createdDateTime

string

Datum-tijd waarop de resource is gemaakt, voorbeeldindeling: jjjj-MM-ddTHH:mm:ssZ.

description

string

Tekstuele beschrijving van de resource.

eTag

string

De ETag-waarde voor het implementeren van optimistische gelijktijdigheid.

harvestProductDetails

HarvestProductDetail[]

Oogst productdetails.

id

string

Unieke resource-id.

modifiedBy

string

Gewijzigd door gebruiker/tenant-id.

modifiedDateTime

string

Datum/tijd waarop de resource voor het laatst is gewijzigd, voorbeeldindeling: jjjj-MM-ddTHH:mm:ssZ.

name

string

Naam om resource te identificeren.

operationEndDateTime

string

Einddatum-tijd van de bewerkingsgegevens, voorbeeldindeling: jjjj-MM-ddTHH:mm:ssZ.

operationModifiedDateTime

string

Gewijzigde datum-tijd van de bewerkingsgegevens, voorbeeldindeling: jjjj-MM-ddTHH:mm:ssZ. Opmerking: dit wordt opgegeven door de bronprovider zelf.

operationStartDateTime

string

Begindatum-tijd van de bewerkingsgegevens, voorbeeldindeling: jjjj-MM-ddTHH:mm:ssZ.

partyId

string

Partij-id die deel uitmaakt van de bewerkingsgegevens.

properties

Een verzameling sleutelwaardeparen die deel uitmaakt van de resource. Elk paar mag geen sleutel hebben die groter is dan 50 tekens en mag geen waarde van meer dan 150 tekens hebben. Opmerking: er kunnen maximaal 25 sleutelwaardeparen worden opgegeven voor een resource en alleen tekenreeks-, numerieke en datum/tijd-waarden (jjjj-MM-ddTHH:mm:ssZ) worden ondersteund.

source

string

Bron van de resource.

status

string

Status van de resource.

totalWetMass

Measure

Schema voor het opslaan van meetwaarden en -eenheden.

totalYield

Measure

Schema voor het opslaan van meetwaarden en -eenheden.

HarvestDataListResponse

Paginad-antwoord bevat een lijst met aangevraagde objecten en een URL-koppeling om de volgende set resultaten op te halen.

Name Type Description
nextLink

string

Vervolgkoppeling (absolute URI) naar de volgende pagina met resultaten in de lijst.

skipToken

string

Token dat wordt gebruikt bij het ophalen van de volgende pagina. Indien null, zijn er geen extra pagina's.

value

HarvestData[]

Lijst met aangevraagde objecten.

HarvestProductDetail

Schema van het product dat tijdens de oogst wordt gebruikt.

Name Type Description
area

Measure

Schema voor het opslaan van meetwaarden en -eenheden.

avgMoisture

Measure

Schema voor het opslaan van meetwaarden en -eenheden.

avgWetMass

Measure

Schema voor het opslaan van meetwaarden en -eenheden.

avgYield

Measure

Schema voor het opslaan van meetwaarden en -eenheden.

productName

string

De naam van het product.

totalWetMass

Measure

Schema voor het opslaan van meetwaarden en -eenheden.

totalYield

Measure

Schema voor het opslaan van meetwaarden en -eenheden.

InnerError

Interne fout met een lijst met fouten. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object voor innerError-referentiedocument.

Name Type Description
code

string

Specifieke foutcode dan is opgegeven door de betreffende fout.

innererror

InnerError

Interne fout met een lijst met fouten. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object voor innerError-referentiedocument.

Measure

Schema voor het opslaan van meetwaarden en -eenheden.

Name Type Description
unit

string

Gegevenseenheid.

value

number

Gegevenswaarde.