Features - Get Items

Referência

Service:: Maps Creator

API Version:: 2023-03-01-preview

Utilize para obter uma lista detalhada das funcionalidades na coleção de funcionalidades especificada.

A API de Funcionalidades faz parte do Criador, o que permite desenvolver aplicações com base nos seus dados privados de mapa interior com Azure Maps API e SDK. As APIs GET de funcionalidades seguem a API open Geospatial Consortium - Features - Part 1: Core corrigendum standard para consultar Conjuntos de Dados. Os conjuntos de dados consistem em múltiplas coleções de funcionalidades, que são um agrupamento de funcionalidades definidas por um esquema comum.

Submeter Pedido de Obtenção de Itens

A Get Items API é um pedido HTTP GET que devolve as funcionalidades numa coleção de funcionalidades, conforme definido pelo fornecido collectionId no conjunto de dados especificado.

GET https://{geography}.atlas.microsoft.com/features/datasets/{datasetId}/collections/{collectionId}/items?api-version=2023-03-01-preview

With optional parameters:

GET https://{geography}.atlas.microsoft.com/features/datasets/{datasetId}/collections/{collectionId}/items?api-version=2023-03-01-preview&limit={limit}&bbox={bbox}&filter={filter}

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
collectionId	path	True	string	Identificador (nome) de uma coleção específica.
datasetId	path	True	string	O identificador do conjunto de dados a partir do qual pode consultar.
geography	path	True	string	Este parâmetro especifica onde está localizado o recurso Azure Maps Creator. Os valores válidos somos nós e eu.
api-version	query	True	string	Número da versão da API Azure Maps.
bbox	query		number[]	Só estão selecionadas as funcionalidades que têm uma geometria que intersecciona a caixa delimitadora fornecida. Canto inferior esquerdo, coordenada do eixo 1 * Canto inferior esquerdo, eixo de coordenadas 2 * Canto superior direito, eixo coordenada 1 * Canto superior direito, eixo de coordenadas 2 O sistema de referência coordenada dos valores é longitude/latitude WGS84 (http://www.opengis.net/def/crs/OGC/1.3/CRS84) a menos que seja especificado um sistema de referência de coordenadas diferente no parâmetro `bbox-crs`. Para longitude/latitude WGS84, os valores são, na maioria dos casos, a sequência de longitude mínima, latitude mínima, longitude máxima e latitude máxima. No entanto, nos casos em que a caixa abrange o antimeridiano, o primeiro valor (extremidade da caixa mais oeste) é maior do que o terceiro valor (margem da caixa mais a leste).
filter	query		string	Filtrar expressão para procurar funcionalidades com valores de propriedade específicos numa determinada coleção. Só são suportadas propriedades de funcionalidades do tipo escalar e operador de igual. Este é um parâmetro especial em que o nome do parâmetro é um nome de propriedade sensível às maiúsculas e minúsculas. O esquema para este parâmetro é {property name}={property value}. A menos que "filter" seja um dos nomes de propriedade na coleção, "filter" não deve ser utilizado como um nome de parâmetro. Para procurar funcionalidades com o valor da propriedade "nome" "21N13", utilize "name=21N13". São suportados vários filtros e devem ser representados como vários parâmetros de consulta. Por exemplo, =&= Os valores da cadeia são sensíveis às maiúsculas e minúsculas.
limit	query		integer int32	O parâmetro de limite opcional limita o número de funcionalidades apresentadas no documento de resposta. Apenas são contadas as funcionalidades que estão no primeiro nível da coleção no documento de resposta. Os objetos aninhados contidos nas funcionalidades explicitamente pedidas não devem ser contabilizados. Mínimo = 1 * Máximo = 500 * Predefinição = 10

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
x-ms-client-id		string	Especifica a conta que se destina à utilização em conjunto com o modelo de segurança Microsoft Entra ID. Representa um ID exclusivo para a conta Azure Maps e pode ser obtido a partir da API de Conta do plano de gestão Azure Maps. Para utilizar Microsoft Entra ID segurança no Azure Maps consulte os seguintes artigos para obter orientações.

Respostas

Name	Tipo	Description
200 OK	ExtendedGeoJsonFeatureCollection	Ok
Other Status Codes	ErrorResponse	Ocorreu um erro inesperado.

Segurança

AADToken

Estes são os Fluxos OAuth2 do Azure Active Directory . Quando emparelhado com o controlo de acesso baseado em funções do Azure, pode ser utilizado para controlar o acesso às APIs REST Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais Azure Maps conta de recursos ou sub-recursos. Qualquer utilizador, grupo ou principal de serviço pode ter acesso através de uma função incorporada ou de uma função personalizada composta por uma ou mais permissões para Azure Maps APIs REST.

Para implementar cenários, recomendamos que veja os conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações através de objetos com capacidade de controlo de acesso em APIs e âmbitos específicos.

Notas

Esta definição de segurança requer a utilização do x-ms-client-id cabeçalho para indicar a que recurso Azure Maps a aplicação está a pedir acesso. Isto pode ser adquirido a partir da API de gestão do Maps.

O Authorization URL é específico da instância da cloud pública do Azure. As clouds soberanas têm URLs de Autorização exclusivos e configurações do Azure Active Directory. * O controlo de acesso baseado em funções do Azure está configurado a partir do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * A utilização do SDK Web Azure Maps permite a configuração baseada na configuração de uma aplicação para vários casos de utilização.

Atualmente, o Azure Active Directory v1.0 ou v2.0 suporta o Trabalho, a Escola e os Convidados, mas não suporta contas Pessoais.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Esta é uma chave partilhada que é aprovisionada ao criar um recurso de Azure Maps através do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com esta chave, qualquer aplicação está autorizada a aceder a todas as APIs REST. Por outras palavras, estas podem atualmente ser tratadas como chaves mestras da conta para a qual são emitidas.

Para aplicações expostas publicamente, a nossa recomendação é utilizar o acesso servidor a servidor das APIs REST Azure Maps onde esta chave pode ser armazenada de forma segura.

Type: apiKey
In: query

SAS Token

Este é um token de assinatura de acesso partilhado criado a partir da operação List SAS no recurso de Azure Maps através do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com este token, qualquer aplicação está autorizada a aceder com controlos de acesso baseados em funções do Azure e controlo detalhado para a expiração, taxa e regiões de utilização para o token específico. Por outras palavras, o Token de SAS pode ser utilizado para permitir que as aplicações controlem o acesso de uma forma mais segura do que a chave partilhada.

Para aplicações expostas publicamente, a nossa recomendação é configurar uma lista específica de origens permitidas no recurso da conta de Mapa para limitar o abuso de composição e renovar regularmente o Token de SAS.

Type: apiKey
In: header

Exemplos

GetFeatures

Sample Request

HTTP

GET https://us.atlas.microsoft.com/features/datasets/018fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2023-03-01-preview&limit=1&bbox=-122,47,-120,46

Sample Response

Status code:: 200

{
  "type": "FeatureCollection",
  "ontology": "facility-2.0",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              139.6330405782921,
              35.45768668610856
            ],
            [
              139.63296283234274,
              35.45778390425868
            ],
            [
              139.63308672404617,
              35.45785022906202
            ],
            [
              139.6331451691671,
              35.45777714569986
            ],
            [
              139.6331274703629,
              35.45776767074717
            ],
            [
              139.63314677109963,
              35.45774353588138
            ],
            [
              139.6330405782921,
              35.45768668610856
            ]
          ]
        ]
      },
      "properties": {
        "originalId": "ddbbb583-4621-4e11-8859-299d1057e843",
        "categoryId": "CTG10",
        "isOpenArea": false,
        "isRoutable": false,
        "levelId": "LVL18",
        "occupants": [],
        "addressId": "DIR16",
        "name": "21N13"
      },
      "id": "UNIT39"
    }
  ],
  "numberReturned": 1,
  "links": [
    {
      "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?limit=1",
      "rel": "self",
      "title": "Unit"
    },
    {
      "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit",
      "rel": "collection",
      "title": "Information for unit collection"
    },
    {
      "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?n=PMRG4ZLYOQRDUMJMEJYHEZLWEI5C2ML5&limit=1",
      "rel": "next",
      "title": "Next page"
    }
  ]
}

