Partilhar via


Harvest Data - List

Devolve uma lista paginada de recursos de dados de recolha em todas as 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 do URI

Name Em Necessário Tipo Description
api-version
query True

string

A versão da API pedida

associatedBoundaryIds
query

string[]

IDs de limite associados aos dados de 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 AvgSpeed máximo (inclusive).

maxAvgWetMass
query

number

double

Valor máximo de AvgWetMass (inclusive).

maxAvgYield
query

number

double

Valor Máximo AvgYield (inclusive).

maxCreatedDateTime
query

string

date-time

Data de criação máxima do recurso (inclusive).

maxLastModifiedDateTime
query

string

date-time

Data máxima da última modificação do recurso (inclusive).

maxOperationEndDateTime
query

string

date-time

Data de fim máxima dos dados da operação, formato de exemplo: yyyy-MM-ddTHH:mm:ssZ (inclusive).

maxOperationModifiedDateTime
query

string

date-time

Data-hora máxima modificada dos dados de operação, formato de exemplo: yyyy-MM-ddTHH:mm:ssZ (inclusive).

maxOperationStartDateTime
query

string

date-time

Data de início máxima dos dados da operação, formato de exemplo: yyyy-MM-ddTHH:mm:ssZ (inclusive).

maxPageSize
query

integer

int32

Número máximo de itens necessários (inclusive). Mínimo = 10, Máximo = 1000, Valor predefinido = 50.

maxTotalWetMass
query

number

double

Valor máximo de WetMass (inclusive).

maxTotalYield
query

number

double

Valor de Rendimento Máximo (inclusive).

minArea
query

number

double

Área 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édio mínimo (inclusive).

minAvgWetMass
query

number

double

Valor mínimo avgWetMass(inclusive).

minAvgYield
query

number

double

Valor Mínimo AvgYield(inclusive).

minCreatedDateTime
query

string

date-time

Data de criação mínima do recurso (inclusive).

minLastModifiedDateTime
query

string

date-time

Data mínima da última modificação do recurso (inclusive).

minOperationEndDateTime
query

string

date-time

Data de fim mínima dos dados da operação, formato de exemplo: yyyy-MM-ddTHH:mm:ssZ (inclusive).

minOperationModifiedDateTime
query

string

date-time

Data-hora mínima modificada dos dados de operação, formato de exemplo: yyyy-MM-ddTHH:mm:ssZ (inclusive).

minOperationStartDateTime
query

string

date-time

Data de início mínima dos dados da operação, formato de exemplo: yyyy-MM-ddTHH:mm:ssZ (inclusive).

minTotalWetMass
query

number

double

Valor máximo de WetMass (inclusive).

minTotalYield
query

number

double

Valor de Rendimento Mínimo(inclusive).

names
query

string[]

Nomes do recurso.

propertyFilters
query

string[]

Filtra os pares chave-valor no objeto Propriedades. Por exemplo, "{testKey} eq {testValue}".

skipToken
query

string

Ignore o token para obter o próximo conjunto de resultados.

sources
query

string[]

Origens dos dados da operação.

statuses
query

string[]

Estados do recurso.

Cabeçalho do Pedido

Name Necessário Tipo Description
Authorization True

string

Forneça um token de portador válido para chamadas à API autorizadas. Tenha em atenção que poderá ter de limpar a cache do browser se já tiver tentado chamadas não autenticadas antes.

Respostas

Name Tipo Description
200 OK

HarvestDataListResponse

Success

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 à API autorizadas. Tenha em atenção que poderá ter de limpar a cache do browser se já tiver tentado chamadas não autenticadas antes.

Tipo: apiKey
Em: header

Exemplos

HarvestData_List

Pedido de amostra

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

Resposta da amostra

