Compartilhar via


Management Zones - List By Farmer Id

Retorna uma lista paginada de recursos de zona de gerenciamento em um determinado agricultor.

GET /farmers/{farmerId}/management-zones?api-version=2021-07-31-preview
GET /farmers/{farmerId}/management-zones?types={types}&cropIds={cropIds}&seasonIds={seasonIds}&fieldIds={fieldIds}&sources={sources}&ids={ids}&names={names}&propertyFilters={propertyFilters}&statuses={statuses}&minCreatedDateTime={minCreatedDateTime}&maxCreatedDateTime={maxCreatedDateTime}&minLastModifiedDateTime={minLastModifiedDateTime}&maxLastModifiedDateTime={maxLastModifiedDateTime}&$maxPageSize={$maxPageSize}&$skipToken={$skipToken}&api-version=2021-07-31-preview

Parâmetros de URI

Nome Em Obrigatório Tipo Description
farmerId
path True

string

ID do fazendeiro associado.

api-version
query True

string

A versão da API solicitada

$maxPageSize
query

integer

int32

Número máximo de itens necessários (inclusivo). Mínimo = 10, Máximo = 1000, Valor padrão = 50.

$skipToken
query

string

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

cropIds
query

string[]

CropIds do ManagementZone.

fieldIds
query

string[]

FieldIds do ManagementZone.

ids
query

string[]

IDs do recurso.

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

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

names
query

string[]

Nomes do recurso.

propertyFilters
query

string[]

Filtra os pares chave-valor dentro do objeto Properties. ex. "{testKey} eq {testValue}".

seasonIds
query

string[]

SeasonIds do ManagementZone.

sources
query

string[]

Fontes do ManagementZone.

statuses
query

string[]

Status do recurso.

types
query

string[]

Tipos do ManagementZone.

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
Authorization True

string

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

Respostas

Nome Tipo Description
200 OK

ManagementZoneListResponse

Ê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 à API autorizadas. Observe que talvez seja necessário limpar o cache do navegador se você já tentou chamadas não autenticadas antes.

Tipo: apiKey
Em: header

Exemplos

ManagementZones_ListByFarmerId

Solicitação de exemplo

GET /farmers/FARMER123/management-zones?api-version=2021-07-31-preview

Resposta de exemplo

{
  "value": [
    {
      "farmerId": "FARMER123",
      "id": "ManagementZone123",
      "type": "Nutrient rich",
      "seasonId": "Season123",
      "cropId": "Crop123",
      "fieldId": "Field123",
      "source": "Agronomist",
      "name": "John Smith's ManagementZone",
      "status": "Active",
      "description": "Some description",
      "properties": {
        "Irrigated": "Yes"
      },
      "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}}/management-zones?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

Nome Description
Error

Um erro do serviço AgPlatform do Azure.

ErrorResponse

Uma resposta de erro do serviço AgPlatform do Azure. ErrorResponse reference document..

InnerError

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

ManagementZone

Modelo de API para o objeto ManagementZone.

ManagementZoneListResponse

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

Error

Um erro do serviço AgPlatform do Azure.

Nome 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 esse erro relatado.

innererror

InnerError

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

message

string

Representação legível ao olho humano do erro.

target

string

Destino do erro.

ErrorResponse

Uma resposta de erro do serviço AgPlatform do Azure. ErrorResponse reference document..

Nome Tipo Description
error

Error

Um erro do serviço AgPlatform do Azure.

traceId

string

ID de rastreamento exclusiva.

InnerError

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

Nome Tipo Description
code

string

Código de erro específico que foi fornecido pelo erro que o contém.

innererror

InnerError

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

ManagementZone

Modelo de API para o objeto ManagementZone.

Nome Tipo Description
createdDateTime

string

Data e hora em que o recurso foi criado; formato de amostra: yyyy-MM-ddTHH:mm:ssZ.

cropId

string

ID de corte associada ao ManagementZone.

description

string

Descrição textual do recurso.

eTag

string

O valor de ETag para implementar a simultaneidade otimista.

farmerId

string

ID do fazendeiro associada ao ManagementZone.

fieldId

string

ID do campo associada ao ManagementZone.

id

string

ID de recurso exclusiva.

modifiedDateTime

string

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

name

string

Nome para identificar o recurso.

properties

Uma coleção de pares chave-valor 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: há suporte para um máximo de 25 pares de valores de chave para um recurso e apenas valores de cadeia de caracteres, numeral e datetime (aaaa-MM-ddTHH:mm:ssZ).

seasonId

string

ID da temporada associada ao ManagementZone.

source

string

Origem do recurso.

status

string

Status do recurso.

type

string

Tipo de ManagementZone.

ManagementZoneListResponse

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

Nome Tipo Description
$skipToken

string

Token usado na recuperação da próxima página. Se for nulo, não haverá páginas adicionais.

nextLink

string

Link de continuação (URI absoluto) para a próxima página de resultados na lista.

value

ManagementZone[]

Lista de objetos solicitados.