Features - Get Collection Definition
Use to get a detailed data model of the specified feature collection.
The Features API is a part of Creator, which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the Open Geospatial Consortium API - Features - Part 1: Core corrigendum standard to query Datasets. Datasets consist of multiple feature collections, which are a grouping of features defined by a common schema.
Submit Get Collection Definition Request
The Get Collection Definition
API is an HTTP GET
request that returns a detailed data model of a feature collection as defined by the provided collectionId
.
GET https://{geography}.atlas.microsoft.com/features/datasets/{datasetId}/collections/{collectionId}/definition?api-version=2023-03-01-preview
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
collection
|
path | True |
string |
Identifier (name) of a specific collection. |
dataset
|
path | True |
string |
The identifier for the dataset to query from. |
geography
|
path | True |
string |
This parameter specifies where the Azure Maps Creator resource is located. Valid values are us and eu. |
api-version
|
query | True |
string |
Version number of Azure Maps API. |
Request Header
Name | Required | Type | Description |
---|---|---|---|
x-ms-client-id |
string |
Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following articles for guidance. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Ok |
|
Other Status Codes |
An unexpected error occurred. |
Security
AADToken
These are the Azure Active Directory OAuth2 Flows. When paired with Azure role-based access control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.
To implement scenarios, we recommend viewing authentication concepts. In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.
Notes
- This security definition requires the use of the
x-ms-client-id
header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the Maps management API.
The Authorization URL
is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations.
*
The Azure role-based access control is configured from the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.
*
Usage of the Azure Maps Web SDK allows for configuration based setup of an application for multiple use cases.
- Currently, Azure Active Directory v1.0 or v2.0 supports Work, School, and Guests but does not support Personal accounts.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
This is a shared key that is provisioned when creating an Azure Maps resource through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.
With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.
For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.
Type:
apiKey
In:
query
SAS Token
This is a shared access signature token is created from the List SAS operation on the Azure Maps resource through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.
With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.
For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the Map account resource to limit rendering abuse and regularly renew the SAS Token.
Type:
apiKey
In:
header
Examples
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
{
"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"
}
]
}
Definitions
Name | Description |
---|---|
Collection |
Response after a successful request to read a collection's definition. |
Definition |
The definition of a property in a collection. |
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
Features |
Links to other Features endpoints. For more details about link relations, please visit the OGC API - Features - Part 1 standard. |
Geo |
Type of geometry returned. |
CollectionDefinitionResult
Response after a successful request to read a collection's definition.
Name | Type | Description |
---|---|---|
description |
string |
Describes the collection. |
geometryType |
Type of geometry returned. |
|
id |
string |
Identifier of the collection used, for example, in URIs. |
itemType |
string |
The type of the items in the collection. |
links |
Links to other Features endpoints. |
|
ontology |
string |
The ontology version of this dataset. |
properties |
Attributes of the collection used. |
|
title |
string |
Title of collection. |
DefinitionProperty
The definition of a property in a collection.
Name | Type | Description |
---|---|---|
name |
string |
Name of attribute. |
required |
boolean |
Is attribute required. |
type |
object |
Type of attribute. |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
ErrorDetail
The error detail.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
ErrorResponse
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |
FeaturesEndpointLink
Links to other Features endpoints. For more details about link relations, please visit the OGC API - Features - Part 1 standard.
Name | Type | Description |
---|---|---|
href |
string |
The link target. |
rel |
string |
The relation type. |
title |
string |
Used to label the destination of a link such that it can be used as a human-readable identifier (e.g., a menu entry) in the language indicated by the Content-Language header field (if present). |
GeoJsonGeometryType
Type of geometry returned.
Name | Type | Description |
---|---|---|
GeometryCollection |
string |
|
LineString |
string |
|
MultiLineString |
string |
|
MultiPoint |
string |
|
MultiPolygon |
string |
|
Point |
string |
|
Polygon |
string |
|