{
  "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. Veja https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses o documento de referência ErrorResponse.

HarvestData

Esquema do recurso de dados de recolha.

HarvestDataListResponse

A resposta paginada contém uma lista de objetos pedidos e uma ligação de URL para obter o próximo conjunto de resultados.

HarvestProductDetail

Esquema do produto utilizado durante a colheita.

InnerError

Erro interno que contém a lista de erros. Veja https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError.

Measure

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

Error

Um erro do serviço Azure AgPlatform.

Name Tipo Description
code

string

Conjunto definido pelo servidor de códigos de erro.

details

Error[]

Matriz de detalhes sobre erros específicos que levaram a este erro reportado.

innererror

InnerError

Erro interno que contém a lista de erros. Veja https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError.

message

string

Representação legível por humanos do erro.

target

string

Destino do erro.

ErrorResponse

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

Name Tipo Description
error

Error

Um erro do serviço Azure AgPlatform.

traceId

string

ID de rastreio exclusivo.

HarvestData

Esquema do recurso de dados de recolha.

Name Tipo Description
area

Measure

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

associatedBoundaryId

string

ID de limite opcional do campo para o qual a operação foi aplicada.

attachmentsLink

string

Ligação para anexos.

avgMoisture

Measure

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

avgSpeed

Measure

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

avgWetMass

Measure

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

avgYield

Measure

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

createdBy

string

Criado pelo ID de utilizador/inquilino.

createdDateTime

string

Data-hora em que o recurso foi criado, formato de exemplo: yyyy-MM-ddTHH:mm:ssZ.

description

string

Descrição textual do recurso.

eTag

string

O valor ETag para implementar a simultaneidade otimista.

harvestProductDetails

HarvestProductDetail[]

Detalhes do produto de colheita.

id

string

ID de recurso exclusivo.

modifiedBy

string

Modificado pelo ID de utilizador/inquilino.

modifiedDateTime

string

Data-hora em que o recurso foi modificado pela última vez, formato de exemplo: yyyy-MM-ddTHH:mm:ssZ.

name

string

Nome para identificar o recurso.

operationEndDateTime

string

Data-hora de fim dos dados da operação, formato de exemplo: yyyy-MM-ddTHH:mm:ssZ.

operationModifiedDateTime

string

Data-hora modificada dos dados de operação, formato de exemplo: yyyy-MM-ddTHH:mm:ssZ. Nota: esta ação será especificada pelo próprio fornecedor de origem.

operationStartDateTime

string

Data-hora de início dos dados da operação, formato de exemplo: yyyy-MM-ddTHH:mm:ssZ.

partyId

string

ID da entidade que pertence aos dados da operação.

properties

Uma coleção de pares de valores chave que pertence ao recurso. Cada par não pode ter uma chave superior a 50 carateres e não pode ter um valor superior a 150 carateres. Nota: é possível fornecer um máximo de 25 pares de valores de chave para um recurso e apenas os valores de cadeia, numeral e datetime (yyy-MM-ddTHH:mm:ssZ).

source

string

Origem do recurso.

status

string

Estado do recurso.

totalWetMass

Measure

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

totalYield

Measure

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

HarvestDataListResponse

A resposta paginada contém uma lista de objetos pedidos e uma ligação de URL para obter o próximo conjunto de resultados.

Name Tipo Description
nextLink

string

Ligação de continuação (URI absoluto) para a página seguinte dos resultados na lista.

skipToken

string

Token utilizado na obtenção da página seguinte. Se for nulo, não existem páginas adicionais.

value

HarvestData[]

Lista de objetos pedidos.

HarvestProductDetail

Esquema do produto utilizado durante a colheita.

Name Tipo Description
area

Measure

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

avgMoisture

Measure

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

avgWetMass

Measure

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

avgYield

Measure

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

productName

string

Nome do produto.

totalWetMass

Measure

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

totalYield

Measure

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

InnerError

Erro interno que contém a lista de erros. Veja https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError.

Name Tipo Description
code

string

Código de erro específico do que foi fornecido pelo erro de contenção.

innererror

InnerError

Erro interno que contém a lista de erros. Veja https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError.

Measure

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

Name Tipo Description
unit

string

Unidade de dados.

value

number

Valor de dados.