Definições

Name	Description
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
ExtendedGeoJsonFeatureCollection	Um tipo de objeto válido `GeoJSON FeatureCollection` expandido com numberReturned e matriz de ligações. Consulte RFC 7946 para obter detalhes.
Feature	Um tipo de objeto válido `GeoJSON Feature` . Consulte RFC 7946 para obter detalhes.
FeaturesEndpointLink	Ligações para outros pontos finais de Funcionalidades. Para obter mais detalhes sobre as relações de ligação, visite a norma OGC API - Features - Part 1 (API OGC – Funcionalidades – Parte 1 ).
GeoJsonGeometry	Um objeto de geometria válido `GeoJSON` . O tipo tem de ser um dos sete tipos de geometria GeoJSON válidos : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon e GeometryCollection. Consulte RFC 7946 para obter detalhes.
GeoJsonGeometryCollection	Um tipo de objeto válido `GeoJSON GeometryCollection` . Consulte RFC 7946 para obter detalhes.
GeoJsonLineString	Um tipo de geometria válido `GeoJSON LineString` . Consulte RFC 7946 para obter detalhes.
GeoJsonMultiLineString	Um tipo de geometria válido `GeoJSON MultiLineString` . Consulte RFC 7946 para obter detalhes.
GeoJsonMultiPoint	Um tipo de geometria válido `GeoJSON MultiPoint` . Consulte RFC 7946 para obter detalhes.
GeoJsonMultiPolygon	Um tipo de objeto válido `GeoJSON MultiPolygon` . Consulte RFC 7946 para obter detalhes.
GeoJsonObjectType	Especifica o `GeoJSON` tipo: FeatureCollection.
GeoJsonPoint	Um tipo de geometria válido `GeoJSON Point` . Consulte RFC 7946 para obter detalhes.
GeoJsonPolygon	Um tipo de geometria válido `GeoJSON Polygon` . Consulte RFC 7946 para obter detalhes.

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informações adicionais.

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta a erros

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

