Features - Get Collections

Referencia

Service:: Maps Creator

API Version:: 2023-03-01-preview

Use para obtener una lista de colecciones de características.

La API de características forma parte de Creator, lo que permite desarrollar aplicaciones basadas en los datos privados del mapa interior mediante Azure Maps API y SDK. Características GET API siguen open Geospatial Consortium API - Features - Part 1: Core corrigendum standard to query Datasets. Los conjuntos de datos constan de varias colecciones de características, que son una agrupación de características definidas por un esquema común.

Enviar solicitud get collections

La Get Collections API es una solicitud HTTP GET que devuelve una lista de todas las colecciones de características de un conjunto de datos.

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

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

Seguridad

AADToken

Estos son los flujos de OAuth2 de Azure Active Directory . 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 Azure Active Directory. * 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.

Actualmente, Azure Active Directory v1.0 o v2.0 admite Work, School e Invitados, pero no admite cuentas personales.

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 un recurso de Azure Maps a través del plano de administración de Azure mediante Azure Portal, PowerShell, la CLI, los SDK de Azure o las API REST.

Con esta clave, cualquier aplicación está autorizada para acceder a todas las API REST. En otras palabras, estos se pueden tratar actualmente como claves maestras para la cuenta para la que se emiten.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es usar el acceso de servidor a servidor de Azure Maps API REST en las que esta clave se puede almacenar de forma segura.

Type: apiKey
In: 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 está autorizada para acceder a los controles de acceso basado en rol de Azure y el control específico a la expiración, la tasa y las regiones de uso para el token determinado. En otras palabras, 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 asignación para limitar la representación del abuso y renovar periódicamente el token de SAS.

Type: apiKey
In: header

Ejemplos

GetCollections

Sample Request

HTTP

GET https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections?api-version=2023-03-01-preview

Sample Response

Status code:: 200

