Harvest Data - List By Party Id

  • Referenz
Service:
Azure Data Manager for Agriculture
API Version:
2022-11-01-preview

Gibt eine paginierte Liste der Erntedatenressourcen in einer bestimmten Farm zurück.

GET /parties/{partyId}/harvest-data?api-version=2022-11-01-preview
With optional parameters: 
GET /parties/{partyId}/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=2022-11-01-preview

URI-Parameter

Name In Erforderlich Typ Beschreibung
partyId
 path True

string

ID der zugeordneten Partei.
api-version
 query True

string

Die angeforderte API-Version
associatedBoundaryIds
 query

string[]

Begrenzungs-IDs, die Vorgangsdaten zugeordnet sind.
ids
 query

string[]

Ids der Ressource.
maxArea
 query

number

double

Maximale Fläche, für die der Vorgang angewendet wurde (inklusive).
maxAvgMoisture
 query

number

double

Maximaler AvgMoisture-Wert (inklusive).
maxAvgSpeed
 query

number

double

Maximaler AvgSpeed-Wert (inklusive).
maxAvgWetMass
 query

number

double

Maximaler AvgWetMass-Wert (inklusive).
maxAvgYield
 query

number

double

Maximaler AvgYield-Wert (inklusive).
maxCreatedDateTime
 query

string

date-time

Maximales Erstellungsdatum der Ressource (inklusive).
maxLastModifiedDateTime
 query

string

date-time

Maximales Datum der letzten Änderung der Ressource (einschließlich).
maxOperationEndDateTime
 query

string

date-time

Maximale Endzeit der Vorgangsdaten, Beispielformat: yyyy-MM-ttTHH:mm:ssZ (inklusive).
maxOperationModifiedDateTime
 query

string

date-time

Maximal geänderte Datum/Uhrzeit der Vorgangsdaten, Beispielformat: yyyy-MM-ddTHH:mm:ssZ (inklusive).
maxOperationStartDateTime
 query

string

date-time

Maximale Startzeit der Vorgangsdaten, Beispielformat: yyyy-MM-ddTHH:mm:ssZ (inklusive).
maxPageSize
 query

integer

int32

Maximale Anzahl erforderlicher Elemente (inklusive). Minimum = 10, Maximum = 1000, Standardwert = 50.
maxTotalWetMass
 query

number

double

Maximaler Total WetMass-Wert (inklusive).
maxTotalYield
 query

number

double

Maximaler Ertragswert (inklusive).
minArea
 query

number

double

Mindestbereich, für den der Vorgang angewendet wurde (einschließlich).
minAvgMoisture
 query

number

double

Minimum AvgMoisture value(inclusive).
minAvgSpeed
 query

number

double

Minimaler AvgSpeed-Wert(inklusive).
minAvgWetMass
 query

number

double

Minimum AvgWetMass value(inclusive).
minAvgYield
 query

number

double

Minimum AvgYield value(inclusive).
minCreatedDateTime
 query

string

date-time

Minimales Erstellungsdatum der Ressource (inklusive).
minLastModifiedDateTime
 query

string

date-time

Mindestdatum der letzten Änderung der Ressource (einschließlich).
minOperationEndDateTime
 query

string

date-time

Minimale Endzeit der Vorgangsdaten, Beispielformat: yyyy-MM-ddTHH:mm:ssZ (inklusive).
minOperationModifiedDateTime
 query

string

date-time

Mindeständerungsdatum/Uhrzeit der Vorgangsdaten, Beispielformat: yyyy-MM-ddTHH:mm:ssZ (inklusive).
minOperationStartDateTime
 query

string

date-time

Mindeststartdatum und -uhrzeit der Vorgangsdaten, Beispielformat: yyyy-MM-ddTHH:mm:ssZ (inklusive).
minTotalWetMass
 query

number

double

Minimum Total WetMass value(inclusive).
minTotalYield
 query

number

double

Minimaler Ertragswert (inklusive).
names
 query

string[]

Namen der Ressource.
propertyFilters
 query

string[]

