WFS - Get Collection Definition

Referencia

Servicio:: Maps Creator

Versión de la API:: 2.0

Use para obtener un modelo de datos detallado de una colección.

Nota

de retirada de Azure Maps Creator

El servicio de mapa interior de Azure Maps Creator ya está en desuso y se retirará el 30/9/25. Para más información, consulte anuncio de fin de ciclo de vida de Azure Maps Creator.

La API de Get Collection Definition es una solicitud de GET HTTP que proporciona un modelo de datos detallado de la colección especificada.

La API de WFS sigue el estándar de API open Geospatial Consortium de para características consultar conjuntos de datos de .

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, basado en un esquema común.

###Submit Obtener solicitud de definición de colección

GET https://{geography}.atlas.microsoft.com/wfs/datasets/{datasetId}/collections/{collectionId}/definition?api-version=2.0

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
collectionId	path	True	string	Identificador (nombre) de una colección específica
datasetId	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 creator de Azure Maps. Los valores válidos son nosotros y eu.
api-version	query	True	string	Número de versión de la API de Azure Maps.

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 Id. de Microsoft Entra. 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 la seguridad del identificador de Entra de Microsoft en Azure Maps, consulte los siguientes artículos de para obtener instrucciones.

Respuestas

Nombre	Tipo	Description
200 OK	CollectionDefinition	De acuerdo
Other Status Codes	ErrorResponse	Error inesperado.

Seguridad

AADToken

Estos son los flujos de Microsoft Entra OAuth 2.0. Cuando se empareja con acceso basado en rol de Azure control, se puede usar para controlar el acceso a las API REST de Azure Maps. Los controles de acceso basados en roles de Azure se usan para designar el acceso a una o varias cuentas de recursos o subrecursos de Azure Maps. Se puede conceder acceso a cualquier usuario, grupo o entidad de servicio a través de un rol integrado o de un rol personalizado compuesto por uno o varios permisos para las API REST de Azure Maps.

Para implementar escenarios, se recomienda ver 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 encabezado x-ms-client-id para indicar a qué recurso de Azure Maps solicita acceso la aplicación. Esto se puede adquirir desde la API de administración de Maps.

El 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 id. de Microsoft Entra. * 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, la CLI, los SDK de Azure o las API REST. * El uso de 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 la plataforma de identidad de Microsoft, consulte introducción a la plataforma de identidad de Microsoft.

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 Creación de una cuenta de Azure Maps en 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.

Para las aplicaciones expuestas públicamente, nuestra recomendación es usar las aplicaciones cliente confidenciales enfoque acceder a las API REST de Azure Maps para que la clave se pueda almacenar de forma segura.

Tipo: apiKey
En: query

SAS Token

Se crea un token de firma de acceso compartido 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 tiene autorización para acceder a los controles de acceso basados en rol de Azure y el control específico a 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 controle 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 cuenta de mapa de limitar el abuso de representación y renovar periódicamente el token de SAS.

Tipo: apiKey
En: header

Ejemplos

GetCollectionDefinition

Solicitud de ejemplo

HTTP

GET https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/definition?api-version=2.0

Respuesta de muestra

status code:: 200

