WFS - Get Features
Use para obtener una lista detallada de las características de una colección.
La Get Features
API es una solicitud HTTP GET
que devuelve una lista detallada de características de la colección especificada.
La API de WFS sigue el estándar open Geospatial Consortium API para características para consultar conjuntos de datos.
Un conjunto de datos consta de varias colecciones de características. Una colección de características es una colección de características de un tipo similar, basándose en un esquema común.
Enviar solicitud de obtención de características
GET https://{geography}.atlas.microsoft.com/wfs/datasets/{datasetId}/collections/{collectionId}/items?api-version=2.0
GET https://{geography}.atlas.microsoft.com/wfs/datasets/{datasetId}/collections/{collectionId}/items?api-version=2.0&limit={limit}&bbox={bbox}&filter={filter}
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
collection
|
path | True |
string |
Identificador (nombre) de una colección específica |
dataset
|
path | True |
string |
Identificador del conjunto de datos desde el que se va a consultar. |
geography
|
path | True |
string |
Este parámetro especifica dónde se encuentra el recurso Azure Maps Creator. Los valores válidos son nosotros y eu. |
api-version
|
query | True |
string |
Número de versión de la API de Azure Maps. |
bbox
|
query |
number[] |
Solo se seleccionan las características que tienen una geometría que interseca el rectángulo de selección proporcionado.
|
|
filter
|
query |
string |
Expresión de filtro para buscar características con valores de propiedad específicos en una colección determinada. Solo se admiten las propiedades de características del tipo escalar y del operador equals. Se trata de un parámetro especial donde el nombre del parámetro es un nombre de propiedad que distingue mayúsculas de minúsculas. El esquema de este parámetro es {nombre de propiedad}={valor de propiedad}. A menos que "filter" sea uno de los nombres de propiedad de la colección, "filter" no se debe usar como nombre de parámetro. Para buscar características con el valor de propiedad "name" "21N13", use "name=21N13". Se admiten varios filtros y se deben representar como varios parámetros de consulta. Por ejemplo, =&= los valores de cadena distinguen mayúsculas de minúsculas. |
|
limit
|
query |
integer |
El parámetro de límite opcional limita el número de características que se presentan en el documento de respuesta. Solo se cuentan las características que se encuentran en el primer nivel de la colección del documento de respuesta. No se contarán los objetos anidados contenidos en las características solicitadas explícitamente.
|
Encabezado de la solicitud
Nombre | Requerido | Tipo | Description |
---|---|---|---|
x-ms-client-id |
string |
Especifica qué cuenta está pensada para su uso junto con el modelo de seguridad de Microsoft Entra ID. Representa un identificador único para la cuenta de Azure Maps y se puede recuperar de la API de cuenta del plano de administración de Azure Maps. Para usar Microsoft Entra ID seguridad en Azure Maps consulte los siguientes artículos para obtener instrucciones. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
Aceptar |
|
Other Status Codes |
Se ha producido un error inesperado. |
Seguridad
AADToken
Estos son los Microsoft Entra flujos de OAuth 2.0. Cuando se empareja con el control de acceso basado en rol de Azure, se puede usar para controlar el acceso a Azure Maps API REST. Los controles de acceso basados en roles de Azure se usan para designar el acceso a una o varias Azure Maps cuenta de recursos o subrecursos. Se puede conceder acceso a cualquier usuario, grupo o entidad de servicio a través de un rol integrado o un rol personalizado compuesto por uno o varios permisos para Azure Maps API REST.
Para implementar escenarios, se recomienda ver los conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para modelar aplicaciones a través de objetos capaces de controlar el acceso en determinadas API y ámbitos.
Notas
- Esta definición de seguridad requiere el uso del
x-ms-client-id
encabezado para indicar a qué recurso Azure Maps la aplicación solicita acceso. Esto se puede adquirir desde la API de administración de Maps.
Authorization URL
es específico de la instancia de nube pública de Azure. Las nubes soberanas tienen direcciones URL de autorización únicas y configuraciones de Microsoft Entra ID.
* El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST.
* El uso del SDK web de Azure Maps permite la configuración basada en la configuración de una aplicación para varios casos de uso.
- Para obtener más información sobre Plataforma de identidad de Microsoft, consulte Plataforma de identidad de Microsoft información general.
Tipo:
oauth2
Flujo:
implicit
Dirección URL de autorización:
https://login.microsoftonline.com/common/oauth2/authorize
Ámbitos
Nombre | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Se trata de una clave compartida que se aprovisiona al crear una cuenta de Azure Maps en el Azure Portal o mediante PowerShell, la CLI, los SDK de Azure o la API REST.
Con esta clave, cualquier aplicación puede acceder a todas las API REST. En otras palabras, esta clave se puede usar como clave maestra en la cuenta en la que se emiten.
En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es usar el enfoque de aplicaciones cliente confidenciales para acceder a Azure Maps API REST para que la clave se pueda almacenar de forma segura.
Tipo:
apiKey
En:
query
SAS Token
Se trata de un token de firma de acceso compartido que se crea a partir de la operación List SAS en el recurso de Azure Maps a través del plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST.
Con este token, cualquier aplicación está autorizada para acceder a los controles de acceso basado en roles de Azure y al control específico de la expiración, la tasa y las regiones de uso para el token determinado. Es decir, el token de SAS se puede usar para permitir que las aplicaciones controlen el acceso de forma más segura que la clave compartida.
En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es configurar una lista específica de orígenes permitidos en el recurso de la cuenta de mapa para limitar la representación de abusos y renovar periódicamente el token de SAS.
Tipo:
apiKey
En:
header
Ejemplos
GetFeatures
Solicitud de ejemplo
GET https://us.atlas.microsoft.com/wfs/datasets/018fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2.0&limit=1&bbox=-122,47,-120,46
Respuesta de muestra
{
"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,
"navigableBy": [
"pedestrian"
],
"isRoutable": false,
"routeThroughBehavior": "allowed",
"nonPublic": false,
"levelId": "LVL18",
"occupants": [],
"addressId": "DIR16",
"addressRoomNumber": "",
"name": "21N13",
"nameSubtitle": "",
"nameAlt": ""
},
"id": "UNIT39",
"featureType": ""
}
],
"numberReturned": 1,
"links": [
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2.0&limit=1",
"rel": "self"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit?api-version=2.0",
"rel": "data"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?n=PMRG4ZLYOQRDUMJMEJYHEZLWEI5C2ML5&api-version=2.0&limit=1",
"rel": "next"
}
]
}
Definiciones
Nombre | Description |
---|---|
Error |
Información adicional sobre el error de administración de recursos. |
Error |
Detalle del error. |
Error |
Respuesta de error |
Extended |
Tipo de objeto válido |
Geo |
Tipo de objeto válido |
Geo |
Objeto geometry válido |
Geo |
Tipo de objeto válido |
Geo |
Un tipo de geometría válido |
Geo |
Un tipo de geometría válido |
Geo |
Un tipo de geometría válido |
Geo |
Tipo de objeto válido |
Geo |
Especifica el |
Geo |
Un tipo de geometría válido |
Geo |
Un tipo de geometría válido |
WFSEndpoint |
Vínculos a otros puntos de conexión de WFS |
ErrorAdditionalInfo
Información adicional sobre el error de administración de recursos.
Nombre | Tipo | Description |
---|---|---|
info |
object |
Información adicional. |
type |
string |
Tipo de información adicional. |
ErrorDetail
Detalle del error.
Nombre | Tipo | Description |
---|---|---|
additionalInfo |
Información adicional del error. |
|
code |
string |
Código de error. |
details |
Los detalles del error. |
|
message |
string |
El mensaje de error. |
target |
string |
Destino del error. |
ErrorResponse
Respuesta de error
Nombre | Tipo | Description |
---|---|---|
error |
Objeto de error. |
ExtendedGeoJsonFeatureCollection
Tipo de objeto válido GeoJSON FeatureCollection
extendido con numberReturned y la matriz de vínculos. Consulte RFC 7946 para obtener más información.
Nombre | Tipo | Description |
---|---|---|
features |
Contiene una lista de objetos válidos |
|
links |
Vínculos a otros puntos de conexión de WFS. |
|
numberReturned |
integer |
Número de características devueltas. |
ontology |
string |
Versión de ontología de este conjunto de datos. |
type |
Especifica el |
GeoJsonFeature
Tipo de objeto válido GeoJSON Feature
. Consulte RFC 7946 para obtener más información.
Nombre | Tipo | Description |
---|---|---|
featureType |
string |
Tipo de la característica. El valor depende del modelo de datos del que forma parte la característica actual. Algunos modelos de datos pueden tener un valor vacío. |
geometry | GeoJsonGeometry: |
Objeto geometry válido |
id |
string |
Identificador de la característica. |
type |
string:
Feature |
Especifica el tipo |
GeoJsonGeometry
Objeto geometry válido GeoJSON
. El tipo debe ser uno de los siete tipos de geometría GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon y GeometryCollection. Consulte RFC 7946 para obtener más información.
Nombre | Tipo | Description |
---|---|---|
type |
Especifica el tipo |
GeoJsonGeometryCollection
Tipo de objeto válido GeoJSON GeometryCollection
. Consulte RFC 7946 para obtener más información.
Nombre | Tipo | Description |
---|---|---|
geometries | GeoJsonGeometry[]: |
Contiene una lista de objetos geometry válidos |
type |
string:
Geometry |
Especifica el tipo |
GeoJsonLineString
Un tipo de geometría válido GeoJSON LineString
. Consulte RFC 7946 para obtener más información.
Nombre | Tipo | Description |
---|---|---|
coordinates |
number[] |
Coordenadas de la |
type |
string:
Line |
Especifica el tipo |
GeoJsonMultiLineString
Un tipo de geometría válido GeoJSON MultiLineString
. Consulte RFC 7946 para obtener más información.
Nombre | Tipo | Description |
---|---|---|
coordinates |
number[] |
Coordenadas de la |
type |
string:
Multi |
Especifica el tipo |
GeoJsonMultiPoint
Un tipo de geometría válido GeoJSON MultiPoint
. Consulte RFC 7946 para obtener más información.
Nombre | Tipo | Description |
---|---|---|
coordinates |
number[] |
Coordenadas de la |
type |
string:
Multi |
Especifica el tipo |
GeoJsonMultiPolygon
Tipo de objeto válido GeoJSON MultiPolygon
. Consulte RFC 7946 para obtener más información.
Nombre | Tipo | Description |
---|---|---|
coordinates |
number[] |
Contiene una lista de objetos válidos |
type |
string:
Multi |
Especifica el tipo |
GeoJsonObjectType
Especifica el GeoJSON
tipo: FeatureCollection.
Nombre | Tipo | Description |
---|---|---|
FeatureCollection |
string |
Objeto |
GeoJsonPoint
Un tipo de geometría válido GeoJSON Point
. Consulte RFC 7946 para obtener más información.
Nombre | Tipo | Description |
---|---|---|
coordinates |
number[] |
Un |
type |
string:
Point |
Especifica el tipo |
GeoJsonPolygon
Un tipo de geometría válido GeoJSON Polygon
. Consulte RFC 7946 para obtener más información.
Nombre | Tipo | Description |
---|---|---|
coordinates |
number[] |
Coordenadas para el |
type |
string:
Polygon |
Especifica el tipo |
WFSEndpointLink
Vínculos a otros puntos de conexión de WFS
Nombre | Tipo | Description |
---|---|---|
href |
string |
Destino del vínculo. |
hreflang |
string |
Sugerencia que indica cuál debe ser el idioma del resultado de la desreferenciación del vínculo. |
rel |
string |
Tipo de relación. |
title |
string |
Se usa para etiquetar el destino de un vínculo de modo que se pueda usar como un identificador legible (por ejemplo, una entrada de menú) en el idioma indicado por el campo de encabezado Content-Language (si está presente). |
type |
string |
Sugerencia que indica cuál debe ser el tipo de medio del resultado de la desreferenciación del vínculo. |