WFS - Get Collection Definition

Referenz

Dienst:: Maps Creator

API-Version:: 2.0

Verwenden Sie, um ein detailliertes Datenmodell einer Sammlung abzurufen.

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

Die WFS-API entspricht dem Api-Standard des Open Geospatial Consortium für Features zum Abfragen von Datasets.

Ein Dataset besteht aus mehreren Featuresammlungen. Eine Featuresammlung ist eine Auflistung von Features eines ähnlichen Typs, die auf einem gemeinsamen Schema basiert.

###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 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	CollectionDefinition	OK,
Other Status Codes	ErrorResponse	Ein unerwarteter Fehler ist aufgetreten.

Sicherheit

AADToken

Dies sind die Microsoft Entra OAuth 2.0 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 Microsoft Entra ID 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.

Weitere Informationen zu Microsoft Identity Platform finden Sie unter Microsoft Identity Platform Übersicht.

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 bereitgestellt wird, wenn Sie ein Azure Maps-Konto im Azure-Portal erstellen oder PowerShell, CLI, Azure SDKs oder REST-API verwenden.

Mit diesem Schlüssel kann jede Anwendung auf die gesamte REST-API zugreifen. Mit anderen Worten, dieser Schlüssel kann als master Schlüssel in dem Konto verwendet werden, in dem er ausgestellt wird.

Für öffentlich zugängliche Anwendungen wird empfohlen, den Ansatz vertraulicher Clientanwendungen zu verwenden, um auf Azure Maps REST-APIs zuzugreifen, damit Ihr 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/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	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
GeoJsonGeometryType	Typ der zurückgegebenen Geometrie
WFSEndpointLink	Links zu anderen WFS-Endpunkten

CollectionDefinition

Sammlung von GeoJSON-Features

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

DefinitionProperty

Name	Typ	Beschreibung
name	string	Name des Attributs
required	boolean	ist 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.

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.

WFSEndpointLink

Links zu anderen WFS-Endpunkten

Name	Typ	Beschreibung
href	string	Das Linkziel.
hreflang	string	Ein Hinweis, der angibt, welche Sprache das Ergebnis der Deferencierung des Links haben soll.
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).
type	string	Ein Hinweis, der angibt, welcher Medientyp das Ergebnis der Deferencierung des Links sein soll.

Freigeben über