{
  "ontology": "facility-2.0",
  "collections": [
    {
      "id": "unit",
      "title": "Unit",
      "itemType": "feature",
      "description": "The unit feature class defines a physical and non-overlapping area that can be occupied and traversed by a navigating agent. A unit can be a hallway, a room, a courtyard, and so on.",
      "links": [
        {
          "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/definition",
          "rel": "describedBy",
          "title": "Metadata catalogue for unit"
        },
        {
          "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items",
          "rel": "items",
          "title": "unit"
        },
        {
          "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit",
          "rel": "self",
          "title": "Metadata catalogue for unit"
        }
      ]
    },
    {
      "id": "zone",
      "title": "Zone",
      "itemType": "feature",
      "description": "The zone feature class defines a virtual area, like a WiFi zone or emergency assembly area. Zones can be used as destinations but are not meant for through traffic.",
      "links": [
        {
          "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/zone/definition",
          "rel": "describedBy",
          "title": "Metadata catalogue for zone"
        },
        {
          "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/zone/items",
          "rel": "items",
          "title": "zone"
        },
        {
          "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/zone",
          "rel": "self",
          "title": "Metadata catalogue for zone"
        }
      ]
    },
    {
      "id": "level",
      "title": "Level",
      "itemType": "feature",
      "description": "The level class feature defines an area of a building at a set elevation. For example, the floor of a building, which contains a set of features, such as units.",
      "links": [
        {
          "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/level/definition",
          "rel": "describedBy",
          "title": "Metadata catalogue for level"
        },
        {
          "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/level/items",
          "rel": "items",
          "title": "level"
        },
        {
          "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/level",
          "rel": "self",
          "title": "Metadata catalogue for level"
        }
      ]
    },
    {
      "id": "facility",
      "title": "Facility",
      "itemType": "feature",
      "description": "The facility feature class defines the area of the site, building footprint, and so on.",
      "links": [
        {
          "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/facility/definition",
          "rel": "describedBy",
          "title": "Metadata catalogue for facility"
        },
        {
          "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/facility/items",
          "rel": "items",
          "title": "facility"
        },
        {
          "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/facility",
          "rel": "self",
          "title": "Metadata catalogue for facility"
        }
      ]
    },
    {
      "id": "verticalPenetration",
      "title": "Vertical Penetration",
      "itemType": "feature",
      "description": "The verticalPenetration class feature defines an area that, when used in a set, represents a method of navigating vertically between levels. It can be used to model stairs, elevators, and so on. Geometry can overlap units and other vertical penetration features.",
      "links": [
        {
          "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/verticalPenetration/definition",
          "rel": "describedBy",
          "title": "Metadata catalogue for verticalPenetration"
        },
        {
          "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/verticalPenetration/items",
          "rel": "items",
          "title": "verticalPenetration"
        },
        {
          "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/verticalPenetration",
          "rel": "self",
          "title": "Metadata catalogue for verticalPenetration"
        }
      ]
    },
    {
      "id": "opening",
      "title": "Opening",
      "itemType": "feature",
      "description": "The opening class feature defines a traversable boundary between two units, or a unit and verticalPenetration.",
      "links": [
        {
          "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/opening/definition",
          "rel": "describedBy",
          "title": "Metadata catalogue for opening"
        },
        {
          "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/opening/items",
          "rel": "items",
          "title": "opening"
        },
        {
          "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/opening",
          "rel": "self",
          "title": "Metadata catalogue for opening"
        }
      ]
    },
    {
      "id": "directoryInfo",
      "title": "Directory Info",
      "itemType": "feature",
      "description": "The directoryInfo object class feature defines the 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/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/directoryInfo/definition",
          "rel": "describedBy",
          "title": "Metadata catalogue for directoryInfo"
        },
        {
          "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/directoryInfo/items",
          "rel": "items",
          "title": "directoryInfo"
        },
        {
          "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/directoryInfo",
          "rel": "self",
          "title": "Metadata catalogue for directoryInfo"
        }
      ]
    },
    {
      "id": "pointElement",
      "title": "Point Element",
      "itemType": "feature",
      "description": "A point feature in a unit, such as a first aid kit or a sprinkler head.",
      "links": [
        {
          "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/pointElement/definition",
          "rel": "describedBy",
          "title": "Metadata catalogue for pointElement"
        },
        {
          "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/pointElement/items",
          "rel": "items",
          "title": "pointElement"
        },
        {
          "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/pointElement",
          "rel": "self",
          "title": "Metadata catalogue for pointElement"
        }
      ]
    },
    {
      "id": "lineElement",
      "title": "Line Element",
      "itemType": "feature",
      "description": "A line feature in a unit, such as a dividing wall, window.",
      "links": [
        {
          "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/lineElement/definition",
          "rel": "describedBy",
          "title": "Metadata catalogue for lineElement"
        },
        {
          "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/lineElement/items",
          "rel": "items",
          "title": "lineElement"
        },
        {
          "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/lineElement",
          "rel": "self",
          "title": "Metadata catalogue for lineElement"
        }
      ]
    },
    {
      "id": "areaElement",
      "title": "Area Element",
      "itemType": "feature",
      "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/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/areaElement/definition",
          "rel": "describedBy",
          "title": "Metadata catalogue for areaElement"
        },
        {
          "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/areaElement/items",
          "rel": "items",
          "title": "areaElement"
        },
        {
          "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/areaElement",
          "rel": "self",
          "title": "Metadata catalogue for areaElement"
        }
      ]
    },
    {
      "id": "category",
      "title": "Category",
      "itemType": "feature",
      "description": "The Category feature class defines Category names. For example: \"room.conference\".",
      "links": [
        {
          "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/category/definition",
          "rel": "describedBy",
          "title": "Metadata catalogue for category"
        },
        {
          "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/category/items",
          "rel": "items",
          "title": "category"
        },
        {
          "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/category",
          "rel": "self",
          "title": "Metadata catalogue for category"
        }
      ]
    }
  ],
  "links": [
    {
      "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections",
      "rel": "self",
      "title": "Information about the feature collections"
    }
  ]
}

Definiciones

Nombre	Description
CollectionResult	Respuesta después de una solicitud correcta para obtener una colección.
CollectionsResult	Respuesta después de una solicitud correcta para enumerar colecciones.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
FeaturesEndpointLink	Vínculos a otros puntos de conexión de características. Para obtener más información sobre las relaciones de vínculo, visite la API de OGC - Características - Parte 1 estándar.

CollectionResult

Respuesta después de una solicitud correcta para obtener una colección.

Nombre	Tipo	Description
description	string	Descripción de las características de la colección.
id	string	Identificador de la colección usada, por ejemplo, en URI.
itemType	string	El tipo de los elementos en la recopilación.
links	FeaturesEndpointLink[]	Vínculos a otros puntos de conexión de características.
ontology	string	Versión de ontología de este conjunto de datos.
title	string	Título legible de la colección.

CollectionsResult

Respuesta después de una solicitud correcta para enumerar colecciones.

Nombre	Tipo	Description
collections	CollectionResult[]	Todas las colecciones de un conjunto de datos determinado.
links	FeaturesEndpointLink[]	Vínculos a otros puntos de conexión de características.
ontology	string	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.

FeaturesEndpointLink

Vínculos a otros puntos de conexión de características. Para obtener más información sobre las relaciones de vínculo, visite la API de OGC - Características - Parte 1 estándar.

Nombre	Tipo	Description
href	string	Destino 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).

Compartir a través de