WFS - Get Collection

Odwołanie

Usługa:: Maps Creator

Wersja interfejsu API:: 2.0

Użyj polecenia , aby uzyskać opis określonej kolekcji.

Interfejs Get Collection API to żądanie HTTP GET zwracające opis określonej kolekcji. Zawiera linki do operacji, które można wykonać w 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.

Interfejs API opisu kolekcji zawiera opis danej kolekcji. Zawiera linki do operacji, które można wykonać w kolekcji.

Prześlij żądanie pobrania kolekcji

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

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 wykonywania zapytań.
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.

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	Collection	Ok
Other Status Codes	ErrorResponse	Wystąpił nieoczekiwany błąd.

Zabezpieczenia

AADToken

Są to przepływy protokołu OAuth 2.0 Microsoft Entra. W 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 konta zasobów Azure Maps 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ęć dotyczących uwierzytelniania. Podsumowując, ta definicja zabezpieczeń udostępnia 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łówkax-ms-client-id, aby wskazać, do którego zasobu Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania mapami.

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 płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST. * Użycie zestawu AZURE MAPS Web SDK umożliwia konfigurację opartą na konfiguracji aplikacji w wielu przypadkach 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ólny aprowizowany podczas tworzenia konta Azure Maps w Azure Portal lub przy użyciu programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsu API REST.

Przy użyciu tego klucza każda aplikacja może uzyskać dostęp do całego interfejsu API REST. Innymi słowy, ten klucz może być używany 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 do interfejsów API REST Azure Maps w celu bezpiecznego przechowywania klucza.

Typ: apiKey
W: query

SAS Token

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

Przy użyciu tego tokenu każda aplikacja jest autoryzowana do uzyskiwania dostępu za pomocą kontroli dostępu opartej na rolach platformy Azure i szczegółowej kontroli wygaśnięcia, szybkości i regionów użycia dla określonego tokenu. Innymi słowy, token sygnatury dostępu współdzielonego może służyć do umożliwienia aplikacjom kontrolowania dostępu w bardziej bezpieczny sposób 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 SYGNATURy dostępu współdzielonego.

Typ: apiKey
W: header

Przykłady

GetCollection

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

{
  "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",
  "links": [
    {
      "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/definition?api-version=2.0",
      "rel": "describedBy",
      "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"
    },
    {
      "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit?api-version=2.0",
      "rel": "self",
      "title": "Metadata catalogue for unit"
    }
  ]
}

Definicje

Nazwa	Opis
Collection
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
WFSEndpointLink	Linki do innych punktów końcowych systemu plików WFS

Collection

Nazwa	Typ	Opis
description	string	opis funkcji w kolekcji
links	WFSEndpointLink[]	Łącza do innych punktów końcowych systemu plików WFS.
name	string	identyfikator używanej kolekcji, na przykład w identyfikatorach URI
ontology	string	Wersja ontologii tego zestawu danych.
title	string	czytelny tytuł kolekcji

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 błędu.

WFSEndpointLink

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

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

Udostępnij za pośrednictwem