WFS - Get Features

Usługa:

Maps Creator

Wersja interfejsu API:

2.0

Użyj polecenia , aby uzyskać szczegółową listę funkcji kolekcji.

Interfejs Get Features API jest żądaniem HTTP GET , które zwraca szczegółową listę funkcji w określonej kolekcji.

Interfejs API systemu plików WFS jest zgodny ze standardem Open Geospatial Consortium API for Features to query Datasets (Interfejs API open Geospatial Consortium dla funkcji do wykonywania zapytań dotyczących zestawów danych).

Zestaw danych składa się z wielu kolekcji funkcji. Kolekcja funkcji to kolekcja funkcji podobnego typu na podstawie wspólnego schematu.

Prześlij żądanie pobierania funkcji

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
collectionId	path	True	string	Identyfikator (nazwa) określonej kolekcji
datasetId	path	True	string	Identyfikator zestawu danych do odpytowania.
geography	path	True	string	Ten parametr określa, gdzie znajduje się zasób Azure Maps Creator. Prawidłowe wartości to my i eu.
api-version	query	True	string	Numer wersji interfejsu API Azure Maps.
bbox	query		number[]	Wybrane są tylko cechy, które mają geometrię przecinającą dostarczone pole ograniczenia. Lewy dolny róg, oś współrzędnych 1 * Lewy dolny róg, oś współrzędna 2 * Dolny prawy róg, oś współrzędna 2 Układ odniesienia współrzędnych wartości to długość/szerokość geograficzna WGS84 (http://www.opengis.net/def/crs/OGC/1.3/CRS84), chyba że w parametrze bbox-crsokreślono inny system odniesienia współrzędnych. W przypadku usługi WGS84 długość/szerokość geograficzna wartości są w większości przypadków sekwencją minimalnej długości geograficznej, minimalnej szerokości geograficznej, maksymalnej długości geograficznej i maksymalnej szerokości geograficznej. Jednak w przypadkach, gdy pole obejmuje antymerykad pierwszy (zachodnio-najbardziej box edge) jest większe niż trzecia wartość (east-most box edge).
filter	query		string	Filtruj wyrażenie, aby wyszukać funkcje z określonymi wartościami właściwości w danej kolekcji. Obsługiwane są tylko właściwości cech typu skalarnego i operatora równości. Jest to specjalny parametr, w którym nazwa parametru jest nazwą właściwości wrażliwej na wielkość liter. Schemat dla tego parametru to {property name}={property value}. Chyba że "filter" jest jedną z nazw właściwości w kolekcji, "filter" nie należy używać jako nazwy parametru. Aby wyszukać funkcje o wartości właściwości "name" "21N13", użyj ciągu "name=21N13". Obsługiwane są wiele filtrów i powinny być reprezentowane jako wiele parametrów zapytania. Na przykład =&= w wartościach ciągu jest uwzględniana wielkość liter.
limit	query		integer	Opcjonalny parametr limitu ogranicza liczbę funkcji przedstawionych w dokumencie odpowiedzi. Liczone są tylko funkcje, które znajdują się na pierwszym poziomie kolekcji w dokumencie odpowiedzi. Zagnieżdżone obiekty zawarte w jawnie żądanych funkcjach nie są liczone. Minimum = 1 * Maksimum = 500 * Wartość domyślna = 10

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-id		string	Określa, które konto jest przeznaczone do użycia w połączeniu z modelem zabezpieczeń Tożsamość Microsoft Entra. Reprezentuje unikatowy identyfikator konta Azure Maps i można go pobrać z interfejsu API konta płaszczyzny zarządzania Azure Maps. Aby użyć zabezpieczeń Tożsamość Microsoft Entra w usłudze Azure Maps, zobacz następujące artykuły, aby uzyskać wskazówki.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ExtendedGeoJsonFeatureCollection	Ok
Other Status Codes	ErrorResponse	Wystąpił nieoczekiwany błąd.

Zabezpieczenia

AADToken

Są to przepływy Microsoft Entra OAuth 2.0. Po połączeniu z kontrolą dostępu opartą na rolach platformy Azure może służyć do kontrolowania dostępu do interfejsów API REST Azure Maps. Mechanizmy kontroli dostępu opartej na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego Azure Maps konta zasobu lub zasobów podrzędnych. Każdy użytkownik, grupa lub jednostka usługi może mieć dostęp za pośrednictwem wbudowanej roli lub roli niestandardowej składającej się z co najmniej jednego uprawnienia do Azure Maps interfejsów API REST.

Aby zaimplementować scenariusze, zalecamy wyświetlenie pojęć związanych z uwierzytelnianiem. Podsumowując, ta definicja zabezpieczeń stanowi rozwiązanie do modelowania aplikacji za pośrednictwem obiektów, które mogą kontrolować dostęp do określonych interfejsów API i zakresów.

Uwagi

• Ta definicja zabezpieczeń wymaga użycia nagłówka x-ms-client-id w celu wskazania, do którego zasobu Azure Maps aplikacja żąda dostępu. Można to uzyskać z poziomu interfejsu API zarządzania usługami Maps.

Element Authorization URL jest specyficzny dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikatowe adresy URL autoryzacji i konfiguracje Tożsamość Microsoft Entra. * Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana z poziomu płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST. * Użycie zestawu AZURE MAPS Web SDK umożliwia skonfigurowanie aplikacji na podstawie konfiguracji dla wielu przypadków użycia.

• Aby uzyskać więcej informacji na temat Platforma tożsamości Microsoft, zobacz omówienie Platforma tożsamości Microsoft.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Jest to klucz współużytkowany podczas tworzenia konta Azure Maps w Azure Portal lub przy użyciu programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsu API REST.

Za pomocą tego klucza każda aplikacja może uzyskiwać dostęp do wszystkich interfejsów API REST. Innymi słowy, ten klucz może służyć jako klucz główny na koncie, w którym są wystawiane.

W przypadku publicznie uwidocznionych aplikacji zalecamy użycie podejścia do poufnych aplikacji klienckich w celu uzyskania dostępu Azure Maps interfejsów API REST, aby klucz mógł być bezpiecznie przechowywany.

Typ: apiKey
W: query

SAS Token

Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji list sygnatur dostępu współdzielonego na zasobie Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST.

Dzięki temu tokenowi każda aplikacja jest autoryzowana do uzyskiwania dostępu za pomocą kontroli dostępu opartej na rolach platformy Azure oraz szczegółowej kontroli wygaśnięcia, szybkości i regionów użycia dla określonego tokenu. Innymi słowy, token SAS może służyć do umożliwienia aplikacjom kontrolowania dostępu w sposób bardziej bezpieczny niż klucz wspólny.

W przypadku publicznie uwidocznionych aplikacji zalecamy skonfigurowanie określonej listy dozwolonych źródeł w zasobie konta mapy w celu ograniczenia nadużyć renderowania i regularnego odnawiania tokenu SAS.

Typ: apiKey
W: header

Przykłady

GetFeatures

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

200

{
  "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"
    }
  ]
}

