WFS - Get Collection Definition
Use to get a detailed data model of a collection.
Note
Azure Maps Creator retirement
The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see End of Life Announcement of Azure Maps Creator.
The Get Collection Definition
API is an HTTP GET
request that provides a detailed data model of the specified collection.
The WFS API follows the Open Geospatial Consortium API standard for Features to query Datasets.
A dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.
###Submit Get Collection Definition Request
GET https://{geography}.atlas.microsoft.com/wfs/datasets/{datasetId}/collections/{collectionId}/definition?api-version=2.0
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 Microsoft Entra OAuth 2.0 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 Microsoft Entra ID 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.
- For more information on Microsoft identity platform, see Microsoft identity platform overview.
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 you Create an Azure Maps account in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.
With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.
For publicly exposed applications, our recommendation is to use the confidential client applications approach to access Azure Maps REST APIs so your 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/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/definition?api-version=2.0
Sample response
{
"idPrefix": "UNIT",
"name": "unit",
"description": "A physical and non-overlapping area which might be occupied and traversed by a navigating agent. Can be a hallway, a room, a courtyard, etc. It is surrounded by physical obstruction (wall), unless the isOpenArea attribute is equal to true, and one must add openings where the obstruction shouldn't be there. If isOpenArea attribute is equal to true, all the sides are assumed open to the surroundings and walls are to be added where needed. Walls for open areas are represented as a lineElement or areaElement with isObstruction equal to true.",
"ontology": "Facility-2.0",
"geometryType": "Polygon",
"featureTypes": [],
"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": "navigableBy",
"required": false,
"type": {
"array": {
"enum": [
"pedestrian",
"wheelchair",
"machine",
"bicycle",
"automobile",
"hiredAuto",
"bus",
"railcar",
"emergency",
"ferry",
"boat"
]
}
}
},
{
"name": "isRoutable",
"required": false,
"type": "boolean"
},
{
"name": "routeThroughBehavior",
"required": false,
"type": {
"enum": [
"disallowed",
"allowed",
"preferred"
]
}
},
{
"name": "nonPublic",
"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/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/definition?api-version=2.0",
"rel": "self",
"title": "Metadata catalogue for unit"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2.0",
"rel": "data",
"title": "unit"
}
]
}
Definitions
Name | Description |
---|---|
Collection |
collection of GeoJSON features |
Definition |
|
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
Geo |
type of geometry returned |
WFSEndpoint |
Links to other WFS endpoints |
CollectionDefinition
collection of GeoJSON features
Name | Type | Description |
---|---|---|
description |
string |
describes the collection |
featureTypes |
string[] |
type of features returned |
geometryType |
type of geometry returned |
|
idPrefix |
string |
prefix of the collection used |
links |
Links to other WFS endpoints. |
|
name |
string |
identifier of the collection used, for example, in URIs |
ontology |
string |
The ontology version of this dataset. |
properties |
attributes of the collection used |
|
title |
string |
title of collection |
DefinitionProperty
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. |
GeoJsonGeometryType
type of geometry returned
Name | Type | Description |
---|---|---|
GeometryCollection |
string |
|
LineString |
string |
|
MultiLineString |
string |
|
MultiPoint |
string |
|
MultiPolygon |
string |
|
Point |
string |
|
Polygon |
string |
|
WFSEndpointLink
Links to other WFS endpoints
Name | Type | Description |
---|---|---|
href |
string |
The link target. |
hreflang |
string |
A hint indicating what the language of the result of dereferencing the link should be. |
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). |
type |
string |
A hint indicating what the media type of the result of dereferencing the link should be. |