WFS - Get Features

參考

服務:: Maps Creator

API 版本:: 2.0

使用來取得集合功能的詳細清單。

備註

Azure 地圖服務 Creator 淘汰

Azure 地圖服務 Creator 室內地圖服務現在已被取代，且將於 2025/9/30 淘汰。如需詳細資訊，請參閱 Azure 地圖服務 Creator 的生命周期結束公告。

Get Features API 是 HTTP GET 要求，會傳回指定集合中功能的詳細清單。

WFS API 遵循 Open Geospatial Consortium API standard for Features，以查詢數據集。

數據集是由多個功能集合所組成。功能集合是以通用架構為基礎的類似類型特徵集合。

提交取得功能要求

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 參數

名稱	位於	必要	類型	Description
collectionId	path	True	string	特定集合的識別碼（名稱）
datasetId	path	True	string	要查詢之數據集的識別碼。
geography	path	True	string	此參數會指定 Azure 地圖服務建立者資源所在的位置。有效值為我們和 eu。
api-version	query	True	string	Azure 地圖服務 API 的版本號碼。
bbox	query		number[]	只會選取與所提供周框方塊相交的幾何特徵。左下角，座標軸 1 * 左下角，座標軸 2 * 右上角，座標軸 1 * 右上角，座標軸 2 座標軸 2 數值的座標參考系統是 WGS84 經度/緯度（http://www.opengis.net/def/crs/OGC/1.3/CRS84），除非參數中指定了不同的座標參考系統 `bbox-crs`。對於 WGS84 經度/緯度，值大多是最小經度、最小緯度、最大經度和最大緯度序列。不過，如果方塊跨越了 antimeridian，第一個值（最西部的方塊邊緣）大於第三個值（最東部的方塊邊緣）。
filter	query		string	篩選表達式，以搜尋指定集合中具有特定屬性值的功能。只支援純量類型和等號運算子的功能屬性。這是特殊參數，其中參數名稱是區分大小寫的屬性名稱。此參數的配置為 {property name}={property value}。除非「filter」是集合中的其中一個屬性名稱，否則「filter」不應該當做參數名稱使用。若要搜尋「name」屬性值為「21N13」的功能，請使用「name=21N13」。。支援多個篩選，而且應該表示為多個查詢參數。例如， =&= 字串值區分大小寫。
limit	query		integer minimum: 1 maximum: 500	選擇性限制參數會限制回應檔中呈現的功能數目。只會計算回應檔中集合第一層的功能。明確要求之功能內含的巢狀物件不得計算。最小值 = 1 * 最大值 = 500 * 預設值 = 10

要求標頭

名稱	必要	類型	Description
x-ms-client-id		string	指定要與 Microsoft Entra ID 安全性模型搭配使用的帳戶。它代表 Azure 地圖服務帳戶的唯一標識碼，而且可以從 Azure 地圖服務管理平面帳戶 API 擷取。若要在 Azure 地圖服務中使用 Microsoft Entra ID 安全性，請參閱下列文章以取得指引。

回應

名稱	類型	Description
200 OK	ExtendedGeoJsonFeatureCollection	還行
Other Status Codes	ErrorResponse	發生未預期的錯誤。

安全性

AADToken

這些是 Entra OAuth 2.0 流程 Microsoft。與 Azure 角色型存取配對時，控制它可用來控制 Azure 地圖服務 REST API 的存取。 Azure 角色型訪問控制可用來指定一或多個 Azure 地圖服務資源帳戶或子資源的存取權。任何使用者、群組或服務主體都可以透過內建角色或由一或多個 Azure 地圖服務 REST API 許可權所組成的自定義角色來授與存取權。

若要實作案例，建議您檢視驗證概念。總而言之，此安全性定義會透過能夠針對特定 API 和範圍進行訪問控制的物件，提供模型化應用程式的解決方案。

備註

此安全性定義需要使用 x-ms-client-id 標頭來指出應用程式要求存取的 Azure 地圖服務資源。這可以從地圖管理 API取得。

Authorization URL 專屬於 Azure 公用雲端實例。主權雲端具有唯一的授權 URL，Microsoft Entra ID 設定。 * 透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API，從 Azure 管理平面設定 Azure 角色型存取控制。 * Azure 地圖服務 Web SDK 的使用方式允許針對多個使用案例設定應用程式。

