Harvest Data - List

Servicio:: Azure Data Manager for Agriculture

Versión de la API:: 2023-06-01-preview

Devuelve una lista paginada de recursos de datos de recolección en todas las partes.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
api-version	query	True	string	La versión de API solicitada
associatedBoundaryIds	query		string[]	Identificadores de límite asociados a los datos de operación.
ids	query		string[]	Identificadores del recurso.
maxArea	query		number (double)	Área máxima para la que se aplicó la operación (inclusive).
maxAvgMoisture	query		number (double)	Valor máximo de AvgMoisture (inclusivo).
maxAvgSpeed	query		number (double)	Valor máximo de AvgSpeed (incluido).
maxAvgWetMass	query		number (double)	Valor máximo de AvgWetMass (inclusivo).
maxAvgYield	query		number (double)	Valor máximo avgYield (inclusivo).
maxCreatedDateTime	query		string (date-time)	Fecha máxima de creación del recurso (inclusivo).
maxLastModifiedDateTime	query		string (date-time)	Fecha máxima de última modificación del recurso (inclusive).
maxOperationEndDateTime	query		string (date-time)	Fecha y hora de finalización máxima de los datos de la operación, formato de ejemplo: aaaa-MM-ddTHH:mm:ssZ (inclusive).
maxOperationModifiedDateTime	query		string (date-time)	Fecha y hora máxima modificada de los datos de la operación, formato de ejemplo: aaaa-MM-ddTHH:mm:ssZ (inclusive).
maxOperationStartDateTime	query		string (date-time)	Fecha y hora máxima de inicio de los datos de la operación, formato de ejemplo: aaaa-MM-ddTHH:mm:ssZ (inclusive).
maxPageSize	query		integer (int32) minimum: 10 maximum: 1000	Número máximo de elementos necesarios (ambos incluidos). Mínimo = 10, Máximo = 1000, Valor predeterminado = 50.
maxTotalWetMass	query		number (double)	Valor máximo total de wetMass (inclusive).
maxTotalYield	query		number (double)	Valor máximo de rendimiento (inclusivo).
minArea	query		number (double)	Área mínima para la que se aplicó la operación (inclusiva).
minAvgMoisture	query		number (double)	Valor mínimo avgMoisture(inclusive).
minAvgSpeed	query		number (double)	Valor mínimo de AvgSpeed(inclusive).
minAvgWetMass	query		number (double)	Valor mínimo de AvgWetMass(inclusive).
minAvgYield	query		number (double)	Valor mínimo avgYield(inclusive).
minCreatedDateTime	query		string (date-time)	Fecha de creación mínima del recurso (inclusivo).
minLastModifiedDateTime	query		string (date-time)	Fecha mínima de última modificación del recurso (inclusive).
minOperationEndDateTime	query		string (date-time)	Fecha y hora de finalización mínima de los datos de la operación, formato de ejemplo: aaaa-MM-ddTHH:mm:ssZ (inclusive).
minOperationModifiedDateTime	query		string (date-time)	Fecha y hora mínima modificada de los datos de la operación, formato de ejemplo: aaaa-MM-ddTHH:mm:ssZ (inclusive).
minOperationStartDateTime	query		string (date-time)	Fecha y hora mínima de inicio de los datos de la operación, formato de ejemplo: aaaa-MM-ddTHH:mm:ssZ (inclusive).
minTotalWetMass	query		number (double)	Valor mínimo total de wetMass (inclusive).
minTotalYield	query		number (double)	Valor de rendimiento mínimo (inclusivo).
names	query		string[]	Nombres del recurso.
propertyFilters	query		string[]	Filtra los pares clave-valor dentro del objeto Properties. Eg. "{testKey} eq {testValue}".
skipToken	query		string	Omita el token para obtener el siguiente conjunto de resultados.
sources	query		string[]	Orígenes de los datos de la operación.
statuses	query		string[]	Estados del recurso.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Authorization	True	string	Proporcione un token de portador válido para las llamadas API autorizadas. Tenga en cuenta que es posible que tenga que borrar la memoria caché del explorador si ha intentado realizar llamadas no autenticadas antes.

Respuestas

Nombre	Tipo	Description
200 OK	HarvestDataListResponse	Éxito
Other Status Codes	ErrorResponse	Error Encabezados x-ms-error-code: string

Nombre

Tipo

Description

200 OK

HarvestDataListResponse

Éxito

Other Status Codes

ErrorResponse

Error

Encabezados

x-ms-error-code: string

Seguridad

Authorization

Proporcione un token de portador válido para las llamadas API autorizadas. Tenga en cuenta que es posible que tenga que borrar la memoria caché del explorador si ha intentado realizar llamadas no autenticadas antes.

Tipo: apiKey
En: header

Ejemplos

HarvestData_List

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 200

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

Definiciones

Nombre	Description
Error	Error del servicio Azure AgPlatform.
ErrorResponse	Respuesta de error del servicio Azure AgPlatform. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses para ver el documento de referencia ErrorResponse.
HarvestData	Esquema del recurso de datos de recolección.
HarvestDataListResponse	La respuesta paginada contiene una lista de objetos solicitados y un vínculo de dirección URL para obtener el siguiente conjunto de resultados.
HarvestProductDetail	Esquema del producto utilizado durante la recolección.
InnerError	Error interno que contiene la lista de errores. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object documento de referencia de InnerError.
Measure	Esquema para almacenar la lectura y la unidad de medida.

