Freigeben über


WFS - Get Features

Verwenden Sie, um eine detaillierte Liste der Features einer Sammlung abzurufen.

Die Get Features API ist eine HTTP-Anforderung GET , die eine detaillierte Liste der Features in der angegebenen Auflistung zurückgibt.

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.

Anforderung zum Abrufen von Features übermitteln

GET https://{geography}.atlas.microsoft.com/wfs/datasets/{datasetId}/collections/{collectionId}/items?api-version=2.0
GET https://{geography}.atlas.microsoft.com/wfs/datasets/{datasetId}/collections/{collectionId}/items?api-version=2.0&limit={limit}&bbox={bbox}&filter={filter}

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.

bbox
query

number[]

Es werden nur Features ausgewählt, die über eine Geometrie verfügen, die das angegebene Begrenzungsfeld überschneidet.

  • Untere linke Ecke, Koordinatenachse 1 * Untere linke Ecke, Koordinatenachse 2 * Obere rechte Ecke, Koordinatenachse 1 * Obere rechte Ecke, Koordinatenachse 2 Das Koordinatenreferenzsystem der Werte ist WGS84 Längengrad/Breitengrad (http://www.opengis.net/def/crs/OGC/1.3/CRS84), es sei denn, im Parameter bbox-crsist ein anderes Koordinatenreferenzsystem angegeben. Für WGS84-Längengrad/Breitengrad sind die Werte in den meisten Fällen die Sequenz von minimalem Längengrad, minimalem Breitengrad, maximalem Längengrad und maximalem Breitengrad. In Fällen, in denen das Feld den Antimeridian umfasst, ist der erste Wert (westlichste Boxkante) jedoch größer als der dritte Wert (östlichste Boxkante).
filter
query

string

Filterausdruck, um nach Features mit bestimmten Eigenschaftenwerten in einer bestimmten Auflistung zu suchen. Es werden nur Featureeigenschaften des skalaren Typs und des Gleichoperators unterstützt. Dies ist ein spezieller Parameter, bei dem der Parametername ein Eigenschaftsname ist, bei dem die Groß-/Kleinschreibung beachtet wird. Das Schema für diesen Parameter ist {Eigenschaftsname}={Eigenschaftswert}. Sofern "filter" nicht einer der Eigenschaftennamen in der Auflistung ist, sollte "filter" nicht als Parametername verwendet werden. Um nach Features mit dem Eigenschaftswert "name" "21N13" zu suchen, verwenden Sie "name=21N13". Mehrere Filter werden unterstützt und sollten als mehrere Abfrageparameter dargestellt werden. Beispiel: =&= Zeichenfolgenwerte beachten die Groß-/Kleinschreibung.

limit
query

integer

Der optionale Grenzwertparameter schränkt die Anzahl der Features ein, die im Antwortdokument angezeigt werden. Es werden nur Features gezählt, die sich auf der ersten Ebene der Auflistung im Antwortdokument befinden. Geschachtelte Objekte, die in den explizit angeforderten Features enthalten sind, werden nicht gezählt.

  • Minimum = 1 * Maximum = 500 * Standard = 10

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

ExtendedGeoJsonFeatureCollection

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.

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

GetFeatures

Beispielanforderung

GET https://us.atlas.microsoft.com/wfs/datasets/018fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2.0&limit=1&bbox=-122,47,-120,46

Beispiel für eine Antwort

{
  "type": "FeatureCollection",
  "ontology": "Facility-2.0",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              139.6330405782921,
              35.45768668610856
            ],
            [
              139.63296283234274,
              35.45778390425868
            ],
            [
              139.63308672404617,
              35.45785022906202
            ],
            [
              139.6331451691671,
              35.45777714569986
            ],
            [
              139.6331274703629,
              35.45776767074717
            ],
            [
              139.63314677109963,
              35.45774353588138
            ],
            [
              139.6330405782921,
              35.45768668610856
            ]
          ]
        ]
      },
      "properties": {
        "originalId": "ddbbb583-4621-4e11-8859-299d1057e843",
        "categoryId": "CTG10",
        "isOpenArea": false,
        "navigableBy": [
          "pedestrian"
        ],
        "isRoutable": false,
        "routeThroughBehavior": "allowed",
        "nonPublic": false,
        "levelId": "LVL18",
        "occupants": [],
        "addressId": "DIR16",
        "addressRoomNumber": "",
        "name": "21N13",
        "nameSubtitle": "",
        "nameAlt": ""
      },
      "id": "UNIT39",
      "featureType": ""
    }
  ],
  "numberReturned": 1,
  "links": [
    {
      "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2.0&limit=1",
      "rel": "self"
    },
    {
      "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit?api-version=2.0",
      "rel": "data"
    },
    {
      "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?n=PMRG4ZLYOQRDUMJMEJYHEZLWEI5C2ML5&api-version=2.0&limit=1",
      "rel": "next"
    }
  ]
}

Definitionen

Name Beschreibung
ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

ErrorDetail

Die Fehlerdetails.

ErrorResponse

Fehlerantwort

ExtendedGeoJsonFeatureCollection

Ein gültiger GeoJSON FeatureCollection Objekttyp, der mit numberReturned und links array erweitert wurde. Weitere Informationen finden Sie unter RFC 7946 .

GeoJsonFeature

Ein gültiger GeoJSON Feature Objekttyp. Weitere Informationen finden Sie unter RFC 7946 .

GeoJsonGeometry

