WFS - Get Collection Definition

Referenz

Dienst:: Maps Creator

API-Version:: 2.0

Dient zum Abrufen eines detaillierten Datenmodells einer Sammlung.

Anmerkung

Einstellung von Azure Maps Creator

Der Azure Maps Creator-Indoor-Kartendienst ist jetzt veraltet und wird am 9.30.25. eingestellt. Weitere Informationen finden Sie unter Ankündigung zum Ende des Lebenszyklus von Azure Maps Creator.

Die Get Collection Definition-API ist eine HTTP-GET Anforderung, die ein detailliertes Datenmodell der angegebenen Auflistung bereitstellt.

Die WFS-API folgt dem Open Geospatial Consortium API-Standard für Features abfragen Datasets.

Ein Dataset besteht aus mehreren Featuresammlungen. Eine Featuresammlung ist eine Sammlung von Features eines ähnlichen Typs, basierend auf einem allgemeinen Schema.

###Submit Sammlungsdefinitionsanforderung abrufen

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
collectionId	path	True	string	Bezeichner (Name) einer bestimmten Auflistung
datasetId	path	True	string	Der Bezeichner für das zu abfragende Dataset.
geography	path	True	string	Dieser Parameter gibt an, wo sich die Azure Maps Creator-Ressource befindet. Gültige Werte sind uns 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 in Verbindung mit dem Microsoft Entra ID-Sicherheitsmodell für die Verwendung vorgesehen ist. Sie stellt eine eindeutige ID für das Azure Maps-Konto dar und kann aus der Azure Maps-Verwaltungsebenen-Konto-API abgerufen werden. Informationen zur Verwendung der Sicherheit von Microsoft Entra-ID in Azure Maps finden Sie in den folgenden Artikeln anleitungen.

Antworten

Name	Typ	Beschreibung
200 OK	CollectionDefinition	Okay
Other Status Codes	ErrorResponse	Unerwarteter Fehler.

Sicherheit

AADToken

Dies sind die Microsoft Entra OAuth 2.0 Flows. Bei Kombination mit rollenbasierten Azure-Zugriff Steuern kann es verwendet werden, um den Zugriff auf Azure Maps-REST-APIs zu steuern. Azure-rollenbasierte Zugriffssteuerungen werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps-Ressourcenkonten oder -Unterressourcen zu bestimmen. Jedem Benutzer, Gruppen- oder Dienstprinzipal kann über eine integrierte Rolle oder eine benutzerdefinierte Rolle, die aus einer oder mehreren Berechtigungen für Azure Maps-REST-APIs besteht, Zugriff gewährt werden.

Um Szenarien zu implementieren, empfehlen wir, Authentifizierungskonzepteanzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung für die Modellierung von Anwendungen über Objekte, die zugriffsfähig für bestimmte APIs und Bereiche sind.

Notizen

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 Karten-Verwaltungs-APIerworben werden.

Die Authorization URL ist spezifisch für die Öffentliche Azure-Cloudinstanz. Souveräne Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra-ID-Konfigurationen. * Die rollenbasierte Azure-Zugriffssteuerung wird über die Azure-Verwaltungsebene über das 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.

Weitere Informationen zur Microsoft Identity Platform finden Sie unter Übersicht über die Microsoft Identity Platform.

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 freigegebener Schlüssel, der bereitgestellt wird, wenn Sie Erstellen eines Azure Maps-Kontos im Azure-Portal oder mithilfe von PowerShell, CLI, Azure SDKs oder REST-API.

Mit diesem Schlüssel kann jede Anwendung auf alle REST-API zugreifen. Mit anderen Worten, dieser Schlüssel kann als Hauptschlüssel in dem Konto verwendet werden, in dem sie ausgestellt werden.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, die vertraulichen Clientanwendungen Ansatz für den Zugriff auf Azure Maps-REST-APIs zu verwenden, damit Ihr Schlüssel sicher gespeichert werden kann.

Typ: apiKey
In: query

SAS Token

Dies ist ein Freigegebenes Zugriffssignaturtoken wird aus dem Listen-SAS-Vorgang auf der Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt.

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

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

Typ: apiKey
In: header

Beispiele

GetCollectionDefinition

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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"
    }
  ]
}

Definitionen

Name	Beschreibung
CollectionDefinition	Sammlung von GeoJSON-Features
DefinitionProperty
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
GeoJsonGeometryType	Zurückgegebener Geometrietyp
WFSEndpointLink	Links zu anderen WFS-Endpunkten

CollectionDefinition

Objekt

Sammlung von GeoJSON-Features

Name	Typ	Beschreibung
description	string	beschreibt die Sammlung
featureTypes	string[]	Typ der zurückgegebenen Features
geometryType	GeoJsonGeometryType	Zurückgegebener Geometrietyp
idPrefix	string	Präfix der verwendeten Auflistung
links	WFSEndpointLink[]	Links zu anderen WFS-Endpunkten.
name	string	Bezeichner der verwendeten Auflistung, z. B. in URIs
ontology	string	Die Ontologieversion dieses Datasets.
properties	DefinitionProperty[]	Attribute der verwendeten Auflistung
title	string	Titel der Sammlung

DefinitionProperty

Objekt

Name	Typ	Beschreibung
name	string	Name des Attributs
required	boolean	ist Attribut erforderlich
type	object	Typ des Attributs

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

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

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

GeoJsonGeometryType

Enumeration

Zurückgegebener Geometrietyp

Wert	Beschreibung
GeometryCollection	`GeoJSON GeometryCollection` Geometrie.
LineString	`GeoJSON LineString` Geometrie.
MultiLineString	`GeoJSON MultiLineString` Geometrie.
MultiPoint	`GeoJSON MultiPoint` Geometrie.
MultiPolygon	`GeoJSON MultiPolygon` Geometrie.
Point	`GeoJSON Point` Geometrie.
Polygon	`GeoJSON Polygon` Geometrie.

WFSEndpointLink

Objekt

Links zu anderen WFS-Endpunkten

Name	Typ	Beschreibung
href	string	Das Linkziel.
hreflang	string	Ein Hinweis, der angibt, welche Sprache das Ergebnis der Ableitung des Links sein soll.
rel	string	Der Beziehungstyp.
title	string	Wird verwendet, um das Ziel eines Links so zu bezeichnen, dass er als lesbarer Bezeichner (z. B. ein Menüeintrag) in der sprache verwendet werden kann, die durch das Headerfeld "Content-Language" (sofern vorhanden) angegeben wird.
type	string	Ein Hinweis, der angibt, was der Medientyp des Ergebnisses der Ableitung des Links sein soll.

Freigeben über

WFS - Get Collection Definition

URI-Parameter

Anforderungsheader

Antworten

Sicherheit

AADToken

Notizen

Bereiche

subscription-key

SAS Token

Beispiele

GetCollectionDefinition

Beispielanforderung

Beispiel für eine Antwort

Definitionen

CollectionDefinition

DefinitionProperty

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeoJsonGeometryType

WFSEndpointLink

Zusätzliche Ressourcen