Filtert nach Schlüssel-Wert-Paaren innerhalb des Properties-Objekts. Beispiel: "{testKey} eq {testValue}".
skipToken
 query

string

Überspringen Sie das Token, um den nächsten Satz von Ergebnissen zu erhalten.
sources
 query

string[]

Quellen der Vorgangsdaten.
statuses
 query

string[]

Status der Ressource.

Anforderungsheader

Name Erforderlich Typ Beschreibung
Authorization True

string

Geben Sie ein gültiges Bearertoken für autorisierte API-Aufrufe an. Beachten Sie, dass Sie ihren Browsercache möglicherweise löschen müssen, wenn Sie zuvor nicht authentifizierte Aufrufe ausprobiert haben.

Antworten

Name Typ Beschreibung
200 OK

HarvestDataListResponse

Erfolg
Other Status Codes

ErrorResponse

Fehler

Headers

x-ms-error-code: string

Sicherheit

Authorization

Geben Sie ein gültiges Bearertoken für autorisierte API-Aufrufe an. Beachten Sie, dass Sie ihren Browsercache möglicherweise löschen müssen, wenn Sie zuvor nicht authentifizierte Aufrufe ausprobiert haben.

Type: apiKey
In: header

Beispiele

HarvestData_ListByPartyId

Sample Request

GET /parties/PARTY123/harvest-data?api-version=2022-11-01-preview

Sample Response

