Boundaries - Search

Serviço:: Azure Data Manager for Agriculture

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

Procure limites entre todas as partes por campos e geometria de intersecção.

POST /boundaries?api-version=2023-06-01-preview

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
api-version	query	True	string	A versão da API solicitada

Cabeçalho do Pedido

Name	Necessá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 tiver tentado chamadas não autenticadas antes.

Corpo do Pedido

Name	Tipo	Description
ids	string[]	Ids do recurso.
intersectsWithGeometry	GeoJsonObject: MultiPolygon Point Polygon	GeoJSON (Para mais detalhes: https://geojson.org/). Nota: As coordenadas são esperadas no formato [Longitude, Latitude].
maxArea	number (double)	Área máxima do limite (inclusive).
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).
maxPageSize	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.
minArea	number (double)	Área mínima do limite (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.
parentIds	string[]	Ids pai do recurso.
parentType	BoundaryParentType	Tipo do progenitor a que pertence.
propertyFilters	string[]	Filtra em pares chave-valor dentro do objeto Properties. por exemplo, "{testKey} eq {testValue}".
skipToken	string	Ignorar token para obter o próximo conjunto de resultados.
statuses	string[]	Status do recurso.
type	string	Digite a que pertence.

Respostas

Name	Tipo	Description
200 OK	BoundaryMetadataListResponse	Sucesso
Other Status Codes	ErrorResponse	Erro Cabeçalhos x-ms-error-code: string

Name

Tipo

Description

200 OK

BoundaryMetadataListResponse

Sucesso

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 tiver tentado chamadas não autenticadas antes.

Tipo: apiKey
Em: header

Exemplos

Boundaries_Search

Pedido de amostra

HTTP

POST /boundaries?api-version=2023-06-01-preview

{
  "ids": [
    "BOUNDARY123"
  ],
  "names": [
    "John Smith's Boundary"
  ],
  "propertyFilters": [
    "RetailerId"
  ],
  "statuses": [
    "Active"
  ],
  "minCreatedDateTime": "2021-04-22T12:53:39Z",
  "maxCreatedDateTime": "2021-04-22T12:53:39Z",
  "minLastModifiedDateTime": "2021-04-22T12:53:39Z",
  "maxLastModifiedDateTime": "2021-04-22T12:53:39Z",
  "maxPageSize": 50,
  "skipToken": "string",
  "parentType": "Field",
  "parentIds": [
    "FIELD123"
  ],
  "intersectsWithGeometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          10.98958969116211,
          45.284911882713146
        ],
        [
          11.004695892333984,
          45.284911882713146
        ],
        [
          11.004695892333984,
          45.29360722000945
        ],
        [
          10.98958969116211,
          45.29360722000945
        ],
        [
          10.98958969116211,
          45.284911882713146
        ]
      ]
    ]
  }
}

Resposta da amostra

Código de estado:: 200

