Fields - Get

Obtém um recurso de campo especificado sob um determinado agricultor.

GET {Endpoint}/farmers/{farmerId}/fields/{fieldId}?api-version=2021-03-31-preview

Parâmetros do URI

Name In Required Type Description
Endpoint
path True
  • string

O ponto final do seu recurso FarmBeats (protocolo e nome de anfitrião, por exemplo: https://{resourceName}.farmbeats.azure.net).

farmerId
path True
  • string

Identificação do agricultor associado.

fieldId
path True
  • string

Identificação do campo.

api-version
query True
  • string

A versão API solicitada

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

Fields_Get

Sample Request

GET {Endpoint}/farmers/FARMER123/fields/FIELD123?api-version=2021-03-31-preview

Sample Response

{
  "id": "FIELD123",
  "farmerId": "FARMER123",
  "farmId": "FARM123",
  "primaryBoundaryId": "BOUNDARY123",
  "boundaryIds": [
    "BOUNDARY123",
    "BOUNDARY456"
  ],
  "name": "John Smith's Field",
  "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"
}

Definições

Error

Um erro do serviço Azure AgPlatform.

ErrorResponse

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

Field

Esquema de recursos de campo.

InnerError

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

Error

Um erro do serviço Azure AgPlatform.

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 AgPlatform.

traceId
  • string

Identificação de vestígios única.

Field

Esquema de recursos de campo.

Name Type Description
boundaryIds
  • string[]

Identificação de limites.

createdDateTime
  • string

Data-hora quando o recurso foi criado, formato de amostra: yyyy-MM-ddTHH:mm:ssZ.

description
  • string

Descrição textual do recurso.

eTag
  • string

O valor do ETag para implementar a concordância otimista.

farmId
  • string

Identificação da quinta associada.

farmerId
  • string

Identificação de agricultor.

id
  • string

Identificação de recursos única.

modifiedDateTime
  • string

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

name
  • string

Nome para identificar recurso.

primaryBoundaryId
  • string

Identificação de limite primário.

properties
  • object

Uma coleção de pares de valor chave que pertence ao recurso. Cada par não deve ter uma chave superior a 50 caracteres e não deve ter um valor superior a 150 caracteres. Nota: Um máximo de 25 pares de valores-chave pode ser fornecido para um recurso e apenas os valores de corda e numeral são suportados.

status
  • string

Estado do recurso.

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.