Compartilhar via


Boundaries - Search

Pesquise limites entre todas as partes por campos e geometria de interseção.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
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ê já tentou chamadas não autenticadas antes.

Corpo da solicitação

Nome Tipo Description
ids

string[]

IDs do recurso.

intersectsWithGeometry GeoJsonObject:

GeoJSON (para obter mais detalhes: https://geojson.org/). Observação: as coordenadas são esperadas no formato [Longitude, Latitude].

maxArea

number

Área máxima do limite (inclusivo).

maxCreatedDateTime

string

Data máxima de criação do recurso (inclusive).

maxLastModifiedDateTime

string

Data máxima da última modificação do recurso (inclusive).

maxPageSize

integer

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

minArea

number

Área mínima do limite (inclusivo).

minCreatedDateTime

string

Data mínima de criação do recurso (inclusive).

minLastModifiedDateTime

string

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 pai ao qual ele pertence.

propertyFilters

string[]

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

skipToken

string

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

statuses

string[]

Status do recurso.

type

string

Digite ao qual pertence.

Respostas

Nome Tipo Description
200 OK

BoundaryMetadataListResponse

Ê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ê já tentou chamadas não autenticadas antes.

Tipo: apiKey
Em: header

Exemplos

Solicitação de exemplo

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 de exemplo

{
  "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

Nome Description
BoundaryMetadata

Esquema de metadados de recursos de limite.

BoundaryMetadataListResponse

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

BoundaryParentType

Tipo do pai ao qual ele pertence. Ou seja, Field, SeasonalField, Zone, Prescription, PlantTissueAnalysis, ApplicationData, HarvestData, TillageData, PlantingData.

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 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 o documento de referência InnerError.

Measure

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

MultiPolygon

Geometria multiPolygon.

Point

Geometria de ponto.

Polygon

Geometria de polígono.

SearchBoundaryQuery

Parâmetros SearchAllBoundaries e SearchBoundaries.

BoundaryMetadata

Esquema de metadados de recursos de limite.

Nome Tipo Description
area

Measure

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

createdBy

string

Criado por ID de usuário/locatário.

createdDateTime

string

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

description

string

Descrição textual do recurso.

eTag

string

O valor ETag para implementar simultaneidade otimista.

id

string

ID de recurso exclusiva.

modifiedBy

string

Modificado por ID de usuário/locatário.

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.

parentId

string

Id do pai ao qual pertence.

parentType

BoundaryParentType

Tipo do pai ao qual ele pertence.

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: 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 (yyyy-MM-ddTHH:mm:ssZ).

source

string

Origem do recurso.

status

string

Status do recurso.

type

string

Digite ao qual pertence.

BoundaryMetadataListResponse

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

BoundaryMetadata[]

Lista de objetos solicitados.

BoundaryParentType

Tipo do pai ao qual ele pertence. Ou seja, Field, SeasonalField, Zone, Prescription, PlantTissueAnalysis, ApplicationData, HarvestData, TillageData, PlantingData.

Nome Tipo Description
ApplicationData

string

Field

string

HarvestData

string

PlantTissueAnalysis

string

PlantingData

string

Prescription

string

SeasonalField

string

TillageData

string

Zone

string

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. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o 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 Azure AgPlatform. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses 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

Tipo de objeto GeoJSON.

Nome Tipo Description
MultiPolygon

string

Point

string

Polygon

string

InnerError

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

Nome Tipo Description
code

string

Código de erro específico do 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 o documento de referência InnerError.

Measure

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

Nome Tipo Description
unit

string

Unidade de dados.

value

number

Valor de dados.

MultiPolygon

Geometria multiPolygon.

Nome Tipo Description
coordinates

number[]

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

Geometria de ponto.

Nome Tipo Description
coordinates

number[]

Obtém ou define a coordenada deste ponto. Deve ser uma matriz de elementos 2 ou 3 para um sistema 2D ou 3D.

type string:

Point

Tipo de objeto GeoJSON.

Polygon

Geometria de polígono.

Nome Tipo Description
coordinates

number[]

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.

SearchBoundaryQuery

Parâmetros SearchAllBoundaries e SearchBoundaries.

Nome Tipo Valor padrão Description
ids

string[]

IDs do recurso.

intersectsWithGeometry GeoJsonObject:

GeoJSON (para obter mais detalhes: https://geojson.org/). Observação: as coordenadas são esperadas no formato [Longitude, Latitude].

maxArea

number

Área máxima do limite (inclusivo).

maxCreatedDateTime

string

Data máxima de criação do recurso (inclusive).

maxLastModifiedDateTime

string

Data máxima da última modificação do recurso (inclusive).

maxPageSize

integer

50

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

minArea

number

Área mínima do limite (inclusivo).

minCreatedDateTime

string

Data mínima de criação do recurso (inclusive).

minLastModifiedDateTime

string

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 pai ao qual ele pertence.

propertyFilters

string[]

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

skipToken

string

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

statuses

string[]

Status do recurso.

type

string

Digite ao qual pertence.