Conversion - Convert

Reference

Service:: Maps Creator

API Version:: 2.0

Use to convert a previously imported Drawing Package into map data.

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 Conversion API is an HTTP POST request that allows the caller import a set of DWG design files as a zipped Drawing Package into Azure Maps. The drawing package is referenced by the udid used when it was uploaded into the Data Registry. For more information on the data registry service, see How to create data registry.

Convert DWG package

The Conversion API performs a long-running operation.

Debug DWG package issues

During the Conversion process, if there are any issues with the DWG package errors and warnings are provided in the response along with a diagnostic package to visualize and diagnose these issues. In case any issues are encountered with your DWG package, the Conversion operation status process as detailed here returns the location of the diagnostic package that can be downloaded by the caller to help them visualize and diagnose these issues. The diagnostic package location can be found in the properties section of the conversion operation status response and looks like the following:

{
    "properties": {
        "diagnosticPackageLocation": "https://us.atlas.microsoft.com/mapdata/{DiagnosticPackageId}?api-version=1.0"                
    }            
}

The diagnostic package can be downloaded by executing a HTTP GET request on the diagnosticPackageLocation. For more details on how to use the tool to visualize and diagnose all the errors and warnings see Drawing Error Visualizer.

A conversion operation will be marked as success if there are zero or more warnings but will be marked as failed if any errors are encountered.

POST https://{geography}.atlas.microsoft.com/conversions?api-version=2.0&udid={udid}&outputOntology=facility-2.0

With optional parameters:

POST https://{geography}.atlas.microsoft.com/conversions?api-version=2.0&udid={udid}&outputOntology=facility-2.0&description={description}

URI Parameters

Name	In	Required	Type	Description
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.
outputOntology	query	True	OutputOntology	Output ontology version. "facility-2.0" is the only supported value at this time. Please refer to this article for more information about Azure Maps Creator ontologies.
udid	query	True	string	The unique data id (`udid`) for the content. Must be the same `udid` used when creating the Data registry.
description	query		string	User provided description of the content being converted.

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	LongRunningOperationResult	The operation is running or complete. If the operation was successful, use the Resource-Location header to obtain the path to the result. Headers Resource-Location: string
202 Accepted		Request Accepted: The request has been accepted for processing. Please use the URL in the Operation-Location Header to obtain status. Headers Operation-Location: string
Other Status Codes	ErrorResponse	An unexpected error occurred.

Name

Type

Description

200 OK

LongRunningOperationResult

The operation is running or complete. If the operation was successful, use the Resource-Location header to obtain the path to the result.

Headers

Resource-Location: string

202 Accepted

Request Accepted: The request has been accepted for processing. Please use the URL in the Operation-Location Header to obtain status.

Headers

Operation-Location: string

Other Status Codes

ErrorResponse

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

Convert previously uploaded DWG Package

Sample request

HTTP

POST https://us.atlas.microsoft.com/conversions?api-version=2.0&udid=25084fb7-307a-4720-8f91-7952a0b91012&outputOntology=facility-2.0

Sample response

Status code:: 200

Resource-Location: https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0

{
  "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
  "created": "2021-04-20T22:43:14.9401559+00:00",
  "status": "Succeeded"
}

Status code:: 202

Operation-Location: https://us.atlas.microsoft.com/conversions/operations/{operationId}?api-version=2.0
Access-Control-Expose-Headers: Operation-Location

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
LongRunningOperationResult	The response model for a Long-Running Operations API.
LroStatus	The status state of the request.
OutputOntology	Output ontology version. "facility-2.0" is the only supported value at this time. Please refer to this article for more information about Azure Maps Creator ontologies.

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	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

LongRunningOperationResult

The response model for a Long-Running Operations API.

Name	Type	Description
created	string	The created timestamp.
error	ErrorDetail	The error detail.
operationId	string	The Id for this long-running operation.
status	LroStatus	The status state of the request.
warning	ErrorDetail	The error detail.

LroStatus

The status state of the request.

Name	Type	Description
Failed	string	The request has one or more failures.
NotStarted	string	The request has not started processing yet.
Running	string	The request has started processing.
Succeeded	string	The request has successfully completed.

OutputOntology

Output ontology version. "facility-2.0" is the only supported value at this time. Please refer to this article for more information about Azure Maps Creator ontologies.

Name	Type	Description
facility-2.0	string	Facility ontology defines how Azure Maps Creator internally stores facility data in a Creator dataset.

Share via

Conversion - Convert

Convert DWG package

Debug DWG package issues

URI Parameters

Request Header

Responses

Security

AADToken

Notes

Scopes

subscription-key

SAS Token

Examples

Convert previously uploaded DWG Package

Sample request

Sample response

Definitions

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

LongRunningOperationResult

LroStatus

OutputOntology

Additional resources