{
  "idPrefix": "UNIT",
  "name": "unit",
  "description": "A physical and non-overlapping area which might be occupied and traversed by a navigating agent. Can be a hallway, a room, a courtyard, etc. It is surrounded by physical obstruction (wall), unless the isOpenArea attribute is equal to true, and one must add openings where the obstruction shouldn't be there. If isOpenArea attribute is equal to true, all the sides are assumed open to the surroundings and walls are to be added where needed. Walls for open areas are represented as a lineElement or areaElement with isObstruction equal to true.",
  "ontology": "Facility-2.0",
  "geometryType": "Polygon",
  "featureTypes": [],
  "properties": [
    {
      "name": "externalId",
      "required": false,
      "type": "text"
    },
    {
      "name": "originalId",
      "required": false,
      "type": "text"
    },
    {
      "name": "categoryId",
      "required": true,
      "type": {
        "featureId": "category"
      }
    },
    {
      "name": "isOpenArea",
      "required": false,
      "type": "boolean"
    },
    {
      "name": "navigableBy",
      "required": false,
      "type": {
        "array": {
          "enum": [
            "pedestrian",
            "wheelchair",
            "machine",
            "bicycle",
            "automobile",
            "hiredAuto",
            "bus",
            "railcar",
            "emergency",
            "ferry",
            "boat"
          ]
        }
      }
    },
    {
      "name": "isRoutable",
      "required": false,
      "type": "boolean"
    },
    {
      "name": "routeThroughBehavior",
      "required": false,
      "type": {
        "enum": [
          "disallowed",
          "allowed",
          "preferred"
        ]
      }
    },
    {
      "name": "nonPublic",
      "required": false,
      "type": "boolean"
    },
    {
      "name": "levelId",
      "required": true,
      "type": {
        "featureId": "level"
      }
    },
    {
      "name": "occupants",
      "required": false,
      "type": {
        "array": {
          "featureId": "directoryInfo"
        }
      }
    },
    {
      "name": "addressId",
      "required": false,
      "type": {
        "featureId": "directoryInfo"
      }
    },
    {
      "name": "addressRoomNumber",
      "required": false,
      "type": "text"
    },
    {
      "name": "name",
      "required": false,
      "type": "text"
    },
    {
      "name": "nameSubtitle",
      "required": false,
      "type": "text"
    },
    {
      "name": "nameAlt",
      "required": false,
      "type": "text"
    },
    {
      "name": "anchorPoint",
      "required": false,
      "type": {
        "geometry": [
          "Point"
        ],
        "isFragmented": false,
        "srid": 4326
      }
    }
  ],
  "links": [
    {
      "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/definition?api-version=2.0",
      "rel": "self",
      "title": "Metadata catalogue for unit"
    },
    {
      "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2.0",
      "rel": "data",
      "title": "unit"
    }
  ]
}

Definiciones

Nombre	Description
CollectionDefinition	colección de características de GeoJSON
DefinitionProperty
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
GeoJsonGeometryType	tipo de geometría devuelta
WFSEndpointLink	Vínculos a otros puntos de conexión de WFS

CollectionDefinition

Object

colección de características de GeoJSON

Nombre	Tipo	Description
description	string	describe la colección
featureTypes	string[]	tipo de características devueltas
geometryType	GeoJsonGeometryType	tipo de geometría devuelta
idPrefix	string	prefijo de la colección usada
links	WFSEndpointLink[]	Vínculos a otros puntos de conexión de WFS.
name	string	identificador de la colección usada, por ejemplo, en URI
ontology	string	Versión de ontología de este conjunto de datos.
properties	DefinitionProperty[]	atributos de la colección usada
title	string	título de la colección

DefinitionProperty

Object

Nombre	Tipo	Description
name	string	nombre del atributo
required	boolean	es el atributo obligatorio
type	object	tipo de atributo

ErrorAdditionalInfo

Object

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

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

GeoJsonGeometryType

Enumeración

tipo de geometría devuelta

Valor	Description
GeometryCollection	`GeoJSON GeometryCollection` geometría.
LineString	`GeoJSON LineString` geometría.
MultiLineString	`GeoJSON MultiLineString` geometría.
MultiPoint	`GeoJSON MultiPoint` geometría.
MultiPolygon	`GeoJSON MultiPolygon` geometría.
Point	`GeoJSON Point` geometría.
Polygon	`GeoJSON Polygon` geometría.

WFSEndpointLink

Object

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.

Compartir a través de

WFS - Get Collection Definition

Parámetros de identificador URI

Encabezado de la solicitud

Respuestas

Seguridad

AADToken

Notas

Ámbitos

subscription-key

SAS Token

Ejemplos

GetCollectionDefinition

Solicitud de ejemplo

Respuesta de muestra

Definiciones

CollectionDefinition

DefinitionProperty

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeoJsonGeometryType

WFSEndpointLink