Features - Get Collection Definition

Referenz

Dienst:: Maps Creator

API-Version:: 2023-03-01-preview

Verwenden Sie, um ein detailliertes Datenmodell der angegebenen Featuresammlung abzurufen.

Die Features-API ist ein Teil von Creator, der es ermöglicht, Anwendungen basierend auf Ihren privaten Indoor-Kartendaten mit Azure Maps API und SDK zu entwickeln. Features GET-APIs folgen der Open Geospatial Consortium-API – Features – Part 1: Core Corrigendum Standard zum Abfragen von Datasets. Datasets bestehen aus mehreren Featuresammlungen, bei denen es sich um eine Gruppierung von Features handelt, die durch ein allgemeines Schema definiert werden.

Übermitteln der Anforderung zur Definition der Get-Sammlung

Die Get Collection Definition API ist eine HTTP-Anforderung GET , die ein detailliertes Datenmodell einer Featuresammlung zurückgibt, wie durch die bereitgestellte collectionIddefiniert.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
collectionId	path	True	string	Bezeichner (Name) einer bestimmten Sammlung.
datasetId	path	True	string	Der Bezeichner für das Dataset, von dem eine Abfrage ausgeführt werden soll.
geography	path	True	string	Dieser Parameter gibt an, wo sich die Azure Maps Creator-Ressource befindet. Gültige Werte sind wir und eu.
api-version	query	True	string	Versionsnummer der Azure Maps API.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-id		string	Gibt an, welches Konto für die Verwendung in Verbindung mit dem Microsoft Entra ID Sicherheitsmodell vorgesehen ist. Es stellt eine eindeutige ID für das Azure Maps-Konto dar und kann von der konto-API auf Azure Maps Verwaltungsebene abgerufen werden. Anleitungen zur Verwendung Microsoft Entra ID Sicherheit in Azure Maps finden Sie in den folgenden Artikeln.

Antworten

Name	Typ	Beschreibung
200 OK	CollectionDefinitionResult	OK,
Other Status Codes	ErrorResponse	Ein unerwarteter Fehler ist aufgetreten.

Sicherheit

AADToken

Dies sind die Azure Active Directory OAuth2 Flows. Wenn sie mit der rollenbasierten Zugriffssteuerung in Azure gekoppelt ist, kann sie verwendet werden, um den Zugriff auf Azure Maps REST-APIs zu steuern. Rollenbasierte Zugriffssteuerungen in Azure werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps Ressourcenkonto oder Unterressourcen festzulegen. Jedem Benutzer, jeder Gruppe oder jedem Dienstprinzipal kann Zugriff über eine integrierte Rolle oder eine benutzerdefinierte Rolle gewährt werden, die aus einer oder mehreren Berechtigungen für Azure Maps REST-APIs besteht.

Zum Implementieren von Szenarien empfiehlt es sich, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die auf bestimmte APIs und Bereiche zugreifen können.

Hinweise

Diese Sicherheitsdefinition erfordert die Verwendung des x-ms-client-id Headers, um anzugeben, auf welche Azure Maps Ressource die Anwendung Zugriff anfordert. Dies kann über die Kartenverwaltungs-API abgerufen werden.

Der Authorization URL ist spezifisch für die öffentliche Azure-Cloud-instance. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Azure Active Directory-Konfigurationen. * Die rollenbasierte Zugriffssteuerung in Azure wird über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs konfiguriert. * Die Verwendung des Azure Maps Web SDK ermöglicht die konfigurationsbasierte Einrichtung einer Anwendung für mehrere Anwendungsfälle.

Derzeit unterstützt Azure Active Directory v1.0 oder v2.0 Work, School und Guests, aber keine persönlichen Konten.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

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

subscription-key

Dies ist ein gemeinsam genutzter Schlüssel, der beim Erstellen einer Azure Maps Ressource über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs bereitgestellt wird.

Mit diesem Schlüssel ist jede Anwendung für den Zugriff auf alle REST-APIs autorisiert. Mit anderen Worten, diese können derzeit als master Schlüssel für das Konto behandelt werden, für das sie ausgestellt werden.

