Features - Get

Referenz

Dienst:: Maps Creator

API-Version:: 2023-03-01-preview

Verwenden Sie , um die Details eines Features abzurufen.

Die Features-API ist Ein Teil von Creator, der es ermöglicht, Anwendungen basierend auf Ihren privaten Gebäudekartendaten mit Azure Maps API und SDK zu entwickeln. Features GET-APIs folgen der Open Geospatial Consortium-API – Features – Teil 1: Core Corrigendum Standard, um Datasets abzufragen. Datasets bestehen aus mehreren Featuresammlungen, bei denen es sich um eine Gruppierung von Features handelt, die durch ein allgemeines Schema definiert werden.

Übermitteln der Get-Anforderung

Die Get API ist eine HTTP-Anforderung GET , die das Feature zurückgibt, das durch das im angegebenen Dataset und in der angegebenen Auflistung angegebene featureId identifiziert wird.

GET https://{geography}.atlas.microsoft.com/features/datasets/{datasetId}/collections/{collectionId}/items/{featureId}?api-version=2023-03-01-preview

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, aus dem Abfragen ausgeführt werden sollen.
featureId	path	True	string	Bezeichner für ein bestimmtes Feature, bei dem die Groß-/Kleinschreibung beachtet wird.
geography	path	True	string	Dieser Parameter gibt an, wo sich die Azure Maps Creator-Ressource befindet. Gültige Werte sind "us" und "eu".
api-version	query	True	string	Versionsnummer der Azure Maps API.

Antworten

Name	Typ	Beschreibung
200 OK	FeatureResult	OK
Other Status Codes	ErrorResponse	Ein unerwarteter Fehler ist aufgetreten.

Sicherheit

AADToken

Dies sind die Azure Active Directory OAuth2-Flows . In Kombination mit der rollenbasierten Zugriffssteuerung in Azure 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 einem 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.

Zur Implementierung von Szenarien wird empfohlen, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die die Zugriffssteuerung für bestimmte APIs und Bereiche ermöglichen.

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.

ist Authorization URL spezifisch für die öffentliche Azure-Cloud instance. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Azure Active Directory-Konfigurationen. * Die rollenbasierte Zugriffssteuerung von 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.

Derzeit unterstützt Azure Active Directory v1.0 oder v2.0 Arbeit, Schule und Gäste, aber keine persönlichen Konten.

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 verwendeter Schlüssel, der beim Erstellen einer Azure Maps Ressource über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs bereitgestellt wird.

Mit diesem Schlüssel ist jede Anwendung für den Zugriff auf alle REST-APIs autorisiert. Anders ausgedrückt: Diese können derzeit als master Schlüssel für das Konto behandelt werden, für das sie ausgestellt wurden.

Für öffentlich zugängliche Anwendungen wird empfohlen, den Server-zu-Server-Zugriff auf Azure Maps REST-APIs zu verwenden, in denen dieser Schlüssel sicher gespeichert werden kann.

Typ: apiKey
In: query

SAS Token

Dies ist 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 für den Zugriff mit rollenbasierten Azure-Zugriffssteuerungen und einer präzisen Steuerung des Ablaufs, der Rate und der Regionen für das jeweilige Token autorisiert. Anders ausgedrückt: Das SAS-Token kann verwendet werden, um Anwendungen die Steuerung des Zugriffs auf eine sicherere Weise zu ermöglichen als der gemeinsam genutzte Schlüssel.

Für öffentlich verfügbar gemachte Anwendungen wird empfohlen, eine bestimmte Liste der zulässigen Ursprünge in der Ressource "Konto zuordnen " zu konfigurieren, um den Renderingmissbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

Typ: apiKey
In: header

Beispiele

GetFeature

Beispielanforderung

HTTP

GET https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items/UNIT39?api-version=2023-03-01-preview

Beispiel für eine Antwort

Statuscode:: 200

{
  "ontology": "facility-2.0",
  "feature": {
    "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,
      "isRoutable": false,
      "levelId": "LVL18",
      "occupants": [],
      "addressId": "DIR16",
      "name": "21N13"
    },
    "id": "UNIT39"
  },
  "links": [
    {
      "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items/UNIT39",
      "rel": "self",
      "title": "UNIT39"
    },
    {
      "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items",
      "rel": "items",
      "title": "Unit"
    },
    {
      "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit",
      "rel": "collection",
      "title": "Information for unit collection"
    }
  ]
}

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
Feature	Ein gültiger `GeoJSON Feature` Objekttyp. Weitere Informationen finden Sie unter RFC 7946 .
FeatureResult	Antwort, nachdem ein Feature erfolgreich gelesen wurde.
FeaturesEndpointLink	Links zu anderen Featuresdpunkten. Weitere Informationen zu Linkbeziehungen finden Sie unter OGC-API – Features – Teil 1-Standard .
GeoJsonGeometry	Ein gültiges `GeoJSON` geometry-Objekt. 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 .

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.

Feature

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

Name	Typ	Beschreibung
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	Ein gültiges `GeoJSON` geometry-Objekt. 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 ein bestimmtes Feature, bei dem die Groß-/Kleinschreibung beachtet wird.
properties	object	Eigenschaften können alle zusätzlichen Metadaten über und enthalten, die `Feature` von der GET-Sammlungsdefinitions-API definiert werden. Der Wert kann ein beliebiges JSON-Objekt oder ein JSON-NULL-Wert sein. Beachten Sie jedoch, dass Featureeigenschaften, die nicht in der Auflistungsdefinition definiert sind, ignoriert werden.
type	string	Gibt den `GeoJSON` Typ an: Feature

FeatureResult

Antwort, nachdem ein Feature erfolgreich gelesen wurde.

Name	Typ	Beschreibung
feature	Feature	Ein gültiger `GeoJSON Feature` Objekttyp. Weitere Informationen finden Sie unter RFC 7946 .
links	FeaturesEndpointLink[]	Links zu anderen Featuresdpunkten.
ontology	string	Die Ontologieversion dieses Datasets.

FeaturesEndpointLink

Links zu anderen Featuresdpunkten. Weitere Informationen zu Linkbeziehungen finden Sie unter OGC-API – Features – Teil 1-Standard .

Name	Typ	Beschreibung
href	string	Das Linkziel.
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).

GeoJsonGeometry

Ein gültiges GeoJSON geometry-Objekt. 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[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	Enthält eine Liste gültiger `GeoJSON` Geometrieobjekte. Beachten Sie , dass die Koordinaten in GeoJSON in der Reihenfolge x, y (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 der Reihenfolge x, y (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[]	Ein `Position` ist ein Array von Zahlen mit zwei oder mehr Elementen. Die ersten beiden Elemente sind Längen- und Breitengrad, genau in dieser Reihenfolge. Höhe/Höhe 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` geometry-Typ.
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.

Freigeben über