Seasonal Fields - Search

Serviço:: Azure Data Manager for Agriculture

Versão da API:: 2023-11-01-preview

Pesquise campos sazonais em todas as partes cruzando geometria.

POST {endpoint}/seasonal-fields:search?api-version=2023-11-01-preview

Com parâmetros opcionais:

POST {endpoint}/seasonal-fields:search?skipToken={skipToken}&maxPageSize={maxPageSize}&api-version=2023-11-01-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
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
maxPageSize	query		integer (int32) minimum: 10 maximum: 1000	Número máximo de itens necessários (inclusive). Mínimo = 10, Máximo = 1000, Valor Padrão = 50.
skipToken	query		string	Ignore o token para obter o próximo conjunto de resultados.

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.

Corpo da solicitação

Nome	Tipo	Description
cropIds	string[]	CropIds do recurso.
cropProductIds	string[]	CropProductIds do recurso.
farmIds	string[]	FarmIds do recurso.
fieldIds	string[]	FieldIds do recurso.
ids	string[]	IDs do recurso.
intersectsWithGeometry	GeoJsonObject: MultiPolygon Point Polygon	GeoJSON (para obter mais detalhes: https://geojson.org/). Observação: as coordenadas são esperadas no formato [Longitude, Latitude].
maxCreatedDateTime	string (date-time)	Data máxima de criação do recurso (inclusive).
maxLastModifiedDateTime	string (date-time)	Data máxima da última modificação do recurso (inclusive).
minCreatedDateTime	string (date-time)	Data mínima de criação do recurso (inclusive).
minLastModifiedDateTime	string (date-time)	Data mínima da última modificação do recurso (inclusive).
names	string[]	Nomes do recurso.
partyId	string	ID da parte que pertence aos dados da operação.
propertyFilters	string[]	Filtra os pares chave-valor dentro do objeto Properties. por exemplo, "{testKey} eq {testValue}".
seasonIds	string[]	SeasonIds do recurso.
statuses	string[]	Status do recurso.

Respostas

Nome	Tipo	Description
200 OK	SeasonalFieldMetaDataListResponse	Êxito
Other Status Codes	ErrorResponse	Erro Cabeçalhos x-ms-error-code: string

Nome

Tipo

Description

200 OK

SeasonalFieldMetaDataListResponse

Ê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

SeasonalFields_Search

Solicitação de exemplo

HTTP

POST {endpoint}/seasonal-fields:search?maxPageSize=50&api-version=2023-11-01-preview

{
  "intersectsWithGeometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          73.70457172393799,
          20.545385304358106
        ],
        [
          73.70457172393799,
          20.545385304358106
        ],
        [
          73.70448589324951,
          20.542411534243367
        ],
        [
          73.70877742767334,
          20.541688176010233
        ],
        [
          73.71023654937744,
          20.545083911372505
        ],
        [
          73.70663166046143,
          20.546992723579137
        ],
        [
          73.70457172393799,
          20.545385304358106
        ]
      ]
    ]
  }
}

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "id": "SEASONALFIELD123",
      "partyId": "FARMER123",
      "farmId": "FARM123",
      "fieldId": "FIELD123",
      "seasonId": "WINTER_WHEAT_2021",
      "cropId": "WHEAT",
      "name": "John Smith's Seasonal 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"
    }
  ],
  "skipToken": "string",
  "nextLink": "https://{{resourceName}}.farmbeats.azure.net/farmers/{{partyId}}/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

Nome	Description
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.
GeoJsonObjectType	Tipo de objeto GeoJSON.
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.
MultiPolygon	Geometria multiPolygon.
Point	Geometria de ponto.
Polygon	Geometria de polígono.
SearchSeasonalFieldQuery	Parâmetros SearchAllBoundaries e SearchBoundaries.
SeasonalFieldMetaData	Esquema do recurso de campo sazonal.
SeasonalFieldMetaDataListResponse	A resposta paginada contém uma lista de objetos solicitados e um skipToken para obter o próximo conjunto de resultados.

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.