Definicje

Nazwa	Opis
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
ExtendedGeoJsonFeatureCollection	Prawidłowy GeoJSON FeatureCollection typ obiektu rozszerzony o liczbęReturned i tablicę łączy. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
GeoJsonFeature	Prawidłowy GeoJSON Feature typ obiektu. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
GeoJsonGeometry	Prawidłowy GeoJSON obiekt geometryczny. Typ musi być jednym z siedmiu prawidłowych typów geometrii GeoJSON — Punkt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon i GeometryCollection. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
GeoJsonGeometryCollection	Prawidłowy GeoJSON GeometryCollection typ obiektu. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
GeoJsonLineString	Prawidłowy GeoJSON LineString typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
GeoJsonMultiLineString	Prawidłowy GeoJSON MultiLineString typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
GeoJsonMultiPoint	Prawidłowy GeoJSON MultiPoint typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
GeoJsonMultiPolygon	Prawidłowy GeoJSON MultiPolygon typ obiektu. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
GeoJsonObjectType	Określa GeoJSON typ: FeatureCollection.
GeoJsonPoint	Prawidłowy GeoJSON Point typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
GeoJsonPolygon	Prawidłowy GeoJSON Polygon typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
WFSEndpointLink	Linki do innych punktów końcowych systemu plików WFS

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt error.

ExtendedGeoJsonFeatureCollection

Prawidłowy GeoJSON FeatureCollection typ obiektu rozszerzony o liczbęReturned i tablicę łączy. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .

Nazwa	Typ	Opis
features	GeoJsonFeature[]	Zawiera listę prawidłowych GeoJSON Feature obiektów.
links	WFSEndpointLink[]	Łącza do innych punktów końcowych systemu plików WFS.
numberReturned	integer	Liczba zwracanych funkcji.
ontology	string	Wersja ontologii tego zestawu danych.
type	GeoJsonObjectType	Określa GeoJSON typ: FeatureCollection.

GeoJsonFeature

Prawidłowy GeoJSON Feature typ obiektu. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .

