Partager via


Harvest Data - List

Retourne une liste paginée des ressources de données de récolte entre toutes les parties.

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

Paramètres URI

Nom Dans Obligatoire Type Description
api-version
query True

string

Version de l’API demandée

associatedBoundaryIds
query

string[]

ID de limite associés aux données d’opération.

ids
query

string[]

ID de la ressource.

maxArea
query

number

double

Zone maximale pour laquelle l’opération a été appliquée (inclusive).

maxAvgMoisture
query

number

double

Valeur AvgMoisture maximale (inclusive).

maxAvgSpeed
query

number

double

Valeur AvgSpeed maximale (inclusive).

maxAvgWetMass
query

number

double

Valeur AvgWetMass maximale (inclusive).

maxAvgYield
query

number

double

Valeur AvgYield maximale (inclusive).

maxCreatedDateTime
query

string

date-time

Date de création maximale de la ressource (inclusive).

maxLastModifiedDateTime
query

string

date-time

Date maximale de dernière modification de la ressource (inclusive).

maxOperationEndDateTime
query

string

date-time

Date-heure de fin maximale des données d’opération, exemple de format : aaaa-MM-jjTHH :mm :ssZ (inclus).

maxOperationModifiedDateTime
query

string

date-time

Date-heure maximale de modification des données d’opération, exemple de format : aaaa-MM-ddTHH :mm :ssZ (inclus).

maxOperationStartDateTime
query

string

date-time

Date-heure de début maximale des données d’opération, exemple de format : aaaa-MM-jjTHH :mm :ssZ (inclus).

maxPageSize
query

integer

int32

Nombre maximal d’éléments nécessaires (inclus). Minimum = 10, Maximum = 1000, Valeur par défaut = 50.

maxTotalWetMass
query

number

double

Valeur wetMass totale maximale (inclusive).

maxTotalYield
query

number

double

Valeur de rendement maximale (inclusive).

minArea
query

number

double

Zone minimale pour laquelle l’opération a été appliquée (inclusive).

minAvgMoisture
query

number

double

Valeur AvgMoisture minimale (inclusive).

minAvgSpeed
query

number

double

Valeur AvgSpeed minimale (inclusive).

minAvgWetMass
query

number

double

Valeur AvgWetMass minimale (inclusive).

minAvgYield
query

number

double

Valeur AvgYield minimale (inclusive).

minCreatedDateTime
query

string

date-time

Date de création minimale de la ressource (inclusive).

minLastModifiedDateTime
query

string

date-time

Date minimale de dernière modification de la ressource (inclusive).

minOperationEndDateTime
query

string

date-time

Date-heure de fin minimale des données d’opération, exemple de format : aaaa-MM-jjTHH :mm :ssZ (inclus).

minOperationModifiedDateTime
query

string

date-time

Date-heure minimale de modification des données d’opération, exemple de format : aaaa-MM-jjTHH :mm :ssZ (inclus).

minOperationStartDateTime
query

string

date-time

Date-heure de début minimale des données d’opération, exemple de format : aaaa-MM-jjTHH :mm :ssZ (inclus).

minTotalWetMass
query

number

double

Valeur wetMass totale minimale (inclus).

minTotalYield
query

number

double

Valeur de rendement minimale (inclusive).

names
query

string[]

Noms de la ressource.

propertyFilters
query

string[]

Filtres sur les paires clé-valeur dans l’objet Properties. par exemple « {testKey} eq {testValue} ».

skipToken
query

string

Ignorer le jeton pour obtenir le jeu de résultats suivant.

sources
query

string[]

Sources des données d’opération.

statuses
query

string[]

États de la ressource.

En-tête de la demande

Nom Obligatoire Type Description
Authorization True

string

Fournissez un jeton de porteur valide pour les appels d’API autorisés. Notez que vous devrez peut-être effacer le cache de votre navigateur si vous avez déjà essayé des appels non authentifiés.

Réponses

Nom Type Description
200 OK

HarvestDataListResponse

Succès

Other Status Codes

ErrorResponse

Error

En-têtes

x-ms-error-code: string

Sécurité

Authorization

Fournissez un jeton de porteur valide pour les appels d’API autorisés. Notez que vous devrez peut-être effacer le cache de votre navigateur si vous avez déjà essayé des appels non authentifiés.

Type: apiKey
Dans: header

Exemples

HarvestData_List

Exemple de requête

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

Exemple de réponse

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

Définitions

Nom Description
Error

Erreur du service Azure AgPlatform.

ErrorResponse

Réponse d’erreur du service Azure AgPlatform. Consultez https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses le document de référence ErrorResponse.

HarvestData

Schéma de la ressource de données de récolte.

HarvestDataListResponse

La réponse paginée contient la liste des objets demandés et un lien URL pour obtenir l’ensemble de résultats suivant.

HarvestProductDetail

Schéma du produit utilisé lors de la récolte.

InnerError

Erreur interne contenant la liste des erreurs. Consultez https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object le document de référence InnerError.

Measure