GeoJsonObjectType

Enumeração

Tipo de objeto GeoJSON.

Valor	Description
Point
Polygon
MultiPolygon

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.

MultiPolygon

Objeto

Geometria multiPolygon.

Nome	Tipo	Description
coordinates	number[] (double)	Obtém ou define coordenadas do objeto GeoJSON. Deve ser uma matriz de polígonos, cada polígono contém uma lista de anéis lineares. Para polígonos com mais de um desses anéis, o primeiro DEVE ser o anel exterior, e qualquer outro DEVE ser anéis interiores.
type	string: MultiPolygon	Tipo de objeto GeoJSON.

Point

Objeto

Geometria de ponto.

Nome	Tipo	Description
coordinates	number[] (double)	Obtém ou define a coordenada deste ponto. Deve ser uma matriz de 2 ou 3 elementos para um sistema 2D ou 3D.
type	string: Point	Tipo de objeto GeoJSON.

Polygon

Objeto

Geometria de polígono.

Nome	Tipo	Description
coordinates	number[] (double)	Obtém ou define o tipo do objeto GeoJSON. Deve ser uma matriz de matrizes de coordenadas de anel linear. Para polígonos com mais de um desses anéis, o primeiro DEVE ser o anel exterior, e qualquer outro DEVE ser anéis interiores.
type	string: Polygon	Tipo de objeto GeoJSON.

SearchSeasonalFieldQuery

Objeto

Parâmetros SearchAllBoundaries e SearchBoundaries.

Nome	Tipo	Description
cropIds	string[]	CropIds do recurso.
cropProductIds	string[]	CropProductIds do recurso.
farmIds	string[]	FarmIds do recurso.
fieldIds	string[]	FieldIds do recurso.
ids	string[]	IDs do recurso.
intersectsWithGeometry	GeoJsonObject: MultiPolygon Point Polygon	GeoJSON (para obter mais detalhes: https://geojson.org/). Observação: as coordenadas são esperadas no formato [Longitude, Latitude].
maxCreatedDateTime	string (date-time)	Data máxima de criação do recurso (inclusive).
maxLastModifiedDateTime	string (date-time)	Data máxima da última modificação do recurso (inclusive).
minCreatedDateTime	string (date-time)	Data mínima de criação do recurso (inclusive).
minLastModifiedDateTime	string (date-time)	Data mínima da última modificação do recurso (inclusive).
names	string[]	Nomes do recurso.
partyId	string	ID da parte que pertence aos dados da operação.
propertyFilters	string[]	Filtra os pares chave-valor dentro do objeto Properties. por exemplo, "{testKey} eq {testValue}".
seasonIds	string[]	SeasonIds do recurso.
statuses	string[]	Status do recurso.

SeasonalFieldMetaData

Objeto

Esquema do recurso de campo sazonal.

Nome	Tipo	Description
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.
cropId	string	A ID da colheita à qual pertence.
cropProductIds	string[]	IDs de CropProduct.
description	string minLength: 0 maxLength: 500	Descrição textual do recurso.
eTag	string	O valor ETag para implementar a simultaneidade otimista.
farmId	string	ID da Farm associada.
fieldId	string	ID do campo associado.
id	string	ID de recurso exclusiva.
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.
partyId	string	ID da festa.
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.
seasonId	string	Id da temporada à qual pertence.
source	string minLength: 2 maxLength: 100	Origem do recurso.
status	string minLength: 0 maxLength: 100	Status do recurso.

SeasonalFieldMetaDataListResponse

Objeto

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

Nome	Tipo	Description
nextLink	string	Link de continuação (URI absoluto) para a próxima página de resultados na lista.
skipToken	string	Token usado na recuperação da próxima página. Se for nulo, não haverá páginas adicionais.
value	SeasonalFieldMetaData[]	Lista de objetos solicitados.