Azure Maps Routeset Service. (preview:2022-09-01)

2025/10/06 • 5 deleted methods

Routeset_Create (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. See the [Creator for indoor maps](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article for an introduction to the Azure Maps Creator concepts and tools. This API allows the caller to create routeset data from a dataset. Use the routeset API to create special data structures consumed by the Azure Maps Wayfinding service to discover the shortest paths within a facility. ### Submit Create Request To create a routeset, make a `POST` request with an empty body. The dataset is used as the source of the routeset data, so the `datasetId` query parameter must be included. The Create Routeset API is a [long-running operation](https://aka.ms/am-creator-lrt-v2).
Reference :  Link ¶

⚼ Request

POST:  /routesets
{
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 ,
datasetId:
{
Description: The ID of the dataset from which to create the routeset(s). A routeset is created for each facility in the dataset. ,
Required: True ,
}
string ,
description:
{
Description: User provided description of the routeset. ,
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 ,
}
,
]
,
}
,
}
Routeset_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. See the [Creator for indoor maps](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article for an introduction to the Azure Maps Creator concepts and tools. This API allows the caller to fetch a list of all routesets in the current Azure Maps Creator account.
Reference :  Link ¶

⚼ Request

GET:  /routesets
{
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)

{
routesets:
{
Description: The list of all routesets. ,
Required: False ,
}
[
{
routesetId:
{
Description: The unique ID of the routeset. ,
Required: False ,
}
string ,
datasetId:
{
Description: The ID of the dataset used to create this routeset. ,
Required: False ,
}
string ,
description:
{
Description: The description code for the building with the ontology version number. ,
Required: False ,
}
string ,
facilities:
{
Description: The facility information and building level ordinal numbers. ,
Required: False ,
}
[
{
facilityId:
{
Description: The identifier of the structure this routeset was created from. ,
Required: False ,
}
string ,
levelOrdinals:
{
Description: The level identifiers within this facility. ,
Required: False ,
}
[
number ,
]
,
}
,
]
,
created:
{
Description: The date and time the routeset object was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Routeset_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. See the [Creator for indoor maps](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article for an introduction to the Azure Maps Creator concepts and tools. This API allows the caller to fetch a routeset.
Reference :  Link ¶

⚼ Request

GET:  /routesets/{routesetId}
{
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 ,
routesetId:
{
Description: The ID of the routeset to query for. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
routesetId:
{
Description: The unique ID of the routeset. ,
Required: False ,
}
string ,
datasetId:
{
Description: The ID of the dataset used to create this routeset. ,
Required: False ,
}
string ,
description:
{
Description: The description code for the building with the ontology version number. ,
Required: False ,
}
string ,
facilities:
{
Description: The facility information and building level ordinal numbers. ,
Required: False ,
}
[
{
facilityId:
{
Description: The identifier of the structure this routeset was created from. ,
Required: False ,
}
string ,
levelOrdinals:
{
Description: The level identifiers within this facility. ,
Required: False ,
}
[
number ,
]
,
}
,
]
,
created:
{
Description: The date and time the routeset object was created. ,
Format: date-time ,
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 ,
}
,
]
,
}
,
}
Routeset_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. See the [Creator for indoor maps](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article for an introduction to the Azure Maps Creator concepts and tools. This API allows the caller to delete an existing routeset. Use this API when a routeset is no longer needed. ### Submit Delete Request To delete your routeset, send a `DELETE` request with the `routesetId` of the routeset to delete.
Reference :  Link ¶

⚼ Request

DELETE:  /routesets/{routesetId}
{
routesetId:
{
Description: The ID of the routeset to delete. ,
Required: True ,
}
string ,
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 (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 ,
}
,
]
,
}
,
}
Routeset_GetOperation (removed)
Description :  This API allows the caller to view the current progress of a routeset operation. The path is obtained from a call to the Create Routeset API. ### Submit Operations Request To view the current progress of a routeset operation, you will use a `GET` request with the `operationId` of the desired operation. ### Operation Response While in progress, a `200-OK` http status code will be returned with no extra headers. If the operation succeeds, a `200-OK` http status code with Resource-Location header will be returned.
Reference :  Link ¶

⚼ Request

GET:  /routesets/operations/{operationId}
{
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 ,
operationId:
{
Description: The ID used to query the status of the routeset creation. ,
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. ,
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 ,
}
,
]
,
}
,
}