Für öffentlich zugängliche Anwendungen wird empfohlen, den Server-zu-Server-Zugriff auf Azure Maps REST-APIs zu verwenden, in denen dieser Schlüssel sicher gespeichert werden kann.

Typ: apiKey
In: query

SAS Token

Hierbei handelt es sich um ein Shared Access Signature Token, das aus dem Sas-Listenvorgang auf der Azure Maps-Ressource über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt wird.

Mit diesem Token ist jede Anwendung autorisiert, mit rollenbasierten Zugriffssteuerungen in Azure auf den Ablauf, die Rate und die Region(en) der Verwendung für das jeweilige Token zuzugreifen. Mit anderen Worten, das SAS-Token kann verwendet werden, um Anwendungen zu ermöglichen, den Zugriff auf eine sicherere Weise als der freigegebene Schlüssel zu steuern.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, eine bestimmte Liste der zulässigen Ursprünge für die Zuordnungskontoressource zu konfigurieren, um den Renderingmissbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

Typ: apiKey
In: header

Beispiele

GetCollectionDefinition

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "id": "unit",
  "title": "Unit",
  "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.",
  "ontology": "Facility-2.0",
  "geometryType": "Polygon",
  "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": "isRoutable",
      "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/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/definition",
      "rel": "self",
      "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"
    }
  ]
}

Definitionen

Name	Beschreibung
CollectionDefinitionResult	Antwort nach einer erfolgreichen Anforderung zum Lesen der Definition einer Sammlung.
DefinitionProperty	Die Definition einer Eigenschaft in einer Auflistung.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
FeaturesEndpointLink	Links zu anderen Featuresdpunkten. Weitere Informationen zu Linkbeziehungen finden Sie in der OGC-API – Features – Teil 1-Standard .
GeoJsonGeometryType	Typ der zurückgegebenen Geometrie.

CollectionDefinitionResult

Antwort nach einer erfolgreichen Anforderung zum Lesen der Definition einer Sammlung.

Name	Typ	Beschreibung
description	string	Beschreibt die Auflistung.
geometryType	GeoJsonGeometryType	Typ der zurückgegebenen Geometrie.
id	string	Bezeichner der Auflistung, die z. B. in URIs verwendet wird.
itemType	string	Der Typ der Elemente in der Auflistung.
links	FeaturesEndpointLink[]	Links zu anderen Featuresdpunkten.
ontology	string	Die Ontologieversion dieses Datasets.
properties	DefinitionProperty[]	Attribute der verwendeten Auflistung.
title	string	Titel der Sammlung.

DefinitionProperty

Die Definition einer Eigenschaft in einer Auflistung.

Name	Typ	Beschreibung
name	string	Name des Attributs.
required	boolean	Ist das Attribut erforderlich.
type	object	Typ des Attributs.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

FeaturesEndpointLink

Links zu anderen Featuresdpunkten. Weitere Informationen zu Linkbeziehungen finden Sie in der OGC-API – Features – Teil 1-Standard .

Name	Typ	Beschreibung
href	string	Das Linkziel.
rel	string	Der Beziehungstyp.
title	string	Wird verwendet, um das Ziel eines Links so zu beschriften, dass es als lesbarer Bezeichner (z. B. ein Menüeintrag) in der Sprache verwendet werden kann, die im Headerfeld Content-Language angegeben ist (sofern vorhanden).

GeoJsonGeometryType

Typ der zurückgegebenen Geometrie.

Name	Typ	Beschreibung
GeometryCollection	string	`GeoJSON GeometryCollection` Geometrie.
LineString	string	`GeoJSON LineString` Geometrie.
MultiLineString	string	`GeoJSON MultiLineString` Geometrie.
MultiPoint	string	`GeoJSON MultiPoint` Geometrie.
MultiPolygon	string	`GeoJSON MultiPolygon` Geometrie.
Point	string	`GeoJSON Point` Geometrie.
Polygon	string	`GeoJSON Polygon` Geometrie.

Freigeben über