Nazwa	Typ	Opis
featureType	string	Typ funkcji. Wartość zależy od modelu danych, do której należy bieżąca funkcja. Niektóre modele danych mogą mieć pustą wartość.
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	Prawidłowy GeoJSON obiekt geometryczny. Typ musi być jednym z siedmiu prawidłowych typów geometrii GeoJSON — Punkt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon i GeometryCollection. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
id	string	Identyfikator funkcji.
type	string: Feature	Określa GeoJSON typ. Musi być jednym z dziewięciu prawidłowych typów obiektów GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature i FeatureCollection.

GeoJsonGeometry

Prawidłowy GeoJSON obiekt geometryczny. Typ musi być jednym z siedmiu prawidłowych typów geometrii GeoJSON — Punkt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon i GeometryCollection. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .

Nazwa	Typ	Opis
type	GeoJsonObjectType	Określa GeoJSON typ. Musi być jednym z dziewięciu prawidłowych typów obiektów GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature i FeatureCollection.

GeoJsonGeometryCollection

Prawidłowy GeoJSON GeometryCollection typ obiektu. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .

Nazwa	Typ	Opis
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	Zawiera listę prawidłowych GeoJSON obiektów geometrycznych. Należy pamiętać , że współrzędne w formacie GeoJSON są w kolejności x, y (długość geograficzna, szerokość geograficzna).
type	string: GeometryCollection	Określa GeoJSON typ. Musi być jednym z dziewięciu prawidłowych typów obiektów GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature i FeatureCollection.

GeoJsonLineString

Prawidłowy GeoJSON LineString typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .

Nazwa	Typ	Opis
coordinates	number[]	Współrzędne geometrii GeoJson LineString .
type	string: LineString	Określa GeoJSON typ. Musi być jednym z dziewięciu prawidłowych typów obiektów GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature i FeatureCollection.

GeoJsonMultiLineString

Prawidłowy GeoJSON MultiLineString typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .

Nazwa	Typ	Opis
coordinates	number[]	Współrzędne geometrii GeoJson MultiLineString .
type	string: MultiLineString	Określa GeoJSON typ. Musi być jednym z dziewięciu prawidłowych typów obiektów GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature i FeatureCollection.

GeoJsonMultiPoint

Prawidłowy GeoJSON MultiPoint typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .

Nazwa	Typ	Opis
coordinates	number[]	Współrzędne geometrii GeoJson MultiPoint .
type	string: MultiPoint	Określa GeoJSON typ. Musi być jednym z dziewięciu prawidłowych typów obiektów GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature i FeatureCollection.

GeoJsonMultiPolygon

Prawidłowy GeoJSON MultiPolygon typ obiektu. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .

Nazwa	Typ	Opis
coordinates	number[]	Zawiera listę prawidłowych GeoJSON Polygon obiektów. Należy pamiętać , że współrzędne w formacie GeoJSON są w kolejności x, y (długość geograficzna, szerokość geograficzna).
type	string: MultiPolygon	Określa GeoJSON typ. Musi być jednym z dziewięciu prawidłowych typów obiektów GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature i FeatureCollection.

GeoJsonObjectType

Określa GeoJSON typ: FeatureCollection.

Nazwa	Typ	Opis
FeatureCollection	string	GeoJSON FeatureCollection Obiektu.

GeoJsonPoint

Prawidłowy GeoJSON Point typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .

Nazwa	Typ	Opis
coordinates	number[]	A Position to tablica liczb z co najmniej dwoma elementami. Pierwsze dwa elementy to długość geograficzna i szerokość geograficzna, dokładnie w tej kolejności. Wysokość/wysokość jest opcjonalnym trzecim elementem. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
type	string: Point	Określa GeoJSON typ. Musi być jednym z dziewięciu prawidłowych typów obiektów GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature i FeatureCollection.

GeoJsonPolygon

Prawidłowy GeoJSON Polygon typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .

Nazwa	Typ	Opis
coordinates	number[]	Współrzędne dla GeoJson Polygon typu geometrii.
type	string: Polygon	Określa GeoJSON typ. Musi być jednym z dziewięciu prawidłowych typów obiektów GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature i FeatureCollection.

WFSEndpointLink

Linki do innych punktów końcowych systemu plików WFS

Nazwa	Typ	Opis
href	string	Element docelowy łącza.
hreflang	string	Wskazówka wskazująca, jaki jest język wyniku wyłuszczenia linku.
rel	string	Typ relacji.
title	string	Służy do oznaczania miejsca docelowego łącza, tak aby można było go użyć jako identyfikatora czytelnego dla człowieka (np. wpisu menu) w języku wskazanym przez pole nagłówka Content-Language (jeśli istnieje).
type	string	Wskazówka wskazująca, jaki powinien być typ nośnika wyniku wyłuszczenia linku.