Harvest Data - List

Serviço:: Azure Data Manager for Agriculture

Versão da API:: 2023-06-01-preview

Retorna uma lista paginada de recursos de dados de colheita em todas as partes.

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

Com parâmetros opcionais:

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 do URI

Name	Em	Necessário	Tipo	Description
api-version	query	True	string	A versão da API solicitada
associatedBoundaryIds	query		string[]	IDs de limite associados aos dados da operação.
ids	query		string[]	Ids do recurso.
maxArea	query		number (double)	Área máxima para a qual a operação foi aplicada (inclusive).
maxAvgMoisture	query		number (double)	Valor máximo de AvgMoisture (inclusive).
maxAvgSpeed	query		number (double)	Valor máximo de AvgSpeed (inclusive).
maxAvgWetMass	query		number (double)	Valor máximo de AvgWetMass (inclusive).
maxAvgYield	query		number (double)	Valor máximo de AvgYield (inclusive).
maxCreatedDateTime	query		string (date-time)	Data máxima de criação do recurso (inclusive).
maxLastModifiedDateTime	query		string (date-time)	Data máxima da última modificação do recurso (inclusive).
maxOperationEndDateTime	query		string (date-time)	Data-hora final máxima dos dados da operação, formato de exemplo: aaaa-MM-ddTHH:mm:ssZ (inclusive).
maxOperationModifiedDateTime	query		string (date-time)	Data-hora máxima modificada dos dados da operação, formato de exemplo: aaaa-MM-ddTHH:mm:ssZ (inclusive).
maxOperationStartDateTime	query		string (date-time)	Data-hora máxima de início dos dados da operação, formato de exemplo: aaaa-MM-ddTHH:mm:ssZ (inclusive).
maxPageSize	query		integer (int32) minimum: 10 maximum: 1000	Número máximo de itens necessários (inclusive). Mínimo = 10, Máximo = 1000, Valor padrão = 50.
maxTotalWetMass	query		number (double)	Valor máximo de massa húmida total (inclusive).
maxTotalYield	query		number (double)	Valor de rendimento máximo (inclusive).
minArea	query		number (double)	Superfície mínima para a qual a operação foi aplicada (inclusive).
minAvgMoisture	query		number (double)	Valor mínimo de 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 de AvgYield (inclusive).
minCreatedDateTime	query		string (date-time)	Data mínima de criação do recurso (inclusive).
minLastModifiedDateTime	query		string (date-time)	Data mínima da última modificação do recurso (inclusive).
minOperationEndDateTime	query		string (date-time)	Data-hora mínima de fim dos dados da operação, formato de exemplo: aaaa-MM-ddTHH:mm:ssZ (inclusive).
minOperationModifiedDateTime	query		string (date-time)	Data-hora mínima modificada dos dados da operação, formato de exemplo: aaaa-MM-ddTHH:mm:ssZ (inclusive).
minOperationStartDateTime	query		string (date-time)	Data-hora mínima de início dos dados da operação, formato de exemplo: aaaa-MM-ddTHH:mm:ssZ (inclusive).
minTotalWetMass	query		number (double)	Valor mínimo de massa húmida total (inclusive).
minTotalYield	query		number (double)	Valor do rendimento mínimo (inclusive).
names	query		string[]	Nomes do recurso.
propertyFilters	query		string[]	Filtra em pares chave-valor dentro do objeto Properties. por exemplo. "{testKey} eq {testValue}".
skipToken	query		string	Ignorar token para obter o próximo conjunto de resultados.
sources	query		string[]	Fontes dos dados da operação.
statuses	query		string[]	Status do recurso.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Authorization	True	string	Forneça um token de portador válido para chamadas de API autorizadas. Observe que talvez seja necessário limpar o cache do navegador se tiver tentado chamadas não autenticadas antes.

Respostas

Name	Tipo	Description
200 OK	HarvestDataListResponse	Sucesso
Other Status Codes	ErrorResponse	Erro Cabeçalhos x-ms-error-code: string

Name

Tipo

Description

200 OK

HarvestDataListResponse

Sucesso

Other Status Codes

ErrorResponse

Erro

Cabeçalhos

x-ms-error-code: string

Segurança

Authorization

Forneça um token de portador válido para chamadas de API autorizadas. Observe que talvez seja necessário limpar o cache do navegador se tiver tentado chamadas não autenticadas antes.

Tipo: apiKey
Em: header

Exemplos

HarvestData_List

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 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"
}

Definições

Name	Description
Error	Um erro do serviço Azure AgPlatform.
ErrorResponse	Uma resposta de erro do serviço Azure AgPlatform. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses para o documento de referência ErrorResponse.
HarvestData	Esquema do recurso de dados de colheita.
HarvestDataListResponse	A resposta paginada contém uma lista de objetos solicitados e um link de URL para obter o próximo conjunto de resultados.
HarvestProductDetail	Esquema do produto utilizado durante a colheita.
InnerError	Erro interno contendo lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object para o documento de referência InnerError.
Measure	Esquema para armazenar leitura de medição e unidade.

Error

Object

Um erro do serviço Azure AgPlatform.

