Farms - List

Obtenha uma lista paginada de recursos agrícolas em todos os agricultores para um determinado critério de pesquisa.

Nota:
  1. Esta API faz uma pesquisa em série da base de dados para os critérios de pesquisa dados. Se o id do agricultor estiver disponível, recomenda-se vivamente a utilização da API "List by Farmer Id" uma vez que é executante.
  2. Os utilizadores receberão resposta paginada com cada página contendo um link para a página seguinte. Poucas páginas podem não ter itens (resultados zero). Espera-se que os utilizadores iterem em todas as páginas usando o 'nextLink'. A procura termina quando o 'nextLink' é nulo.
GET /farms?api-version=2021-03-31-preview
GET /farms?ids={ids}&names={names}&propertyFilters={propertyFilters}&statuses={statuses}&minCreatedDateTime={minCreatedDateTime}&maxCreatedDateTime={maxCreatedDateTime}&minLastModifiedDateTime={minLastModifiedDateTime}&maxLastModifiedDateTime={maxLastModifiedDateTime}&$maxPageSize={$maxPageSize}&$skipToken={$skipToken}&api-version=2021-03-31-preview

Parâmetros do URI

Name In Required Type Description
api-version
query True
  • string

A versão solicitada da API.

$maxPageSize
query
  • integer
int32

Número máximo de itens a serem devolvidos numa única página.

$skipToken
query
  • string

Esqueça o token para obter o próximo conjunto de resultados.

ids
query
  • array

Lista de ids de quintas a serem devolvidas.

maxCreatedDateTime
query
  • string
date-time

Os recursos criados antes da data-data da UTC são devolvidos (formato: yyyy-MM-ddTHH:mm:mm:ssZ).

maxLastModifiedDateTime
query
  • string
date-time

Os recursos modificados pela última vez na hora da data do UTC é devolvido (formato: yyyy-MM-ddTHH:mm:mm:ssZ).

minCreatedDateTime
query
  • string
date-time

Os recursos criados na hora da data da UTC são devolvidos (formato: yyy-MM-ddTHH:mm:mm:ssZ).

minLastModifiedDateTime
query
  • string
date-time

Os recursos modificados pela última vez na hora da data do UTC são devolvidos (formato: yyyy-MM-ddTHH:mm:ssZ).

names
query
  • array

Lista de nomes de quintas a serem devolvidas.

propertyFilters
query
  • array

Filtros em pares de valor-chave dentro de 'Propriedades'. Por exemplo,"{testKey} eq {testValue}".

statuses
query
  • array

As quintas com apenas os estatutos são devolvidas.

Cabeçalho do Pedido

Name Required Type Description
Authorization True
  • string

Por favor, forneça um sinal ao portador válido para chamadas autorizadas da API. Note que poderá ter de limpar a cache do seu navegador se tiver experimentado chamadas não autenticadas antes.

Respostas

Name Type Description
200 OK

Success

Other Status Codes

Erro

Segurança

Authorization

Por favor, forneça um sinal ao portador válido para chamadas autorizadas da API. Note que poderá ter de limpar a cache do seu navegador se tiver experimentado chamadas não autenticadas antes.

Type: apiKey
In: header

Exemplos

Farms_List

Sample Request

GET /farms?api-version=2021-03-31-preview

Sample Response

{
  "value": [
    {
      "id": "FARM123",
      "farmerId": "FARMER123",
      "name": "John Smith's Farm",
      "status": "Active",
      "description": "Some description",
      "properties": {
        "Irrigated": "Yes",
        "RetailerId": "Retailer123"
      },
      "createdDateTime": "2021-04-21T06:49:30Z",
      "modifiedDateTime": "2021-04-21T06:49:30Z",
      "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e"
    }
  ],
  "$skipToken": "string",
  "nextLink": "https://{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/seasonalFields/{{seasonalFieldId}}?api-version={{apiVersion}}&$skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d"
}

Definições

Error

Um erro do serviço Azure FarmBeats.

ErrorResponse

Uma resposta de erro do serviço Azure AgPlatform. Documento de referência errorResponse..

Farm

Esquema de um recurso agrícola.

FarmListResponse

A resposta em página contém uma lista de objetos solicitados e uma ligação URL para obter o próximo conjunto de resultados.

InnerError

Erro interno que contém lista de erros. Documento de referência innerError.

Error

Um erro do serviço Azure FarmBeats.

Name Type Description
code
  • string

Conjunto de códigos de erro definidos pelo servidor.

details

Conjunto de detalhes sobre erros específicos que levaram a este erro relatado.

innererror

Erro interno que contém lista de erros. Documento de referência innerError.

message
  • string

Representação legível pelo erro.

target
  • string

Alvo do erro.

ErrorResponse

Uma resposta de erro do serviço Azure AgPlatform. Documento de referência errorResponse..

Name Type Description
error

Um erro do serviço Azure FarmBeats.

traceId
  • string

Identificação de vestígios únicos.

Farm

Esquema de um recurso agrícola.

Name Type Description
createdDateTime
  • string

Data-data UTC em que o recurso foi criado (formato: yyyy-MM-ddTHH:mm:ssZ).

description
  • string

Breve descrição da quinta.

eTag
  • string

O valor ETag pode ser usado para implementar a concordância otimista.

farmerId
  • string

Identificação do agricultor associado.

id
  • string

Identificação única da quinta. Esta identificação é única para um determinado agricultor.

modifiedDateTime
  • string

Data-data UTC em que o recurso foi modificado pela última vez (formato: yyy-MM-ddTHH:mm:ssZ).

name
  • string

O nome da quinta.

properties
  • object

Uma coleção de pares de valor chave associados ao recurso.Uma chave é uma corda e um valor pode ser um numérico ou uma corda.Um máximo de 25 pares de valores chave pode ser associado a um recurso.

status
  • string

O utilizador determinou o estado do recurso.

FarmListResponse

A resposta em página contém uma lista de objetos solicitados e uma ligação URL para obter o próximo conjunto de resultados.

Name Type Description
$skipToken
  • string

Token usado na recuperação da página seguinte. Se nulo, não há páginas adicionais.

nextLink
  • string

Link de continuação (URI absoluto) para a próxima página de resultados da lista. Se nulo, não há páginas adicionais.

value

Lista de objetos solicitados.

InnerError

Erro interno que contém lista de erros. Documento de referência innerError.

Name Type Description
code
  • string

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

innererror

Erro interno que contém lista de erros. Documento de referência innerError.