Features - Get Collection Definition
を使用して、指定した機能コレクションの詳細なデータ モデルを取得します。
Features API は Creator の一部であり、Azure Maps API と SDK を使用して、プライベート 屋内マップ データに基づいてアプリケーションを開発できます。 機能 GET API は 、Open Geospatial Consortium API - Features - Part 1: Core corrigendum standard に従ってデータセットにクエリ を実行します。 データセットは、共通スキーマによって定義された特徴のグループである複数の 特徴 コレクションで構成されます。
コレクション定義の取得要求を送信する
Get Collection Definition
API は、指定collectionId
された によって定義されている機能コレクションの詳細なデータ モデルを返す HTTP GET
要求です。
GET https://{geography}.atlas.microsoft.com/features/datasets/{datasetId}/collections/{collectionId}/definition?api-version=2023-03-01-preview
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
collection
|
path | True |
string |
特定のコレクションの識別子 (名前)。 |
dataset
|
path | True |
string |
クエリの対象となるデータセットの識別子。 |
geography
|
path | True |
string |
このパラメーターは、Azure Maps Creator リソースの場所を指定します。 有効な値は、us と eu です。 |
api-version
|
query | True |
string |
Azure Maps API のバージョン番号。 |
要求ヘッダー
名前 | 必須 | 型 | 説明 |
---|---|---|---|
x-ms-client-id |
string |
Microsoft Entra ID セキュリティ モデルと組み合わせて使用するアカウントを指定します。 Azure Maps アカウントの一意の ID を表し、Azure Maps管理プレーン アカウント API から取得できます。 Azure MapsでMicrosoft Entra IDセキュリティを使用するには、次の記事を参照してください。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
[OK] |
|
Other Status Codes |
予期しないエラーが発生しました。 |
セキュリティ
AADToken
これらは Azure Active Directory OAuth2 フローです。 Azure ロールベースのアクセス制御と組み合わせて使用すると、Azure Maps REST API へのアクセスを制御できます。 Azure ロールベースのアクセス制御は、1 つ以上のAzure Mapsリソース アカウントまたはサブリソースへのアクセスを指定するために使用されます。 REST API に対する 1 つ以上のアクセス許可で構成される組み込みロールまたはカスタム ロールを使用して、任意のユーザー、グループ、またはサービス プリンシパルにアクセス権 Azure Mapsを付与できます。
シナリオを実装するには、 認証の概念を表示することをお勧めします。 要約すると、このセキュリティ定義は、特定の API とスコープに対するアクセス制御が可能なオブジェクトを使用してアプリケーションをモデル化するためのソリューションを提供します。
メモ
- このセキュリティ定義では、 ヘッダーを使用して、
x-ms-client-id
アプリケーションがアクセスを要求しているリソースAzure Maps示す必要があります。 これは、 Maps 管理 API から取得できます。
Authorization URL
は、Azure パブリック クラウド インスタンスに固有です。 ソブリン クラウドには、一意の承認 URL と Azure Active Directory 構成があります。
* Azure ロールベースのアクセス制御は、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して Azure 管理プレーンから構成されます。
* Azure Maps Web SDK を使用すると、複数のユース ケースに対してアプリケーションを構成ベースで設定できます。
- 現在、Azure Active Directory v1.0 または v2.0 は職場、学校、ゲストをサポートしていますが、個人用アカウントはサポートしていません。
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
これは、Azure portal、PowerShell、CLI、Azure SDK、または REST API を使用して Azure 管理プレーンを介してAzure Maps リソースを作成するときにプロビジョニングされる共有キーです。
このキーを使用すると、すべてのアプリケーションがすべての REST API にアクセスする権限が与えられている。 つまり、これらは現在、発行先のアカウントのマスター キーとして扱うことができます。
パブリックに公開されているアプリケーションの場合、このキーを安全に格納できる REST API のサーバー間アクセスAzure Maps使用することをお勧めします。
型:
apiKey
/:
query
SAS Token
これは、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して、Azure 管理プレーンを介して、Azure Maps リソースの List SAS 操作から作成される共有アクセス署名トークンです。
このトークンを使用すると、すべてのアプリケーションが Azure ロールベースのアクセス制御を使用してアクセスし、特定のトークンに使用される有効期限、レート、およびリージョンをきめ細かく制御できます。 つまり、SAS トークンを使用して、アプリケーションが共有キーよりもセキュリティで保護された方法でアクセスを制御できるようにします。
公開されているアプリケーションの場合、 Map アカウント リソース で許可される配信元の特定の一覧を構成して、レンダリングの不正使用を制限し、SAS トークンを定期的に更新することをお勧めします。
型:
apiKey
/:
header
例
GetCollectionDefinition
要求のサンプル
GET https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/definition?api-version=2023-03-01-preview
応答のサンプル
{
"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"
}
]
}
定義
名前 | 説明 |
---|---|
Collection |
コレクションの定義を読み取る要求が成功した後の応答。 |
Definition |
コレクション内のプロパティの定義。 |
Error |
リソース管理エラーの追加情報。 |
Error |
エラーの詳細。 |
Error |
エラー応答 |
Features |
他の機能エンドポイントへのリンク。 リンク関係の詳細については、 OGC API - 機能 - パート 1 標準に関するページを参照してください。 |
Geo |
返されるジオメトリの型。 |
CollectionDefinitionResult
コレクションの定義を読み取る要求が成功した後の応答。
名前 | 型 | 説明 |
---|---|---|
description |
string |
コレクションについて説明します。 |
geometryType |
返されるジオメトリの型。 |
|
id |
string |
URI などで使用されるコレクションの識別子。 |
itemType |
string |
コレクション内のアイテムの種類です。 |
links |
他の機能エンドポイントへのリンク。 |
|
ontology |
string |
このデータセットのオントロジ バージョン。 |
properties |
使用されるコレクションの属性。 |
|
title |
string |
コレクションのタイトル。 |
DefinitionProperty
コレクション内のプロパティの定義。
名前 | 型 | 説明 |
---|---|---|
name |
string |
属性の名前。 |
required |
boolean |
属性が必要です。 |
type |
object |
属性の型。 |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
名前 | 型 | 説明 |
---|---|---|
info |
object |
追加情報。 |
type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
additionalInfo |
エラーの追加情報。 |
|
code |
string |
エラー コード。 |
details |
エラーの詳細です。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーのターゲット。 |
ErrorResponse
エラー応答
名前 | 型 | 説明 |
---|---|---|
error |
error オブジェクト。 |
FeaturesEndpointLink
他の機能エンドポイントへのリンク。 リンク関係の詳細については、 OGC API - 機能 - パート 1 標準に関するページを参照してください。
名前 | 型 | 説明 |
---|---|---|
href |
string |
リンク 先。 |
rel |
string |
関係の種類。 |
title |
string |
リンクの宛先にラベルを付けるために使用され、Content-Language ヘッダー フィールド (存在する場合) によって示される言語で、人間が判読できる識別子 (メニュー エントリなど) として使用できます。 |
GeoJsonGeometryType
返されるジオメトリの型。
名前 | 型 | 説明 |
---|---|---|
GeometryCollection |
string |
|
LineString |
string |
|
MultiLineString |
string |
|
MultiPoint |
string |
|
MultiPolygon |
string |
|
Point |
string |
|
Polygon |
string |
|