Features - Get Collection Definition

  • 參考
Service:
Maps Creator
API Version:
2023-03-01-preview

使用 取得指定之特徵集合的詳細數據模型。

功能 API 是 Creator 的一部分，可讓您使用 Azure 地圖服務 API 和 SDK，根據私人室內地圖數據開發應用程式。 功能 GET API 遵循 開放式地理空間聯盟 API - 功能 - 第 1 部分：核心更正 標準來查詢 數據集。 數據集是由多個功能集合所組成，這些集合是由通用架構所定義的 功能 群組。

提交取得集合定義要求

Get Collection Definition API 是 HTTP GET 要求，會傳回所提供 collectionId所定義之功能集合的詳細數據模型。

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

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 的版本號碼。

要求標頭

名稱 必要 類型 Description
x-ms-client-id

string

指定哪個帳戶與 Microsoft Entra ID 安全性模型搭配使用。 它代表 Azure 地圖服務 帳戶的唯一標識符，而且可以從 Azure 地圖服務 管理平面帳戶 API 擷取。 若要在 Azure 地圖服務 中使用 Microsoft Entra ID 安全性，請參閱下列文章以取得指引。

回應

名稱 類型 Description
200 OK

CollectionDefinitionResult

確定
Other Status Codes

ErrorResponse

發生意外錯誤。

安全性

AADToken

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

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

備註

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

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

  • 目前，Azure Active Directory v1.0 或 v2.0 支援公司、學校和來賓，但不支持個人帳戶。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

subscription-key

這是透過 Azure 管理平面透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API 建立 Azure 地圖服務 資源時所佈建的共用密鑰。

使用此金鑰時，任何應用程式都會獲得存取所有 REST API 的授權。 換句話說，這些目前可視為發行帳戶的主要密鑰。

對於公開的應用程式，我們建議使用可安全地儲存此密鑰之 Azure 地圖服務 REST API 的伺服器對伺服器存取。

Type: apiKey
In: query

SAS Token

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

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

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

Type: apiKey
In: header

範例

GetCollectionDefinition

Sample Request

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

Sample Response

Status code:
200 
{
  "id": "unit",
  "title": "Unit",
  "description": "The unit feature class defines a physical and non-overlapping area that can be occupied and traversed by a navigating agent. A unit can be a hallway, a room, a courtyard, and so on.",
  "ontology": "Facility-2.0",
  "geometryType": "Polygon",
  "properties": [
    {
      "name": "externalId",
      "required": false,
      "type": "text"
    },
    {
      "name": "originalId",
      "required": false,
      "type": "text"
    },
    {
      "name": "categoryId",
      "required": true,
      "type": {
        "featureId": "category"
      }
    },
    {
      "name": "isOpenArea",
      "required": false,
      "type": "boolean"
    },
    {
      "name": "isRoutable",
      "required": false,
      "type": "boolean"
    },
    {
      "name": "levelId",
      "required": true,
      "type": {
        "featureId": "level"
      }
    },
    {
      "name": "occupants",
      "required": false,
      "type": {
        "array": {
          "featureId": "directoryInfo"
        }
      }
    },
    {
      "name": "addressId",
      "required": false,
      "type": {
        "featureId": "directoryInfo"
      }
    },
    {
      "name": "addressRoomNumber",
      "required": false,
      "type": "text"
    },
    {
      "name": "name",
      "required": false,
      "type": "text"
    },
    {
      "name": "nameSubtitle",
      "required": false,
      "type": "text"
    },
    {
      "name": "nameAlt",
      "required": false,
      "type": "text"
    },
    {
      "name": "anchorPoint",
      "required": false,
      "type": {
        "geometry": [
          "Point"
        ],
        "isFragmented": false,
        "srid": 4326
      }
    }
  ],
  "links": [
    {
      "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/definition",
      "rel": "self",
      "title": "Metadata catalogue for unit"
    },
    {
      "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items",
      "rel": "items",
      "title": "Unit"
    }
  ]
}

定義

名稱 Description
CollectionDefinitionResult

成功要求讀取集合定義之後的回應。
DefinitionProperty

集合中屬性的定義。
ErrorAdditionalInfo

資源管理錯誤其他資訊。
ErrorDetail

錯誤詳細數據。
ErrorResponse

錯誤回應
FeaturesEndpointLink

其他功能端點的連結。 如需連結關聯的詳細資訊，請造訪 OGC API - 功能 - 第 1 部分 標準。
GeoJsonGeometryType

傳回的幾何類型。

CollectionDefinitionResult

成功要求讀取集合定義之後的回應。

名稱 類型 Description
description

string

描述集合。
geometryType

GeoJsonGeometryType

傳回的幾何類型。
id

string

例如，URI 中所使用的集合標識符。
itemType

string

集合中項目的類型。
links

FeaturesEndpointLink[]

其他功能端點的連結。
ontology

string

此數據集的本體版本。
properties

DefinitionProperty[]

所使用集合的屬性。
title

string

集合的標題。

DefinitionProperty

集合中屬性的定義。

名稱 類型 Description
name

string

屬性的名稱。
required

boolean

為必要屬性。
type

object

屬性的類型。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱 類型 Description
info

object

其他資訊。
type

string

其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱 類型 Description
additionalInfo

ErrorAdditionalInfo[]

錯誤其他資訊。
code

string

錯誤碼。
details

ErrorDetail[]

錯誤詳細資料。
message

string

錯誤訊息。
target

string

錯誤目標。

ErrorResponse

錯誤回應

名稱 類型 Description
error

ErrorDetail

錯誤物件。

其他功能端點的連結。 如需連結關聯的詳細資訊，請造訪 OGC API - 功能 - 第 1 部分 標準。

名稱 類型 Description
href

string

鏈接目標。
rel

string

關聯類型。
title

string

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

GeoJsonGeometryType

傳回的幾何類型。

名稱 類型 Description
GeometryCollection

string

GeoJSON GeometryCollection 幾何。
LineString

string

GeoJSON LineString 幾何。
MultiLineString

string

GeoJSON MultiLineString 幾何。
MultiPoint

string

GeoJSON MultiPoint 幾何。
MultiPolygon

string

GeoJSON MultiPolygon 幾何。
Point

string

GeoJSON Point 幾何。
Polygon

string

GeoJSON Polygon 幾何。