Schéma pour le stockage de la lecture et de l’unité de mesure.

Error

Erreur du service Azure AgPlatform.

Nom Type Description
code

string

Ensemble de codes d’erreur définis par le serveur.

details

Error[]

Tableau de détails sur les erreurs spécifiques qui ont conduit à cette erreur signalée.

innererror

InnerError

Erreur interne contenant la liste des erreurs. Consultez https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object le document de référence InnerError.

message

string

Représentation contrôlable de visu de l’erreur.

target

string

Cible de l’erreur.

ErrorResponse

Réponse d’erreur du service Azure AgPlatform. Consultez https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses le document de référence ErrorResponse.

Nom Type Description
error

Error

Erreur du service Azure AgPlatform.

traceId

string

ID de trace unique.

HarvestData

Schéma de la ressource de données de récolte.

Nom Type Description
area

Measure

Schéma pour le stockage de la lecture et de l’unité de mesure.

associatedBoundaryId

string

ID de limite facultatif du champ pour lequel l’opération a été appliquée.

attachmentsLink

string

Lien pour les pièces jointes.

avgMoisture

Measure

Schéma pour le stockage de la lecture et de l’unité de mesure.

avgSpeed

Measure

Schéma pour le stockage de la lecture et de l’unité de mesure.

avgWetMass

Measure

Schéma pour le stockage de la lecture et de l’unité de mesure.

avgYield

Measure

Schéma pour le stockage de la lecture et de l’unité de mesure.

createdBy

string

Créé par l’ID utilisateur/locataire.

createdDateTime

string

Date/Heure de création de la ressource, exemple de format : aaaa-MM-jjTHH:mm:ssZ.

description

string

Description textuelle de la ressource.

eTag

string

Valeur ETag pour implémenter l’accès concurrentiel optimiste.

harvestProductDetails

HarvestProductDetail[]

Détails du produit de récolte.

id

string

ID de ressource unique.

modifiedBy

string

Modifié par l’ID utilisateur/locataire.

modifiedDateTime

string

Date/Heure de la dernière modification de la ressource, exemple de format : aaaa-MM-jjTHH:mm:ssZ.

name

string

Nom destiné à identifier la ressource.

operationEndDateTime

string

Date-heure de fin des données d’opération, exemple de format : aaaa-MM-ddTHH :mm :ssZ.

operationModifiedDateTime

string

Date et heure modifiées des données d’opération, exemple de format : aaaa-MM-jjTHH :mm :ssZ. Remarque : ce paramètre sera spécifié par le fournisseur source lui-même.

operationStartDateTime

string

Date-heure de début des données d’opération, exemple de format : aaaa-MM-jjTHH :mm :ssZ.

partyId

string

ID de partie qui appartient aux données d’opération.

properties

Collection de paires clé-valeur qui appartient à la ressource. Chaque paire ne doit pas avoir une clé supérieure à 50 caractères et ne doit pas avoir une valeur supérieure à 150 caractères. Remarque : Un maximum de 25 paires de valeur de clé peut être fourni pour une ressource et seules les valeurs string, numeral et datetime (aaaa-MM-ddTHH :mm :ssZ) sont prises en charge.

source

string

Source de la ressource.

status

string

État de la ressource.

totalWetMass

Measure

Schéma pour le stockage de la lecture et de l’unité de mesure.

totalYield

Measure

Schéma pour le stockage de la lecture et de l’unité de mesure.

HarvestDataListResponse

La réponse paginée contient la liste des objets demandés et un lien URL pour obtenir l’ensemble de résultats suivant.

Nom Type Description
nextLink

string

Lien de continuation (URI absolu) vers la page suivante de résultats de la liste.

skipToken

string

Jeton utilisé pour récupérer la page suivante. Si la valeur est null, il n’y a pas de pages supplémentaires.

value

HarvestData[]

Liste des objets demandés.

HarvestProductDetail

Schéma du produit utilisé lors de la récolte.

Nom Type Description
area

Measure

Schéma pour le stockage de la lecture et de l’unité de mesure.

avgMoisture

Measure

Schéma pour le stockage de la lecture et de l’unité de mesure.

avgWetMass

Measure

Schéma pour le stockage de la lecture et de l’unité de mesure.

avgYield

Measure

Schéma pour le stockage de la lecture et de l’unité de mesure.

productName

string

Nom du produit.

totalWetMass

Measure

Schéma pour le stockage de la lecture et de l’unité de mesure.

totalYield

Measure

Schéma pour le stockage de la lecture et de l’unité de mesure.

InnerError

Erreur interne contenant la liste des erreurs. Consultez https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object le document de référence InnerError.

Nom Type Description
code

string

Code d’erreur spécifique fourni par l’erreur contenant.

innererror

InnerError

Erreur interne contenant la liste des erreurs. Consultez https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object le document de référence InnerError.

Measure

Schéma pour le stockage de la lecture et de l’unité de mesure.

Nom Type Description
unit

string

Unité de données.

value

number

Valeur de données.