ExtendedGeoJsonFeatureCollection

Um tipo de objeto válido GeoJSON FeatureCollection expandido com numberReturned e matriz de ligações. Consulte RFC 7946 para obter detalhes.

Name	Tipo	Description
features	Feature[]	Contém uma lista de objetos válidos `GeoJSON Feature` .
links	FeaturesEndpointLink[]	Ligações para outros pontos finais de Funcionalidades.
numberReturned	integer	Número de funcionalidades devolvidas.
ontology	string	A versão da onologia deste conjunto de dados.
type	GeoJsonObjectType	Especifica o `GeoJSON` tipo: FeatureCollection.

Feature

Um tipo de objeto válido GeoJSON Feature . Consulte RFC 7946 para obter detalhes.

Name	Tipo	Description
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	Um objeto de geometria válido `GeoJSON` . O tipo tem de ser um dos sete tipos de geometria GeoJSON válidos : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon e GeometryCollection. Consulte RFC 7946 para obter detalhes.
id	string	Identificador sensível a maiúsculas e minúsculas de uma funcionalidade específica.
properties	object	As propriedades podem conter metadados adicionais sobre o `Feature` e são definidos pela API de Definição de Coleção GET. O valor pode ser qualquer objeto JSON ou um valor nulo JSON, mas tenha em atenção que as propriedades da funcionalidade não definidas na definição da coleção serão ignoradas.
type	string	Especifica o `GeoJSON` tipo: Funcionalidade

FeaturesEndpointLink

Ligações para outros pontos finais de Funcionalidades. Para obter mais detalhes sobre as relações de ligação, visite a norma OGC API - Features - Part 1 (API OGC – Funcionalidades – Parte 1 ).

Name	Tipo	Description
href	string	O destino da ligação.
rel	string	O tipo de relação.
title	string	Utilizado para etiquetar o destino de uma ligação para que possa ser utilizado como um identificador legível por humanos (por exemplo, uma entrada de menu) no idioma indicado pelo campo de cabeçalho Idioma de Conteúdo (se estiver presente).

GeoJsonGeometry

Um objeto de geometria válido GeoJSON . O tipo tem de ser um dos sete tipos de geometria GeoJSON válidos : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon e GeometryCollection. Consulte RFC 7946 para obter detalhes.

Name	Tipo	Description
type	GeoJsonObjectType	Especifica o `GeoJSON` tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonGeometryCollection

Um tipo de objeto válido GeoJSON GeometryCollection . Consulte RFC 7946 para obter detalhes.

Name	Tipo	Description
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	Contém uma lista de objetos de geometria válidos `GeoJSON` . Tenha em atenção que as coordenadas em GeoJSON estão por ordem x, y (longitude, latitude).
type	string: GeometryCollection	Especifica o `GeoJSON` tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonLineString

Um tipo de geometria válido GeoJSON LineString . Consulte RFC 7946 para obter detalhes.

Name	Tipo	Description
coordinates	number[]	Coordenadas para a `GeoJson LineString` geometria.
type	string: LineString	Especifica o `GeoJSON` tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonMultiLineString

Um tipo de geometria válido GeoJSON MultiLineString . Consulte RFC 7946 para obter detalhes.

Name	Tipo	Description
coordinates	number[]	Coordenadas para a `GeoJson MultiLineString` geometria.
type	string: MultiLineString	Especifica o `GeoJSON` tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonMultiPoint

Um tipo de geometria válido GeoJSON MultiPoint . Consulte RFC 7946 para obter detalhes.

Name	Tipo	Description
coordinates	number[]	Coordenadas para a `GeoJson MultiPoint` geometria.
type	string: MultiPoint	Especifica o `GeoJSON` tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonMultiPolygon

Um tipo de objeto válido GeoJSON MultiPolygon . Consulte RFC 7946 para obter detalhes.

Name	Tipo	Description
coordinates	number[]	Contém uma lista de objetos válidos `GeoJSON Polygon` . Tenha em atenção que as coordenadas em GeoJSON estão por ordem x, y (longitude, latitude).
type	string: MultiPolygon	Especifica o `GeoJSON` tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonObjectType

Especifica o GeoJSON tipo: FeatureCollection.

Name	Tipo	Description
FeatureCollection	string	`GeoJSON FeatureCollection` objeto.

GeoJsonPoint

Um tipo de geometria válido GeoJSON Point . Consulte RFC 7946 para obter detalhes.

Name	Tipo	Description
coordinates	number[]	A `Position` é uma matriz de números com dois ou mais elementos. Os dois primeiros elementos são longitude e latitude, precisamente por essa ordem. Altitude/Elevação é um terceiro elemento opcional. Consulte RFC 7946 para obter detalhes.
type	string: Point	Especifica o `GeoJSON` tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonPolygon

Um tipo de geometria válido GeoJSON Polygon . Consulte RFC 7946 para obter detalhes.

Name	Tipo	Description
coordinates	number[]	Coordenadas para o `GeoJson Polygon` tipo de geometria.
type	string: Polygon	Especifica o `GeoJSON` tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

Partilhar via