{
  "value": [
    {
      "parentId": "FIELD123",
      "parentType": "Field",
      "area": {
        "unit": "Acre",
        "value": 60.405
      },
      "name": "John Smith's Boundary",
      "description": "Some description"
    }
  ],
  "skipToken": "string",
  "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{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

Name	Description
BoundaryMetadata	Esquema de metadados de recursos de limite.
BoundaryMetadataListResponse	A resposta paginada contém uma lista de objetos solicitados e um link de URL para obter o próximo conjunto de resultados.
BoundaryParentType	Tipo do progenitor a que pertence. ou seja, Field, SeasonalField, Zone, Prescription, PlantTissueAnalysis, ApplicationData, HarvestData, TillageData, PlantingData.
Error	Um erro do serviço Azure AgPlatform.
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 contendo 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 leitura de medição e unidade.
MultiPolygon	Geometria multipolígono.
Point	Geometria de pontos.
Polygon	Geometria do polígono.
SearchBoundaryQuery	Parâmetros SearchAllBoundaries e SearchBoundaries.

BoundaryMetadata

Object

Esquema de metadados de recursos de limite.

Name	Tipo	Description
area	Measure	Esquema para armazenar leitura de medição e unidade.
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: aaaa-MM-ddTHH:mm:ssZ.
description	string minLength: 0 maxLength: 500	Descrição textual do recurso.
eTag	string	O valor ETag para implementar simultaneidade otimista.
id	string	ID de recurso exclusivo.
modifiedBy	string	Modificado pelo ID do usuário/locatário.
modifiedDateTime	string (date-time)	Data-hora em que o recurso foi modificado pela última vez, formato de exemplo: aaaa-MM-ddTHH:mm:ssZ.
name	string minLength: 0 maxLength: 100	Nome para identificar o recurso.
parentId	string	Id do progenitor a que pertence.
parentType	BoundaryParentType	Tipo do progenitor a que pertence.
partyId	string	Id do partido.
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. Nota: Um máximo de 25 pares de valores de chave podem ser fornecidos para um recurso e apenas valores de string, numeral e datetime (aaaa-MM-ddTHH:mm:ssZ) são suportados.
source	string minLength: 2 maxLength: 100	Fonte do recurso.
status	string minLength: 0 maxLength: 100	Status do recurso.
type	string	Digite a que pertence.

BoundaryMetadataListResponse

Object

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

Name	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 null, não há páginas adicionais.
value	BoundaryMetadata[]	Lista de objetos solicitados.

BoundaryParentType

Enumeração

Tipo do progenitor a que pertence. ou seja, Field, SeasonalField, Zone, Prescription, PlantTissueAnalysis, ApplicationData, HarvestData, TillageData, PlantingData.

Valor	Description
Field
SeasonalField
Zone
Prescription
PlantTissueAnalysis
ApplicationData
PlantingData
TillageData
HarvestData

Error

Object

Um erro do serviço Azure AgPlatform.

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

ErrorResponse

Object

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.

Name	Tipo	Description
error	Error	Um erro do serviço Azure AgPlatform.
traceId	string	Id de rastreamento exclusivo.

GeoJsonObjectType

Enumeração

Tipo de objeto GeoJSON.

Valor	Description
Point
Polygon
MultiPolygon

InnerError

Object

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

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

Measure

Object

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

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

MultiPolygon

Object

Geometria multipolígono.

Name	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 lista de anéis lineares. Para polígonos com mais de um desses anéis, o primeiro DEVE ser o anel externo, e quaisquer outros DEVEM ser anéis internos.
type	string: MultiPolygon	Tipo de objeto GeoJSON.

Point

Object

Geometria de pontos.

Name	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

Object

Geometria do polígono.

Name	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 externo, e quaisquer outros DEVEM ser anéis internos.
type	string: Polygon	Tipo de objeto GeoJSON.

SearchBoundaryQuery

Object

Parâmetros SearchAllBoundaries e SearchBoundaries.

Name	Tipo	Default value	Description
ids	string[]		Ids do recurso.
intersectsWithGeometry	GeoJsonObject: MultiPolygon Point Polygon		GeoJSON (Para mais detalhes: https://geojson.org/). Nota: As coordenadas são esperadas no formato [Longitude, Latitude].
maxArea	number (double)		Área máxima do limite (inclusive).
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).
maxPageSize	integer (int32) minimum: 10 maximum: 1000	50	Número máximo de itens necessários (inclusive). Mínimo = 10, Máximo = 1000, Valor padrão = 50.
minArea	number (double)		Área mínima do limite (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.
parentIds	string[]		Ids pai do recurso.
parentType	BoundaryParentType		Tipo do progenitor a que pertence.
propertyFilters	string[]		Filtra em pares chave-valor dentro do objeto Properties. por exemplo, "{testKey} eq {testValue}".
skipToken	string		Ignorar token para obter o próximo conjunto de resultados.
statuses	string[]		Status do recurso.
type	string		Digite a que pertence.

Partilhar via

Boundaries - Search

Parâmetros do URI

Cabeçalho do Pedido

Corpo do Pedido

Respostas

Segurança

Authorization

Exemplos

Boundaries_Search

Pedido de amostra

Resposta da amostra

Definições

BoundaryMetadata

BoundaryMetadataListResponse

BoundaryParentType

Error

ErrorResponse

GeoJsonObjectType

InnerError

Measure

MultiPolygon

Point

Polygon

SearchBoundaryQuery