如需Microsoft身分識別平臺的詳細資訊，請參閱 Microsoft 身分識別平臺概觀。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

這是當您在 Azure 入口網站或使用 PowerShell、CLI、Azure SDK 或 REST API 建立 Azure 地圖服務帳戶時所佈建的共用密鑰。

使用此金鑰，任何應用程式都可以存取所有 REST API。換句話說，此金鑰可用來做為帳戶中核發的主要密鑰。

針對公開的應用程式，我們建議使用機密用戶端應用程式方法來存取 Azure 地圖服務 REST API，以便安全地儲存您的密鑰。

類型: apiKey
位於: query

SAS Token

這是透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API，從 azure 地圖服務資源列表 SAS 作業建立共用存取簽章令牌。

使用此令牌時，任何應用程式都有權使用 Azure 角色型訪問控制進行存取，並更精細地控制特定令牌的到期、速率和區域。換句話說，SAS 令牌可用來讓應用程式以比共用密鑰更安全的方式控制存取。

對於公開的應用程式，我們建議在對應帳戶資源上設定允許的來源特定清單，以限制轉譯濫用，並定期更新 SAS 令牌。

類型: apiKey
位於: header

範例

GetFeatures

範例要求

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

範例回覆

狀態碼:: 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"
    }
  ]
}

定義

名稱	Description
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
ExtendedGeoJsonFeatureCollection	以 numberReturned 和 links 陣列擴充的有效 `GeoJSON FeatureCollection` 物件類型。如需詳細資訊，請參閱 RFC 7946。
GeoJsonFeature	有效的 `GeoJSON Feature` 物件類型。如需詳細資訊，請參閱 RFC 7946。
GeoJsonGeometry	有效的 `GeoJSON` geometry 物件。此類型必須是七個有效的 GeoJSON 幾何類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon 和 GeometryCollection。如需詳細資訊，請參閱 RFC 7946。
GeoJsonGeometryCollection	有效的 `GeoJSON GeometryCollection` 物件類型。如需詳細資訊，請參閱 RFC 7946。
GeoJsonLineString	有效的 `GeoJSON LineString` 幾何類型。如需詳細資訊，請參閱 RFC 7946。
GeoJsonMultiLineString	有效的 `GeoJSON MultiLineString` 幾何類型。如需詳細資訊，請參閱 RFC 7946。
GeoJsonMultiPoint	有效的 `GeoJSON MultiPoint` 幾何類型。如需詳細資訊，請參閱 RFC 7946。
GeoJsonMultiPolygon	有效的 `GeoJSON MultiPolygon` 物件類型。如需詳細資訊，請參閱 RFC 7946。
GeoJsonObjectType	指定 `GeoJSON` 類型：FeatureCollection。
GeoJsonPoint	有效的 `GeoJSON Point` 幾何類型。如需詳細資訊，請參閱 RFC 7946。
GeoJsonPolygon	有效的 `GeoJSON Polygon` 幾何類型。如需詳細資訊，請參閱 RFC 7946。
WFSEndpointLink	其他 WFS 端點的連結

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

ExtendedGeoJsonFeatureCollection

Object

以 numberReturned 和 links 陣列擴充的有效 GeoJSON FeatureCollection 物件類型。如需詳細資訊，請參閱 RFC 7946。

名稱	類型	Description
features	GeoJsonFeature[]	包含有效的 `GeoJSON Feature` 物件清單。
links	WFSEndpointLink[]	其他 WFS 端點的連結。
numberReturned	integer	傳回的功能數目。
ontology	string	此數據集的本體版本。
type	GeoJsonObjectType	指定 `GeoJSON` 類型：FeatureCollection。

GeoJsonFeature

Object

有效的 GeoJSON Feature 物件類型。如需詳細資訊，請參閱 RFC 7946。

名稱	類型	Description
featureType	string	功能的類型。值取決於目前功能所屬的數據模型。某些數據模型可能有空白值。
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	有效的 `GeoJSON` geometry 物件。此類型必須是七個有效的 GeoJSON 幾何類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon 和 GeometryCollection。如需詳細資訊，請參閱 RFC 7946。
id	string	功能的標識碼。
type	string: Feature	指定 `GeoJSON` 類型。必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonGeometry

