共用方式為


WFS - Get Features

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

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

WFS API 遵循 Open Geospatial Consortium API standard for Features to query Datasets

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

提交取得功能要求

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 地圖服務 Creator 資源所在的位置。 有效值為us和 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 經度/緯度,值在大部分情況下都是最小經度、最小緯度、最大經度和最大緯度序列。 不過,如果方塊跨越時間ridian 第一個值, (最西部的方塊邊緣) 大於第三個值, (最東部的方塊邊緣) 。
filter
query

string

篩選表達式,以搜尋具有指定集合中特定屬性值的功能。 只支援純量類型和等號運算子的功能屬性。 這是特殊參數,其中參數名稱是區分大小寫的屬性名稱。 此參數的配置為 {property name}={property value}。 除非 「filter」 是集合中的其中一個屬性名稱,否則不應該使用 「filter」 做為參數名稱。 若要搜尋 「name」 屬性值為 「21N13」 的功能,請使用 「name=21N13」。。 支援多個篩選條件,且應以多個查詢參數表示。 例如, =&= 字串值區分大小寫。

limit
query

integer

選擇性限制參數會限制回應檔中呈現的功能數目。 只會計算回應檔中集合第一層的功能。 不應計算明確要求之功能中包含的巢狀物件。

  • 最小值 = 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

這些是 OAuth 2.0 流程 Microsoft Entra。 與 Azure 角色型存取控制配對時,可用來控制對 #DCBA8D6D481B54275A4389F2E5A4E86D1 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 的使用方式允許針對多個使用案例設定應用程式設定。

類型: 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 管理平面透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API,從 Azure 地圖服務 資源上的列出 SAS 作業建立的共用存取簽章令牌。

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

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

類型: apiKey
位於: header

範例

GetFeatures

範例要求

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

範例回覆

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

資源管理錯誤其他資訊。

名稱 類型 Description
info

object

其他資訊。

type

string

其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱 類型 Description
additionalInfo

ErrorAdditionalInfo[]

錯誤其他資訊。

code

string

錯誤碼。

details

ErrorDetail[]

錯誤詳細資料。

message

string

錯誤訊息。

target

string

錯誤目標。

ErrorResponse

錯誤回應

名稱 類型 Description
error

ErrorDetail

錯誤物件。

ExtendedGeoJsonFeatureCollection

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

名稱 類型 Description
features

GeoJsonFeature[]

包含有效 GeoJSON Feature 對象的清單。

links

WFSEndpointLink[]

其他 WFS 端點的連結。

numberReturned

integer

傳回的功能數目。

ontology

string

此數據集的本體版本。

type

GeoJsonObjectType

指定 GeoJSON 類型:FeatureCollection。

GeoJsonFeature

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

名稱 類型 Description
featureType

string

功能的類型。 值取決於目前功能所屬的數據模型。 某些數據模型可能會有空的值。

geometry GeoJsonGeometry:

有效的 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

有效的 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

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

名稱 類型 Description
geometries GeoJsonGeometry[]:

包含有效 GeoJSON geometry 物件的清單。 請注意 ,GeoJSON 中的座標以 x、y 順序 (經度、緯度) 。

type string:

GeometryCollection

指定 GeoJSON 類型。 必須是九個有效 GeoJSON 物件類型的其中一種: Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonLineString

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

名稱 類型 Description
coordinates

number[]

幾何的 GeoJson LineString 座標。

type string:

LineString

指定 GeoJSON 類型。 必須是九個有效 GeoJSON 物件類型的其中一種: Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonMultiLineString

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

名稱 類型 Description
coordinates

number[]

幾何的 GeoJson MultiLineString 座標。

type string:

MultiLineString

指定 GeoJSON 類型。 必須是九個有效 GeoJSON 物件類型的其中一種: Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonMultiPoint

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

名稱 類型 Description
coordinates

number[]

幾何的 GeoJson MultiPoint 座標。

type string:

MultiPoint

指定 GeoJSON 類型。 必須是九個有效 GeoJSON 物件類型的其中一種: Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonMultiPolygon

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

名稱 類型 Description
coordinates

number[]

包含有效 GeoJSON Polygon 對象的清單。 請注意 ,GeoJSON 中的座標以 x、y 順序 (經度、緯度) 。

type string:

MultiPolygon

指定 GeoJSON 類型。 必須是九個有效 GeoJSON 物件類型的其中一種: Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonObjectType

指定 GeoJSON 類型:FeatureCollection。

名稱 類型 Description
FeatureCollection

string

GeoJSON FeatureCollection 物件

GeoJsonPoint

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

名稱 類型 Description
coordinates

number[]

Position是具有兩個或多個元素的數位數位數位數位。 前兩個元素是 經度緯度,精確地以該順序排列。 高度/提高 許可權是選擇性的第三個元素。 如需詳細資訊,請參閱 RFC 7946

type string:

Point

指定 GeoJSON 類型。 必須是九個有效 GeoJSON 物件類型的其中一種: Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonPolygon

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

名稱 類型 Description
coordinates

number[]

GeoJson Polygon幾何類型的座標。

type string:

Polygon

指定 GeoJSON 類型。 必須是九個有效 GeoJSON 物件類型的其中一種: Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

其他 WFS 端點的連結

名稱 類型 Description
href

string

鏈接目標。

hreflang

string

指出取值連結結果語言的提示。

rel

string

關聯類型。

title

string

用來標記連結的目的地,使其可作為人類可讀取的標識碼 (例如,如果存在) ,則以 Content-Language 標頭欄位所指示的語言) 菜單項 (。

type

string

提示,指出取值連結結果的媒體類型應該是什麼。