Compartir a través de


Harvest Data - List

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

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

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 la 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 (inclusivo).

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 (ambos incluidos).

maxLastModifiedDateTime
query

string

date-time

Fecha máxima de última modificación del recurso (inclusive).

maxOperationEndDateTime
query

string

date-time

Fecha y hora máxima de finalización 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

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 (ambos incluidos).

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 (inclusive).

minAvgMoisture
query

number

double

Valor mínimo avgMoisture(inclusive).

minAvgSpeed
query

number

double

Valor mínimo de AvgSpeed (inclusivo).

minAvgWetMass
query

number

double

Valor mínimo de AvgWetMass (inclusivo).

minAvgYield
query

number

double

Valor mínimo avgYield(inclusivo).

minCreatedDateTime
query

string

date-time

Fecha mínima de creación del recurso (ambos incluidos).

minLastModifiedDateTime
query

string

date-time

Fecha mínima de última modificación del recurso (ambos incluidos).

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 de inicio mínima 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 (ambos incluidos).

minTotalYield
query

number

double

Valor mínimo de rendimiento (inclusivo).

names
query

string[]

Nombres del recurso.

propertyFilters
query

string[]

Filtra los pares clave-valor dentro del objeto Properties. P. ej. "{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

Correcto

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

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

Respuesta de muestra

{
  "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 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 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 el documento de referencia innerError.

Measure

Esquema para almacenar la lectura y la unidad de medición.

Error

Error del servicio Azure AgPlatform.

Nombre Tipo Description
code

string

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 el documento de referencia innerError.

message

string

Representación legible del error.

target

string

Destino del error.

ErrorResponse

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

Nombre Tipo Description
error

Error

Error del servicio Azure AgPlatform.

traceId

string

Identificador de seguimiento único.

HarvestData

Esquema del recurso de datos de recolección.

Nombre Tipo Description
area

Measure

Esquema para almacenar la lectura y la unidad de medición.

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 medición.

avgSpeed

Measure

Esquema para almacenar la lectura y la unidad de medición.

avgWetMass

Measure

Esquema para almacenar la lectura y la unidad de medición.

avgYield

Measure

Esquema para almacenar la lectura y la unidad de medición.

createdBy

string

Creado por el identificador de usuario o inquilino.

createdDateTime

string

Fecha y hora en que se creó el recurso, formato de ejemplo: aaaa-MM-ddTHH:mm:ssZ.

description

string

Descripción textual del recurso.

eTag

string

Valor ETag para implementar la simultaneidad optimista.

harvestProductDetails

HarvestProductDetail[]

Detalles del producto de la cosecha.

id

string

Identificador de recurso único.

modifiedBy

string

Modificado por el identificador de usuario o inquilino.

modifiedDateTime

string

Fecha y hora en que se modificó por última vez el recurso, formato de ejemplo: aaaa-MM-ddTHH:mm:ssZ.

name

string

Nombre para identificar el recurso.

operationEndDateTime

string

Fecha y hora de finalización de los datos de la operación, formato de ejemplo: aaaa-MM-ddTHH:mm:ssZ.

operationModifiedDateTime

string

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

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 de cadena, numeral y datetime (aaaa-MM-ddTHH:mm:ssZ).

source

string

Origen del recurso.

status

string

Estado del recurso.

totalWetMass

Measure

Esquema para almacenar la lectura y la unidad de medición.

totalYield

Measure

Esquema para almacenar la lectura y la unidad de medición.

HarvestDataListResponse

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

Nombre Tipo Description
nextLink

string

Vínculo de continuación (URI absoluto) a la página siguiente de resultados de 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

Esquema del producto utilizado durante la recolección.

Nombre Tipo Description
area

Measure

Esquema para almacenar la lectura y la unidad de medición.

avgMoisture

Measure

Esquema para almacenar la lectura y la unidad de medición.

avgWetMass

Measure

Esquema para almacenar la lectura y la unidad de medición.

avgYield

Measure

Esquema para almacenar la lectura y la unidad de medición.

productName

string

Nombre del producto.

totalWetMass

Measure

Esquema para almacenar la lectura y la unidad de medición.

totalYield

Measure

Esquema para almacenar la lectura y la unidad de medición.

InnerError

Error interno que contiene la lista de errores. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object el documento de referencia 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 el documento de referencia innerError.

Measure

Esquema para almacenar la lectura y la unidad de medición.

Nombre Tipo Description
unit

string

Unidad de datos.

value

number

Valor de datos.