WFS - Get Collections

Referencia

Service:: Maps Creator

API Version:: 2.0

Use para obtener descripciones de todas las colecciones de un conjunto de datos.

La Get Collections API es una solicitud HTTP GET que proporciona descripciones de todas las colecciones del conjunto de datos especificado.

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.

La API de descripción de colecciones proporciona descripciones de todas las colecciones de un conjunto de datos determinado. Para obtener más información, consulte Api del servicio de características web.

Enviar solicitud get collections

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
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 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.

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	CollectionsResponse	Aceptar
Other Status Codes	ErrorResponse	Se ha producido un error inesperado.

Seguridad

AADToken

Estos son los flujos de OAuth 2.0 de Microsoft Entra. 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. A cualquier usuario, grupo o entidad de servicio se le puede conceder acceso 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 el modelado de 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.

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

Scopes

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.

Type: apiKey
In: 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.

Type: apiKey
In: header

Ejemplos

GetCollections

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "ontology": "Facility-2.0",
  "collections": [
    {
      "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.",
      "links": [
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/definition?api-version=2.0",
          "rel": "describedBy",
          "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"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit?api-version=2.0",
          "rel": "self",
          "title": "Metadata catalogue for unit"
        }
      ]
    },
    {
      "name": "zone",
      "description": "A virtual area. ex, wifi zone, emergency assembly area. Zones can be used as destinations but not meant for through traffic.",
      "links": [
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/zone/definition?api-version=2.0",
          "rel": "describedBy",
          "title": "Metadata catalogue for zone"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/zone/items?api-version=2.0",
          "rel": "data",
          "title": "zone"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/zone?api-version=2.0",
          "rel": "self",
          "title": "Metadata catalogue for zone"
        }
      ]
    },
    {
      "name": "level",
      "description": "An indication of the extent and vertical position of a set of features.",
      "links": [
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/level/definition?api-version=2.0",
          "rel": "describedBy",
          "title": "Metadata catalogue for level"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/level/items?api-version=2.0",
          "rel": "data",
          "title": "level"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/level?api-version=2.0",
          "rel": "self",
          "title": "Metadata catalogue for level"
        }
      ]
    },
    {
      "name": "facility",
      "description": "Area of the site, building footprint etc.",
      "links": [
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/facility/definition?api-version=2.0",
          "rel": "describedBy",
          "title": "Metadata catalogue for facility"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/facility/items?api-version=2.0",
          "rel": "data",
          "title": "facility"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/facility?api-version=2.0",
          "rel": "self",
          "title": "Metadata catalogue for facility"
        }
      ]
    },
    {
      "name": "verticalPenetration",
      "description": "An area that, when used in a set, represents a method of navigating vertically between levels. It can be used to model stairs, elevators etc. Geometry can overlap units and other vertical penetration features.",
      "links": [
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/verticalPenetration/definition?api-version=2.0",
          "rel": "describedBy",
          "title": "Metadata catalogue for verticalPenetration"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/verticalPenetration/items?api-version=2.0",
          "rel": "data",
          "title": "verticalPenetration"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/verticalPenetration?api-version=2.0",
          "rel": "self",
          "title": "Metadata catalogue for verticalPenetration"
        }
      ]
    },
    {
      "name": "opening",
      "description": "A usually-traversable boundary between two units, or a unit and verticalPenetration.",
      "links": [
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/opening/definition?api-version=2.0",
          "rel": "describedBy",
          "title": "Metadata catalogue for opening"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/opening/items?api-version=2.0",
          "rel": "data",
          "title": "opening"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/opening?api-version=2.0",
          "rel": "self",
          "title": "Metadata catalogue for opening"
        }
      ]
    },
    {
      "name": "directoryInfo",
      "description": "Name, address, phone number, website, and hours of operation for a unit, facility, or an occupant of a unit or facility.",
      "links": [
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/directoryInfo/definition?api-version=2.0",
          "rel": "describedBy",
          "title": "Metadata catalogue for directoryInfo"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/directoryInfo/items?api-version=2.0",
          "rel": "data",
          "title": "directoryInfo"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/directoryInfo?api-version=2.0",
          "rel": "self",
          "title": "Metadata catalogue for directoryInfo"
        }
      ]
    },
    {
      "name": "pointElement",
      "description": "A point feature in a unit, such as a first aid kit or a sprinkler head.",
      "links": [
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/pointElement/definition?api-version=2.0",
          "rel": "describedBy",
          "title": "Metadata catalogue for pointElement"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/pointElement/items?api-version=2.0",
          "rel": "data",
          "title": "pointElement"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/pointElement?api-version=2.0",
          "rel": "self",
          "title": "Metadata catalogue for pointElement"
        }
      ]
    },
    {
      "name": "lineElement",
      "description": "A line feature in a unit, such as a dividing wall, window.",
      "links": [
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/lineElement/definition?api-version=2.0",
          "rel": "describedBy",
          "title": "Metadata catalogue for lineElement"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/lineElement/items?api-version=2.0",
          "rel": "data",
          "title": "lineElement"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/lineElement?api-version=2.0",
          "rel": "self",
          "title": "Metadata catalogue for lineElement"
        }
      ]
    },
    {
      "name": "areaElement",
      "description": "A polygon feature in a unit, such as an area open to below, an obstruction like an island in a unit.",
      "links": [
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/areaElement/definition?api-version=2.0",
          "rel": "describedBy",
          "title": "Metadata catalogue for areaElement"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/areaElement/items?api-version=2.0",
          "rel": "data",
          "title": "areaElement"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/areaElement?api-version=2.0",
          "rel": "self",
          "title": "Metadata catalogue for areaElement"
        }
      ]
    },
    {
      "name": "category",
      "description": "Category names. e.g. \"room.conference\". The isRoutable attribute puts a feature with that category on the routing graph. The routeThroughBehavior attribute determines whether a feature can be used for through traffic or not.",
      "links": [
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/category/definition?api-version=2.0",
          "rel": "describedBy",
          "title": "Metadata catalogue for category"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/category/items?api-version=2.0",
          "rel": "data",
          "title": "category"
        },
        {
          "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/category?api-version=2.0",
          "rel": "self",
          "title": "Metadata catalogue for category"
        }
      ]
    }
  ],
  "links": [
    {
      "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections?api-version=2.0",
      "rel": "self"
    }
  ]
}

Definiciones

Nombre	Description
Collection
CollectionsResponse
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
WFSEndpointLink	Vínculos a otros puntos de conexión de WFS

Collection

Nombre	Tipo	Description
description	string	una descripción de las características de la colección
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	La versión de ontología de este conjunto de datos.
title	string	título legible de la colección

CollectionsResponse

Nombre	Tipo	Description
collections	Collection[]	Todas las colecciones de un conjunto de datos determinado.
links	WFSEndpointLink[]	Vínculos a otros puntos de conexión de WFS.
ontology	string	La versión de ontología de este conjunto de datos.

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	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

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 identificador legible (por ejemplo, una entrada de menú) en el idioma indicado por el campo 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.

Share via