Azure Maps Conversion Service (preview:2.0)

2025/08/14 • 5 deleted methods

Conversion_Convert (removed)
Description :  **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator. The Conversion API lets the caller import a set of DWG design files as a zipped [Drawing Package](https://aka.ms/am-drawing-package) into Azure Maps. The [Drawing Package](https://aka.ms/am-drawing-package) should first be uploaded using the [Azure Maps Data Service](https://docs.microsoft.com/rest/api/maps/data). Once uploaded, use the `udid` returned by the [Data Upload API](https://docs.microsoft.com/rest/api/maps/data-v2/upload-preview) to call this Conversion API. ## Convert DWG package The Conversion API performs a [long-running operation](https://aka.ms/am-creator-lrt-v2). ## Debug DWG package issues During the Conversion process, if there are any issues with the DWG package [errors and warnings](https://aka.ms/am-conversion-errors) 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](https://aka.ms/am-creator-lrt-v2) 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: ```json { "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](https://aka.ms/am-drawing-errors-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.
Reference :  Link ¶

⚼ Request

POST:  /conversions
{
x-ms-client-id:
{
Description: 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](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 2.0 ,
Required: True ,
}
string ,
udid:
{
Description: The unique data id for the content. The `udid` must have been obtained from a successful [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data-v2/upload-preview) call. ,
Required: True ,
}
string ,
outputOntology:
{
Description: Output ontology version. "facility-2.0" is the only supported value at this time. Please refer to this [article](https://docs.microsoft.com/en-us/azure/azure-maps/creator-facility-ontology) for more information about Azure Maps Creator ontologies. ,
Required: True ,
}
string ,
description:
{
Description: User provided description of the content being converted. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
operation-location:
{
Description: New URL to check for the results of the [long-running operation](https://aka.ms/am-creator-lrt-v2). ,
}
string ,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Conversion_List (removed)
Description :  **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator. This API allows the caller to fetch a list of all successful data conversions submitted previously using the [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/v2/conversion/convert). ### Submit List Request To list all successful conversions you will issue a `GET` request with no additional parameters. ### List Data Response The Conversion List API returns the complete list of all conversion details in `json` format.
Here is a sample response returning the details of two successful conversion requests:
```json { "conversions": [ { "conversionId": "54398242-ea6c-1f31-4fa6-79b1ae0fc24d", "udid": "31838736-8b84-11ea-bc55-0242ac130003", "created": "5/19/2020 9:00:00 AM +00:00", "description": "User provided description.", "featureCounts": { "DIR": 1, "LVL": 3, "FCL": 1, "UNIT": 150, "CTG": 8, "AEL": 0, "OPN": 10 } }, { "conversionId": "2acf7d32-8b84-11ea-bc55-0242ac130003", "udid": "1214bc58-8b84-11ea-bc55-0242ac1300039", "created": "5/19/2020 9:00:00 AM +00:00", "description": "User provided description.", "featureCounts": { "DIR": 1, "LVL": 3, "FCL": 1, "UNIT": 150, "CTG": 8, "AEL": 0, "OPN": 10 } } ] } ```
Reference :  Link ¶

⚼ Request

GET:  /conversions
{
x-ms-client-id:
{
Description: 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](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 2.0 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
conversions:
{
Description: A list of all the previously submitted conversion requests. ,
Required: False ,
}
[
{
conversionId:
{
Description: A unique id that represents the artifact of a _successfully_ completed conversion process. ,
Required: False ,
}
string ,
ontology:
{
Description: The ontology version of this dataset. ,
Required: False ,
}
string ,
udid:
{
Description: The unique id of the content provided to create this conversion. ,
Required: False ,
}
string ,
created:
{
Description: The date and time of this conversion. ,
Required: False ,
}
string ,
description:
{
Description: User provided description of the content being converted. ,
Required: False ,
}
string ,
featureCounts:
{
Description: A summary of feature counts in this conversion. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: If present, the location of the next page of data. ,
Required: False ,
}
string ,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Conversion_Get (removed)
Description :  **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator. This API allows the caller to fetch a successful data conversion submitted previously using the [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/v2/conversion/convert).
Reference :  Link ¶

⚼ Request

GET:  /conversions/{conversionId}
{
x-ms-client-id:
{
Description: 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](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 2.0 ,
Required: True ,
}
string ,
conversionId:
{
Description: The conversion id for the content. The `conversionId` must have been obtained from a successful [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/v2/conversion/convert) call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
conversionId:
{
Description: A unique id that represents the artifact of a _successfully_ completed conversion process. ,
Required: False ,
}
string ,
ontology:
{
Description: The ontology version of this dataset. ,
Required: False ,
}
string ,
udid:
{
Description: The unique id of the content provided to create this conversion. ,
Required: False ,
}
string ,
created:
{
Description: The date and time of this conversion. ,
Required: False ,
}
string ,
description:
{
Description: User provided description of the content being converted. ,
Required: False ,
}
string ,
featureCounts:
{
Description: A summary of feature counts in this conversion. ,
Required: False ,
}
object ,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Conversion_Delete (removed)
Description :  **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator. This API allows the caller to delete any data conversions created previously using the [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/v2/conversion/convert). ### Submit Delete Request To delete your conversion data you will issue a `DELETE` request where the path will contain the `conversionId` of the data to delete. ### Conversion Delete Response The Conversion Delete API returns a HTTP `204 No Content` response with an empty body, if the converted data resources were deleted successfully.
A HTTP `400 Bad Request` error response will be returned if no resource associated with the passed-in `conversionId` is found.
Reference :  Link ¶

⚼ Request

DELETE:  /conversions/{conversionId}
{
x-ms-client-id:
{
Description: 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](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 2.0 ,
Required: True ,
}
string ,
conversionId:
{
Description: The conversion id for the content. The `conversionId` must have been obtained from a successful [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/v2/conversion/convert) call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Conversion_GetOperation (removed)
Description :  This path will be obtained from a call to POST /conversions. While in progress, an http200 will be returned with no extra headers - followed by an http200 with Resource-Location header once successfully completed.
Reference :  Link ¶

⚼ Request

GET:  /conversions/operations/{operationId}
{
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 2.0 ,
Required: True ,
}
string ,
operationId:
{
Description: The ID to query the status for the Conversion create/import request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
resource-location:
{
Description: If successful, a URI where details on the newly created resource can be found. ,
}
string ,
}
,
$schema:
{
Description: The response model for a Long-Running Operations API. ,
}
{
operationId:
{
Description: The Id for this long-running operation. ,
Required: False ,
}
string ,
status:
{
Description: The status state of the request. ,
Enum:
{
NotStarted: The request has not started processing yet. ,
Running: The request has started processing. ,
Failed: The request has one or more failures. ,
Succeeded: The request has successfully completed. ,
}
,
Required: False ,
}
enum ,
created:
{
Description: The created timestamp. ,
Required: False ,
}
string ,
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
warning:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}