Status code:
200 
{
  "value": [
    {
      "partyId": "PARTY123",
      "id": "HARVESTOP123",
      "source": "Manual",
      "name": "Harvest data for North Farm",
      "description": "some description",
      "status": "Active",
      "operationStartDateTime": "2021-02-25T16:57:04Z",
      "operationEndDateTime": "2021-02-27T10:13:06Z",
      "operationModifiedDateTime": "2021-02-28T10:12:12Z",
      "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/parties/{{partyId}}/attachments?api-version={{apiVersion}}&resourceIds={{harvestDataId}}&resourceTypes=HarvestData",
      "createdDateTime": "2022-05-11T07:00:10.2750191Z",
      "modifiedDateTime": "2022-05-11T07:00:10.2750191Z",
      "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"
}

Definitionen

Name Beschreibung
Error

Ein Fehler vom Azure AgPlatform-Dienst.
ErrorResponse

Eine Fehlerantwort des Azure AgPlatform-Diensts. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses unter Referenzdokument zu ErrorResponse.
HarvestData

Schema der Erntedatenressource.
HarvestDataListResponse

Die ausgelagerte Antwort enthält eine Liste der angeforderten Objekte und einen URL-Link, um den nächsten Satz von Ergebnissen zu erhalten.
HarvestProductDetail

Schema des Produkts, das während der Ernte verwendet wird.
InnerError

Innerer Fehler, der eine Fehlerliste enthält. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object unter Referenzdokument zu InnerError.
Measure

Schema zum Speichern des Messwerts und der Einheit.

Error

Ein Fehler vom Azure AgPlatform-Dienst.

Name Typ Beschreibung
code

string

Serverdefinierter Satz von Fehlercodes.
details

Error[]

Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror

InnerError

Innerer Fehler, der eine Fehlerliste enthält. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object unter Referenzdokument zu InnerError.
message

string

Lesbare Darstellung des Fehlers.
target

string

Ziel des Fehlers.

ErrorResponse

Eine Fehlerantwort des Azure AgPlatform-Diensts. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses unter Referenzdokument zu ErrorResponse.

Name Typ Beschreibung
error

Error

Ein Fehler vom Azure AgPlatform-Dienst.
traceId

string

Eindeutige Ablaufverfolgungs-ID.

HarvestData

Schema der Erntedatenressource.

Name Typ Beschreibung
area

Measure

Schema zum Speichern des Messwerts und der Einheit.
associatedBoundaryId

string

Optionale Begrenzungs-ID des Felds, für das der Vorgang angewendet wurde.
attachmentsLink

string

Link für Anlagen.
avgMoisture

Measure

Schema zum Speichern des Messwerts und der Einheit.
avgSpeed

Measure

Schema zum Speichern des Messwerts und der Einheit.
avgWetMass

Measure

Schema zum Speichern des Messwerts und der Einheit.
avgYield

Measure

Schema zum Speichern des Messwerts und der Einheit.
createdBy

string

Erstellt von Benutzer-/Mandanten-ID.
createdDateTime

string

Datum und Uhrzeit der Erstellung der Ressource, Beispielformat: jjjj-MM-ttTHH:mm:ssZ.
description

string

Textbeschreibung der Ressource.
eTag

string

Der ETag-Wert, um optimistische Parallelität zu implementieren.
harvestProductDetails

HarvestProductDetail[]

Ernteproduktdetails.
id

string

Eindeutige Ressourcen-ID.
modifiedBy

string

Geändert durch Benutzer-/Mandanten-ID.
modifiedDateTime

string

Datum und Uhrzeit der letzten Änderung der Ressource, Beispielformat: jjjj-MM-ttTHH:mm:ssZ.
name

string

Der Name zur Identifizierung der Ressource.
operationEndDateTime

string

Enddatum/Uhrzeit der Vorgangsdaten, Beispielformat: yyyy-MM-ttTHH:mm:ssZ.
operationModifiedDateTime

string

Datum/Uhrzeit der Vorgangsdaten geändert, Beispielformat: yyyy-MM-ddTHH:mm:ssZ. Hinweis: Dies wird vom Quellanbieter selbst angegeben.
operationStartDateTime

string

Startdatum-Uhrzeit der Vorgangsdaten, Beispielformat: yyyy-MM-ddTHH:mm:ssZ.
partyId

string

Partei-ID, die zu den Vorgangsdaten gehört.
properties

Eine Auflistung von Schlüsselwertpaaren, die zur Ressource gehören. Jedes Paar darf keinen Schlüssel haben, der größer als 50 Zeichen ist, und darf keinen Wert größer als 150 Zeichen haben. Hinweis: Für eine Ressource können maximal 25 Schlüsselwertpaare bereitgestellt werden, und es werden nur Zeichenfolgen-, Numeral- und datetime-Werte (yyyy-MM-ddTHH:mm:ssZ) unterstützt.
source

string

Quelle der Ressource.
status

string

Status der Ressource.
totalWetMass

Measure

Schema zum Speichern des Messwerts und der Einheit.
totalYield

Measure

Schema zum Speichern des Messwerts und der Einheit.

HarvestDataListResponse

Die ausgelagerte Antwort enthält eine Liste der angeforderten Objekte und einen URL-Link, um den nächsten Satz von Ergebnissen zu erhalten.

Name Typ Beschreibung
nextLink

string

Fortsetzungslink (absoluter URI) auf die nächste Seite mit Ergebnissen in der Liste
skipToken

string

Token, das beim Abrufen der nächsten Seite verwendet wird. Wenn NULL, gibt es keine zusätzlichen Seiten.
value

HarvestData[]

Liste der angeforderten Objekte.

HarvestProductDetail

Schema des Produkts, das während der Ernte verwendet wird.

Name Typ Beschreibung
area

Measure

Schema zum Speichern des Messwerts und der Einheit.
avgMoisture

Measure

Schema zum Speichern des Messwerts und der Einheit.
avgWetMass

Measure

Schema zum Speichern des Messwerts und der Einheit.
avgYield

Measure

Schema zum Speichern des Messwerts und der Einheit.
productName

string

Der Name des Produkts.
totalWetMass

Measure

Schema zum Speichern des Messwerts und der Einheit.
totalYield

Measure

Schema zum Speichern des Messwerts und der Einheit.

InnerError

Innerer Fehler, der eine Fehlerliste enthält. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object unter Referenzdokument zu InnerError.

Name Typ Beschreibung
code

string

Spezifischer Fehlercode, der vom enthaltenden Fehler bereitgestellt wurde.
innererror

InnerError

Innerer Fehler, der eine Fehlerliste enthält. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object unter Referenzdokument zu InnerError.

Measure

Schema zum Speichern des Messwerts und der Einheit.

Name Typ Beschreibung
unit

string

Dateneinheit.
value

number

Datenwert.