Error

Object

Error del servicio Azure AgPlatform.

Nombre	Tipo	Description
code	string minLength: 1	Conjunto definido por el servidor de códigos de error.
details	Error[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	InnerError	Error interno que contiene la lista de errores. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object documento de referencia de InnerError.
message	string minLength: 1	Representación legible del error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error del servicio Azure AgPlatform. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses para ver el documento de referencia ErrorResponse.

Nombre	Tipo	Description
error	Error	Error del servicio Azure AgPlatform.
traceId	string	Identificador de seguimiento único.

HarvestData

Object

Esquema del recurso de datos de recolección.

Nombre	Tipo	Description
area	Measure	Esquema para almacenar la lectura y la unidad de medida.
associatedBoundaryId	string	Identificador de límite opcional del campo para el que se aplicó la operación.
attachmentsLink	string	Vínculo para datos adjuntos.
avgMoisture	Measure	Esquema para almacenar la lectura y la unidad de medida.
avgSpeed	Measure	Esquema para almacenar la lectura y la unidad de medida.
avgWetMass	Measure	Esquema para almacenar la lectura y la unidad de medida.
avgYield	Measure	Esquema para almacenar la lectura y la unidad de medida.
createdBy	string	Creado por el identificador de usuario o inquilino.
createdDateTime	string (date-time)	Fecha y hora en que se creó el recurso, formato de ejemplo: aaaa-MM-ddTHH:mm:ssZ.
description	string minLength: 0 maxLength: 500	Descripción textual del recurso.
eTag	string	Valor ETag para implementar la simultaneidad optimista.
harvestProductDetails	HarvestProductDetail[]	Detalles del producto de cosecha.
id	string	Identificador de recurso único.
modifiedBy	string	Modificado por identificador de usuario o inquilino.
modifiedDateTime	string (date-time)	Fecha y hora en que el recurso se modificó por última vez, formato de ejemplo: aaaa-MM-ddTHH:mm:ssZ.
name	string minLength: 0 maxLength: 100	Nombre para identificar el recurso.
operationEndDateTime	string (date-time)	Fecha y hora de finalización de los datos de la operación, formato de ejemplo: aaaa-MM-ddTHH:mm:ssZ.
operationModifiedDateTime	string (date-time)	Fecha y hora modificada de los datos de la operación, formato de ejemplo: aaaa-MM-ddTHH:mm:ssZ. Nota: el propio proveedor de origen especificará esto.
operationStartDateTime	string (date-time)	Fecha y hora de inicio de los datos de la operación, formato de ejemplo: aaaa-MM-ddTHH:mm:ssZ.
partyId	string	Id. de entidad que pertenece a los datos de la operación.
properties		Colección de pares clave-valor que pertenece al recurso. Cada par no debe tener una clave superior a 50 caracteres y no debe tener un valor superior a 150 caracteres. Nota: Se pueden proporcionar un máximo de 25 pares clave-valor para un recurso y solo se admiten valores string, numeral y datetime (aaaa-MM-ddTHH:mm:ssZ).
source	string minLength: 2 maxLength: 100	Origen del recurso.
status	string minLength: 0 maxLength: 100	Estado del recurso.
totalWetMass	Measure	Esquema para almacenar la lectura y la unidad de medida.
totalYield	Measure	Esquema para almacenar la lectura y la unidad de medida.

HarvestDataListResponse

Object

La respuesta paginada contiene una lista de objetos solicitados y un vínculo de dirección URL para obtener el siguiente conjunto de resultados.

Nombre	Tipo	Description
nextLink	string	Vínculo de continuación (URI absoluto) a la siguiente página de resultados en la lista.
skipToken	string	Token usado para recuperar la página siguiente. Si es null, no hay páginas adicionales.
value	HarvestData[]	Lista de objetos solicitados.

HarvestProductDetail

Object

Esquema del producto utilizado durante la recolección.

Nombre	Tipo	Description
area	Measure	Esquema para almacenar la lectura y la unidad de medida.
avgMoisture	Measure	Esquema para almacenar la lectura y la unidad de medida.
avgWetMass	Measure	Esquema para almacenar la lectura y la unidad de medida.
avgYield	Measure	Esquema para almacenar la lectura y la unidad de medida.
productName	string minLength: 1 maxLength: 100	Nombre del producto.
totalWetMass	Measure	Esquema para almacenar la lectura y la unidad de medida.
totalYield	Measure	Esquema para almacenar la lectura y la unidad de medida.

InnerError

Object

Error interno que contiene la lista de errores. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object documento de referencia de InnerError.

Nombre	Tipo	Description
code	string	Código de error específico del proporcionado por el error contenedor.
innererror	InnerError	Error interno que contiene la lista de errores. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object documento de referencia de InnerError.

Measure

Object

Esquema para almacenar la lectura y la unidad de medida.

Nombre	Tipo	Description
unit	string minLength: 1 maxLength: 50	Unidad de datos.
value	number (double)	Valor de datos.

Compartir a través de

Harvest Data - List

Parámetros de identificador URI

Encabezado de la solicitud

Respuestas

Seguridad

Authorization

Ejemplos

HarvestData_List

Solicitud de ejemplo

Respuesta de muestra

Definiciones

Error

ErrorResponse

HarvestData

HarvestDataListResponse

HarvestProductDetail

InnerError

Measure