Name	Tipo	Description
code	string minLength: 1	Conjunto de códigos de erro definido pelo servidor.
details	Error[]	Matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	InnerError	Erro interno contendo lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object para o documento de referência InnerError.
message	string minLength: 1	Representação legível por humanos do erro.
target	string	Alvo do erro.

ErrorResponse

Object

Uma resposta de erro do serviço Azure AgPlatform. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses para o documento de referência ErrorResponse.

Name	Tipo	Description
error	Error	Um erro do serviço Azure AgPlatform.
traceId	string	Id de rastreamento exclusivo.

HarvestData

Object

Esquema do recurso de dados de colheita.

Name	Tipo	Description
area	Measure	Esquema para armazenar leitura de medição e unidade.
associatedBoundaryId	string	ID de limite opcional do campo para o qual a operação foi aplicada.
attachmentsLink	string	Link para anexos.
avgMoisture	Measure	Esquema para armazenar leitura de medição e unidade.
avgSpeed	Measure	Esquema para armazenar leitura de medição e unidade.
avgWetMass	Measure	Esquema para armazenar leitura de medição e unidade.
avgYield	Measure	Esquema para armazenar leitura de medição e unidade.
createdBy	string	Criado por ID de usuário/locatário.
createdDateTime	string (date-time)	Data-hora em que o recurso foi criado, formato de exemplo: aaaa-MM-ddTHH:mm:ssZ.
description	string minLength: 0 maxLength: 500	Descrição textual do recurso.
eTag	string	O valor ETag para implementar simultaneidade otimista.
harvestProductDetails	HarvestProductDetail[]	Detalhes do produto de colheita.
id	string	ID de recurso exclusivo.
modifiedBy	string	Modificado pelo ID do usuário/locatário.
modifiedDateTime	string (date-time)	Data-hora em que o recurso foi modificado pela última vez, formato de exemplo: aaaa-MM-ddTHH:mm:ssZ.
name	string minLength: 0 maxLength: 100	Nome para identificar o recurso.
operationEndDateTime	string (date-time)	Data-hora final dos dados da operação, formato de exemplo: aaaa-MM-ddTHH:mm:ssZ.
operationModifiedDateTime	string (date-time)	Data-hora modificada dos dados da operação, formato de exemplo: aaaa-MM-ddTHH:mm:ssZ. Nota: isso será especificado pelo próprio provedor de origem.
operationStartDateTime	string (date-time)	Data-hora de início dos dados da operação, formato de exemplo: aaaa-MM-ddTHH:mm:ssZ.
partyId	string	ID da parte que pertence aos dados da operação.
properties		Uma coleção de pares de valores de chave que pertence ao recurso. Cada par não deve ter uma chave maior que 50 caracteres e não deve ter um valor maior que 150 caracteres. Nota: Um máximo de 25 pares de valores de chave podem ser fornecidos para um recurso e apenas valores de string, numeral e datetime (aaaa-MM-ddTHH:mm:ssZ) são suportados.
source	string minLength: 2 maxLength: 100	Fonte do recurso.
status	string minLength: 0 maxLength: 100	Status do recurso.
totalWetMass	Measure	Esquema para armazenar leitura de medição e unidade.
totalYield	Measure	Esquema para armazenar leitura de medição e unidade.

HarvestDataListResponse

Object

A resposta paginada contém uma lista de objetos solicitados e um link de URL para obter o próximo conjunto de resultados.

Name	Tipo	Description
nextLink	string	Link de continuação (URI absoluto) para a próxima página de resultados na lista.
skipToken	string	Token usado na recuperação da próxima página. Se null, não há páginas adicionais.
value	HarvestData[]	Lista de objetos solicitados.

HarvestProductDetail

Object

Esquema do produto utilizado durante a colheita.

Name	Tipo	Description
area	Measure	Esquema para armazenar leitura de medição e unidade.
avgMoisture	Measure	Esquema para armazenar leitura de medição e unidade.
avgWetMass	Measure	Esquema para armazenar leitura de medição e unidade.
avgYield	Measure	Esquema para armazenar leitura de medição e unidade.
productName	string minLength: 1 maxLength: 100	Nome do produto.
totalWetMass	Measure	Esquema para armazenar leitura de medição e unidade.
totalYield	Measure	Esquema para armazenar leitura de medição e unidade.

InnerError

Object

Erro interno contendo lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object para o documento de referência InnerError.

Name	Tipo	Description
code	string	Código de erro específico que foi fornecido pelo erro que contém.
innererror	InnerError	Erro interno contendo lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object para o documento de referência InnerError.

Measure

Object

Esquema para armazenar leitura de medição e unidade.

Name	Tipo	Description
unit	string minLength: 1 maxLength: 50	Unidade de dados.
value	number (double)	Valor dos dados.

Partilhar via

Harvest Data - List

Parâmetros do URI

Cabeçalho do Pedido

Respostas

Segurança

Authorization

Exemplos

HarvestData_List

Pedido de amostra

Resposta da amostra

Definições

Error

ErrorResponse

HarvestData

HarvestDataListResponse

HarvestProductDetail

InnerError

Measure