Crops - Get

Serviço:

Azure Data Manager for Agriculture

Versão da API:

2023-11-01-preview

Obtém um recurso de corte especificado.

GET {endpoint}/crops/{cropId}?api-version=2023-11-01-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
cropId	path	True	string	ID da colheita.
endpoint	path	True	string (uri)	O nome do host do namespace, por exemplo, admaInstanceName.farmbeats.azure.net
api-version	query	True	string	A versão da API solicitada

Cabeçalho da solicitação

Nome	Obrigató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 você tentou chamadas não autenticadas antes.

Respostas

Nome	Tipo	Description
200 OK	Crop	Êxito
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 você tentou chamadas não autenticadas antes.

Tipo: apiKey
Em: header

Exemplos

Crops_Get

Solicitação de exemplo

HTTP

GET {endpoint}/crops/CORN123?api-version=2023-11-01-preview

Resposta de exemplo

Código de status:

200

{
  "id": "CORN123",
  "phenotype": "Corn",
  "breedingMethod": "VARIETY",
  "measurements": {
    "m1": {
      "unit": "string",
      "value": 0
    },
    "m2": {
      "unit": "string",
      "value": 0
    },
    "m3": {
      "unit": "string",
      "value": 0
    }
  },
  "name": "John Smith's Crop",
  "status": "Active",
  "description": "Some description",
  "source": "source",
  "properties": {
    "Irrigated": "Yes",
    "RetailerId": "Retailer123"
  },
  "createdDateTime": "2021-04-21T06:49:30Z",
  "modifiedDateTime": "2021-04-21T06:49:30Z",
  "createdBy": "00000000-0000-0000-0000-000000000000",
  "modifiedBy": "00000000-0000-0000-0000-000000000000",
  "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e"
}

Definições

Nome	Description
Crop	Esquema de recurso de corte.
Error	Um erro do serviço AgPlatform do Azure.
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.
InnerError	Erro interno que contém a 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 a leitura e a unidade de medição.
Reference	Referência a um registro de conjunto de dados.

Crop

Objeto

Esquema de recurso de corte.

Nome	Tipo	Description
breedingMethod	string	Tipo de método de reprodução, como VARIETY, HYBRID, UNKNOWN.
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: yyyy-MM-ddTHH:mm:ssZ.
description	string minLength: 0 maxLength: 500	Descrição textual do recurso.
eTag	string	O valor ETag para implementar a simultaneidade otimista.
id	string	ID de recurso exclusiva.
location	string minLength: 0 maxLength: 50	Região onde a cultura é plantada.
measurements	<string,  Measure>	As propriedades que pertencem a essa cultura, como peso nominal, umidade nominal e fator de redução.
modifiedBy	string	Modificado pela ID do usuário/locatário.
modifiedDateTime	string (date-time)	Data/hora em que o recurso foi modificado pela última vez, formato de exemplo: yyyy-MM-ddTHH:mm:ssZ.
name	string minLength: 0 maxLength: 100	Nome para identificar o recurso.
phenotype	string minLength: 0 maxLength: 100	Fenótipo da cultura. Os valores de exemplo são peso da cultura, altura, cor etc.
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. Observação: um máximo de 25 pares de valor de chave pode ser fornecido para um recurso e somente valores de cadeia de caracteres, numeral e datetime (yyyy-MM-ddTHH:mm:ssZ) têm suporte.
reference	Reference	Referência a um registro de conjunto de dados.
source	string minLength: 2 maxLength: 100	Origem do recurso.
status	string minLength: 0 maxLength: 100	Status do recurso.

Error

Objeto

Um erro do serviço AgPlatform do Azure.

Nome	Tipo	Description
code	string minLength: 1	Conjunto definido pelo servidor de códigos de erro.
details	Error[]	Matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	InnerError	Erro interno que contém a 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	Destino do erro.

ErrorResponse

Objeto

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.

Nome	Tipo	Description
error	Error	Um erro do serviço AgPlatform do Azure.
traceId	string	ID de rastreamento exclusiva.

InnerError

Objeto

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

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

Measure

Objeto

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

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

Reference

Objeto

Referência a um registro de conjunto de dados.

Nome	Tipo	Description
datasetId	string minLength: 0 maxLength: 100	ID do conjunto de dados.
recordId	string minLength: 0 maxLength: 100	ID do registro.