Ein gültiges GeoJSON Geometrieobjekt. Der Typ muss einer der sieben gültigen GeoJSON-Geometrietypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon und GeometryCollection. Weitere Informationen finden Sie unter RFC 7946 .

GeoJsonGeometryCollection

Ein gültiger GeoJSON GeometryCollection Objekttyp. Weitere Informationen finden Sie unter RFC 7946 .

GeoJsonLineString

Ein gültiger GeoJSON LineString Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

GeoJsonMultiLineString

Ein gültiger GeoJSON MultiLineString Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

GeoJsonMultiPoint

Ein gültiger GeoJSON MultiPoint Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

GeoJsonMultiPolygon

Ein gültiger GeoJSON MultiPolygon Objekttyp. Weitere Informationen finden Sie unter RFC 7946 .

GeoJsonObjectType

Gibt den GeoJSON Typ an: FeatureCollection.

GeoJsonPoint

Ein gültiger GeoJSON Point Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

GeoJsonPolygon

Ein gültiger GeoJSON Polygon Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

WFSEndpointLink

Links zu anderen WFS-Endpunkten

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.

ExtendedGeoJsonFeatureCollection

Ein gültiger GeoJSON FeatureCollection Objekttyp, der mit numberReturned und links array erweitert wurde. Weitere Informationen finden Sie unter RFC 7946 .

Name Typ Beschreibung
features

GeoJsonFeature[]

Enthält eine Liste gültiger GeoJSON Feature Objekte.

links

WFSEndpointLink[]

Links zu anderen WFS-Endpunkten.

numberReturned

integer

Anzahl der zurückgegebenen Features.

ontology

string

Die Ontologieversion dieses Datasets.

type

GeoJsonObjectType

Gibt den GeoJSON Typ an: FeatureCollection.

GeoJsonFeature

Ein gültiger GeoJSON Feature Objekttyp. Weitere Informationen finden Sie unter RFC 7946 .

Name Typ Beschreibung
featureType

string

Der Funktionstyp Der Wert hängt vom Datenmodell ab, in dem sich das aktuelle Feature befindet. Einige Datenmodelle verfügen möglicherweise über einen leeren Wert.

geometry GeoJsonGeometry:

Ein gültiges GeoJSON Geometrieobjekt. Der Typ muss einer der sieben gültigen GeoJSON-Geometrietypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon und GeometryCollection. Weitere Informationen finden Sie unter RFC 7946 .

id

string

Bezeichner für das Feature.

type string:

Feature

Gibt den GeoJSON-Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

GeoJsonGeometry

Ein gültiges GeoJSON Geometrieobjekt. Der Typ muss einer der sieben gültigen GeoJSON-Geometrietypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon und GeometryCollection. Weitere Informationen finden Sie unter RFC 7946 .

Name Typ Beschreibung
type

GeoJsonObjectType

Gibt den GeoJSON-Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

GeoJsonGeometryCollection

Ein gültiger GeoJSON GeometryCollection Objekttyp. Weitere Informationen finden Sie unter RFC 7946 .

Name Typ Beschreibung
geometries GeoJsonGeometry[]:

Enthält eine Liste mit gültigen GeoJSON Geometrieobjekten. Beachten Sie , dass die Koordinaten in GeoJSON in x,y-Reihenfolge (Längengrad, Breitengrad) liegen.

type string:

GeometryCollection

Gibt den GeoJSON-Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

GeoJsonLineString

Ein gültiger GeoJSON LineString Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

Name Typ Beschreibung
coordinates

number[]

Koordinaten für die GeoJson LineString Geometrie.

type string:

LineString

Gibt den GeoJSON-Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

GeoJsonMultiLineString

Ein gültiger GeoJSON MultiLineString Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

Name Typ Beschreibung
coordinates

number[]

Koordinaten für die GeoJson MultiLineString Geometrie.

type string:

MultiLineString

Gibt den GeoJSON-Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

GeoJsonMultiPoint

Ein gültiger GeoJSON MultiPoint Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

Name Typ Beschreibung
coordinates

number[]

Koordinaten für die GeoJson MultiPoint Geometrie.

type string:

MultiPoint

Gibt den GeoJSON-Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

GeoJsonMultiPolygon

Ein gültiger GeoJSON MultiPolygon Objekttyp. Weitere Informationen finden Sie unter RFC 7946 .

Name Typ Beschreibung
coordinates

number[]

Enthält eine Liste gültiger GeoJSON Polygon Objekte. Beachten Sie , dass die Koordinaten in GeoJSON in x,y-Reihenfolge (Längengrad, Breitengrad) liegen.

type string:

MultiPolygon

Gibt den GeoJSON-Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

GeoJsonObjectType

Gibt den GeoJSON Typ an: FeatureCollection.

Name Typ Beschreibung
FeatureCollection

string

GeoJSON FeatureCollection-Objekt

GeoJsonPoint

Ein gültiger GeoJSON Point Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

Name Typ Beschreibung
coordinates

number[]

A Position ist ein Array von Zahlen mit zwei oder mehr Elementen. Die ersten beiden Elemente sind Längen- und Breitengrad, genau in dieser Reihenfolge. Altitude/Elevation ist ein optionales drittes Element. Weitere Informationen finden Sie unter RFC 7946 .

type string:

Point

Gibt den GeoJSON-Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

GeoJsonPolygon

Ein gültiger GeoJSON Polygon Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

Name Typ Beschreibung
coordinates

number[]

Koordinaten für den GeoJson Polygon Geometrietyp.

type string:

Polygon

Gibt den GeoJSON-Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

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.