Object

有效的 GeoJSON geometry 物件。此類型必須是七個有效的 GeoJSON 幾何類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon 和 GeometryCollection。如需詳細資訊，請參閱 RFC 7946。

名稱	類型	Description
type	GeoJsonObjectType	指定 `GeoJSON` 類型。必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonGeometryCollection

Object

有效的 GeoJSON GeometryCollection 物件類型。如需詳細資訊，請參閱 RFC 7946。

名稱	類型	Description
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	包含有效的 `GeoJSON` geometry 物件清單。注意 GeoJSON 中的座標以 x、y 順序（經度、緯度）為單位。
type	string: GeometryCollection	指定 `GeoJSON` 類型。必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonLineString

Object

有效的 GeoJSON LineString 幾何類型。如需詳細資訊，請參閱 RFC 7946。

名稱	類型	Description
coordinates	number[] (double)	`GeoJson LineString` 幾何座標。
type	string: LineString	指定 `GeoJSON` 類型。必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonMultiLineString

Object

有效的 GeoJSON MultiLineString 幾何類型。如需詳細資訊，請參閱 RFC 7946。

名稱	類型	Description
coordinates	number[] (double)	`GeoJson MultiLineString` 幾何座標。
type	string: MultiLineString	指定 `GeoJSON` 類型。必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonMultiPoint

Object

有效的 GeoJSON MultiPoint 幾何類型。如需詳細資訊，請參閱 RFC 7946。

名稱	類型	Description
coordinates	number[] (double)	`GeoJson MultiPoint` 幾何座標。
type	string: MultiPoint	指定 `GeoJSON` 類型。必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonMultiPolygon

Object

有效的 GeoJSON MultiPolygon 物件類型。如需詳細資訊，請參閱 RFC 7946。

名稱	類型	Description
coordinates	number[] (double)	包含有效的 `GeoJSON Polygon` 物件清單。注意 GeoJSON 中的座標以 x、y 順序（經度、緯度）為單位。
type	string: MultiPolygon	指定 `GeoJSON` 類型。必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonObjectType

列舉型別

指定 GeoJSON 類型：FeatureCollection。

值	Description
FeatureCollection	`GeoJSON FeatureCollection` 物件

GeoJsonPoint

Object

有效的 GeoJSON Point 幾何類型。如需詳細資訊，請參閱 RFC 7946。

名稱	類型	Description
coordinates	number[] (double)	`Position` 是具有兩個或多個元素的數字數位數位數位。前兩個元素是經度和緯度，確切地依該順序排列。高度/高度是選擇性的第三個專案。如需詳細資訊，請參閱 RFC 7946。
type	string: Point	指定 `GeoJSON` 類型。必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonPolygon

Object

有效的 GeoJSON Polygon 幾何類型。如需詳細資訊，請參閱 RFC 7946。

名稱	類型	Description
coordinates	number[] (double)	`GeoJson Polygon` 幾何類型的座標。
type	string: Polygon	指定 `GeoJSON` 類型。必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

WFSEndpointLink

Object

其他 WFS 端點的連結

名稱	類型	Description
href	string	鏈接目標。
hreflang	string	指示取消參考連結結果語言的提示。
rel	string	關聯類型。
title	string	用來為連結的目的地加上標籤，使其可作為人類可讀取的標識碼（例如，功能表項），其位於 Content-Language 標頭字段所指出的語言中（如果有的話）。
type	string	提示，指出譯碼連結結果的媒體類型為何。

共用方式為

WFS - Get Features

提交取得功能要求

URI 參數

要求標頭

回應

安全性

AADToken

備註

範圍

subscription-key

SAS Token

範例

GetFeatures

範例要求

範例回覆

定義

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExtendedGeoJsonFeatureCollection

GeoJsonFeature

GeoJsonGeometry

GeoJsonGeometryCollection

GeoJsonLineString

GeoJsonMultiLineString

GeoJsonMultiPoint

GeoJsonMultiPolygon

GeoJsonObjectType

GeoJsonPoint

GeoJsonPolygon

WFSEndpointLink

其他資源