Azure Maps Conversion Service (preview:2023-03-01)

2025/10/06 • 5 deleted methods

Conversion_Create (removed)
Description :  > [!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](https://aka.ms/AzureMapsCreatorDeprecation). The `Conversion` API is an HTTP `POST` request that allows 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 is referenced by the `udid` used when it was uploaded into the [Data Registry](/rest/api/maps/data). For more information on the data registry service, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries). ## 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: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
udid:
{
Description: The unique data id (`udid`) for the content. Must be the same `udid` used when creating the [Data registry](/rest/api/maps/data-registry/register-or-replace). ,
Required: True ,
}
string ,
dwgPackageVersion:
{
Description: The drawing package version. ,
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. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Conversion_List (removed)
Description :  > [!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](https://aka.ms/AzureMapsCreatorDeprecation). ### 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: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
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 (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Conversion_Get (removed)
Description :  > [!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](https://aka.ms/AzureMapsCreatorDeprecation). ### Submit Get Request The `Get` API is an HTTP `GET` request that allows the caller to fetch a successful data conversion previously submitted using the [Conversion Service](/rest/api/maps-creator/conversion/convert).
Reference :  Link ¶

⚼ Request

GET:  /conversions/{conversionId}
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
conversionId:
{
Description: The conversion id for the content. The `conversionId` must have been obtained from a successful [Conversion API](/rest/api/maps-creator/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 (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Conversion_Delete (removed)
Description :  > [!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](https://aka.ms/AzureMapsCreatorDeprecation). ### Submit Delete Request To delete your conversion data you will issue a `DELETE` request where the path contains 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: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
conversionId:
{
Description: The conversion id for the content. The `conversionId` must have been obtained from a successful [Conversion API](/rest/api/maps-creator/conversion/convert) call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Conversion_GetOperation (removed)
Description :  > [!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](https://aka.ms/AzureMapsCreatorDeprecation). ### Submit Get Operation Request The `Get Operation` API is an HTTP `GET` request that allows the caller to check the status of a [conversion](/rest/api/maps-creator/conversion/convert) process and retrieve the `conversionId` value. This path will be obtained from a call to POST /conversions. While in progress, an HTTP 200 response code will be returned with no extra headers - followed by an HTTP 200 response code with a `Resource-Location` header once successfully completed.
Reference :  Link ¶

⚼ Request

GET:  /conversions/operations/{operationId}
{
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID to query the status for the Conversion create/import request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The error detail. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
warning:
{
Description: The error detail. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}