/
routeset.json
360 lines (360 loc) · 16.2 KB
/
routeset.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
{
"swagger": "2.0",
"info": {
"version": "2022-09-01-preview",
"title": "Azure Maps Routeset Service.",
"description": "APIs for managing routesets."
},
"x-ms-parameterized-host": {
"hostTemplate": "{geography}.atlas.microsoft.com",
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation"
}
]
},
"schemes": [
"https"
],
"consumes": [],
"produces": [
"application/json"
],
"securityDefinitions": {
"AADToken": {
"type": "oauth2",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"flow": "implicit",
"description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) 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.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* 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](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.",
"scopes": {
"https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default"
}
},
"SharedKey": {
"type": "apiKey",
"description": "This is a shared key that is provisioned when you [Create an Azure Maps account](https://docs.microsoft.com/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n 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.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](https://docs.microsoft.com/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.",
"name": "subscription-key",
"in": "query"
},
"SasToken": {
"type": "apiKey",
"description": "This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n 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.\n\n For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token.",
"name": "SAS Token",
"in": "header"
}
},
"security": [
{
"AADToken": [
"https://atlas.microsoft.com/.default"
]
},
{
"SharedKey": []
},
{
"SasToken": []
}
],
"definitions": {
"FacilityDetails": {
"description": "Details about each facility in the routeset.",
"type": "object",
"properties": {
"facilityId": {
"description": "The identifier of the structure this routeset was created from.",
"type": "string",
"readOnly": true
},
"levelOrdinals": {
"description": "The level identifiers within this facility.",
"type": "array",
"items": {
"type": "number"
},
"x-ms-identifiers": [],
"readOnly": true
}
}
},
"RoutesetsList": {
"description": "The response model for the Routeset List API. Returns the list of all routesets.",
"type": "object",
"properties": {
"routesets": {
"description": "The list of all routesets.",
"type": "array",
"readOnly": true,
"items": {
"$ref": "#/definitions/Routeset"
}
},
"nextLink": {
"description": "If present, the location of the next page of data.",
"type": "string",
"readOnly": true
}
}
},
"Routeset": {
"description": "Detailed information for the routeset.",
"type": "object",
"properties": {
"routesetId": {
"description": "The unique ID of the routeset.",
"type": "string",
"readOnly": true
},
"datasetId": {
"description": "The ID of the dataset used to create this routeset.",
"type": "string",
"readOnly": true
},
"description": {
"description": "The description code for the building with the ontology version number.",
"type": "string",
"readOnly": true
},
"facilities": {
"description": "The facility information and building level ordinal numbers.",
"type": "array",
"items": {
"$ref": "#/definitions/FacilityDetails"
},
"x-ms-identifiers": [],
"readOnly": true
},
"created": {
"description": "The date and time the routeset object was created.",
"type": "string",
"format": "date-time",
"readOnly": true
}
}
}
},
"parameters": {
"ApiVersion": {
"name": "api-version",
"description": "Version number of Azure Maps API.",
"type": "string",
"in": "query",
"required": true,
"default": "2022-09-01-preview",
"x-ms-parameter-location": "client"
},
"RouteDatasetId": {
"name": "datasetId",
"type": "string",
"in": "query",
"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,
"x-ms-parameter-location": "method"
},
"Description": {
"name": "description",
"description": "User provided description of the routeset.",
"type": "string",
"in": "query",
"x-ms-parameter-location": "client"
},
"QueryRoutesetId": {
"name": "routesetId",
"description": "The ID of the routeset to query for.",
"type": "string",
"in": "path",
"required": true,
"x-ms-parameter-location": "method"
},
"DeleteRoutesetId": {
"name": "routesetId",
"description": "The ID of the routeset to delete.",
"type": "string",
"in": "path",
"required": true,
"x-ms-parameter-location": "method"
},
"OperationId": {
"name": "operationId",
"description": "The ID used to query the status of the routeset creation.",
"type": "string",
"in": "path",
"required": true,
"x-ms-parameter-location": "method"
}
},
"paths": {
"/routesets": {
"post": {
"description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator 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.\n\nThis API allows the caller to create routeset data from a dataset.\n\nUse the routeset API to create special data structures consumed by the Azure Maps Wayfinding service to discover the shortest paths within a facility.\n\n### Submit Create Request\n\nTo 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.\n\nThe Create Routeset API is a [long-running request](https://aka.ms/am-creator-lrt-v2).",
"operationId": "Routeset_Create",
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-examples": {
"Create a routeset from a previously created dataset ": {
"$ref": "./examples/wayfind/Routeset_Create.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/RouteDatasetId"
},
{
"$ref": "#/parameters/Description"
}
],
"responses": {
"202": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/202AsyncV2"
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
},
"get": {
"description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator 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.\n\nThis API allows the caller to fetch a list of all routesets in the current Azure Maps Creator account.",
"operationId": "Routeset_List",
"x-ms-examples": {
"Enumerate all routesets for a given subscription": {
"$ref": "./examples/wayfind/Routeset_List.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
}
],
"x-ms-pageable": {
"itemName": "routesets",
"nextLinkName": "nextLink"
},
"responses": {
"200": {
"description": "List routeset request completed successfully. The response body contains a list of all routesets.",
"schema": {
"$ref": "#/definitions/RoutesetsList"
}
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
}
},
"/routesets/{routesetId}": {
"get": {
"description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator 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.\n\nThis API allows the caller to fetch a routeset.",
"operationId": "Routeset_Get",
"x-ms-examples": {
"Get details for a previously created dataset": {
"$ref": "./examples/wayfind/Routeset_Get.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/QueryRoutesetId"
}
],
"responses": {
"200": {
"description": "The get routeset request completed successfully.",
"schema": {
"$ref": "#/definitions/Routeset"
}
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
},
"delete": {
"description": "**Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator 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.\n\nThis API allows the caller to delete an existing routeset. Use this API when a routeset is no longer needed.\n\n### Submit Delete Request\n\nTo delete your routeset, send a `DELETE` request with the `routesetId` of the routeset to delete.",
"operationId": "Routeset_Delete",
"x-ms-examples": {
"Delete an existing routeset": {
"$ref": "./examples/wayfind/Routeset_Delete.json"
}
},
"parameters": [
{
"$ref": "#/parameters/DeleteRoutesetId"
},
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
}
],
"responses": {
"204": {
"description": "Routeset delete request completed successfully."
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
}
},
"/routesets/operations/{operationId}": {
"get": {
"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.\n\n### Submit Operations Request\n\nTo view the current progress of a routeset operation, you will use a `GET` request with the `operationId` of the desired operation.\n\n### Operation Response\n\nWhile 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.",
"operationId": "Routeset_GetOperation",
"x-ms-examples": {
"Get the status of an operation which is still running": {
"$ref": "./examples/wayfind/Routeset_GetOperationStillRunning.json"
},
"Get the status of an operation which has finished successfully": {
"$ref": "./examples/wayfind/Routeset_GetOperation.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/OperationId"
}
],
"responses": {
"200": {
"description": "The operation is running or complete. If the operation was successful, use the Resource-Location header to obtain the path to the result.",
"schema": {
"$ref": "./tileset.json#/definitions/LongRunningOperationResult"
},
"headers": {
"Resource-Location": {
"type": "string",
"description": "If successful, a URI where details on the newly created resource can be found."
}
}
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
}
}
}
}