-
Notifications
You must be signed in to change notification settings - Fork 5.2k
/
Copy pathfeatures.json
1109 lines (1109 loc) · 49.7 KB
/
features.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
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"swagger": "2.0",
"info": {
"title": "Azure Maps Features Service",
"version": "2023-03-01-preview",
"description": "Azure Maps Features REST APIs"
},
"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 creating an [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 key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this 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": []
}
],
"responses": {},
"parameters": {
"ApiVersion": {
"name": "api-version",
"description": "Version number of Azure Maps API.",
"type": "string",
"in": "query",
"required": true,
"x-ms-parameter-location": "client"
},
"LimitFeatures": {
"name": "limit",
"in": "query",
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 5000,
"description": "The optional limit parameter limits the number of features that are presented in the response document.\nOnly features that are on the first level of the collection in the response document are counted. Nested objects contained within the explicitly requested features shall not be counted.\n* Minimum = 1 * Maximum = 500 * Default = 10",
"x-ms-parameter-location": "method"
},
"Filter": {
"name": "filter",
"in": "query",
"type": "string",
"description": "Filter expression to search for features with specific property values in a given collection. Only feature properties of scalar type and equals operator are supported.\nThis is a special parameter where the parameter name is a case sensitive property name. The scheme for this parameter is {property name}={property value}. Unless \"filter\" is one of the property names in the collection, \"filter\" should not be used as a parameter name. To search for features with \"name\" property value \"21N13\", use \"name=21N13\".\nMultiple filters are supported and should be represented as multiple query parameters. E.g., <property1>=<value1>&<property2>=<value2> String values are case sensitive.",
"x-ms-parameter-location": "method"
},
"Bbox": {
"name": "bbox",
"x-ms-client-name": "boundingBox",
"in": "query",
"type": "array",
"collectionFormat": "csv",
"items": {
"type": "number",
"format": "double"
},
"description": "Only features that have a geometry that intersects the supplied bounding box are selected.\n* Lower left corner, coordinate axis 1 * Lower left corner, coordinate axis 2 * Upper right corner, coordinate axis 1 * Upper right corner, coordinate axis 2\nThe coordinate reference system of the values is WGS84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84) unless a different coordinate reference system is specified in the parameter `bbox-crs`.\nFor WGS84 longitude/latitude the values are in most cases the sequence of minimum longitude, minimum latitude, maximum longitude and maximum latitude. However, in cases where the box spans the antimeridian the first value (west-most box edge) is larger than the third value (east-most box edge).",
"x-ms-parameter-location": "method"
},
"CollectionId": {
"name": "collectionId",
"in": "path",
"type": "string",
"required": true,
"description": "Identifier (name) of a specific collection.",
"x-ms-parameter-location": "method"
},
"FeatureId": {
"name": "featureId",
"in": "path",
"type": "string",
"description": "Case sensitive identifier of a specific feature.",
"required": true,
"x-ms-parameter-location": "method"
},
"FeatureBody": {
"name": "feature",
"in": "body",
"required": true,
"description": "A valid `GeoJSON Feature` object type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.2) for details.",
"x-ms-parameter-location": "client",
"schema": {
"type": "object",
"allOf": [
{
"$ref": "#/definitions/FeatureType"
},
{
"$ref": "#/definitions/FeatureAttributes"
}
]
}
},
"FeatureAttributesBody": {
"name": "featureAttributes",
"in": "body",
"required": true,
"description": "The geometry and properties of a feature.",
"x-ms-parameter-location": "client",
"schema": {
"$ref": "#/definitions/FeatureAttributes"
}
}
},
"paths": {
"/features/datasets/{datasetId}": {
"get": {
"summary": "Use to get links to the API definition, conformance statements and metadata for a given feature collection.",
"description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> 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).\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n### Submit Get Landing Page Request \n\nThe `Get Landing Page` API is an HTTP `GET` request that provides links to the API definition, conformance statements and metadata about the features in the specified dataset.",
"operationId": "Features_GetLandingPage",
"x-ms-examples": {
"GetLandingPage": {
"$ref": "./examples/features/Features_GetLandingPage.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "./dataset.json#/parameters/DatasetId"
}
],
"responses": {
"200": {
"description": "Ok",
"schema": {
"$ref": "#/definitions/LandingPageResult"
}
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
}
},
"/features/datasets/{datasetId}/api": {
"get": {
"summary": "Use to get a description of the capabilities of the Features service.",
"description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> 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).\n\nThe `Get API Definition` API is an HTTP `GET` request that returns details of the capabilities of each API in the Features service, including the request type (`GET` or `POST`) a `description`, `operationId`, `parameters`, and `responses`. It can be used by developers to understand the API or by development tools to support the implementation of servers and clients.\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.",
"operationId": "Features_GetApiDefinition",
"x-ms-examples": {
"GetApiDefinition": {
"$ref": "./examples/features/Features_GetApiDefinition.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "./dataset.json#/parameters/DatasetId"
}
],
"responses": {
"200": {
"description": "Ok",
"schema": {
"$ref": "#/definitions/ApiDefinitionResult"
}
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
}
},
"/features/datasets/{datasetId}/conformance": {
"get": {
"summary": "Use to get a list of the Open Geospatial Consortium (OGC) conformance classes that the server conforms to.",
"description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> 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).\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n \n\n### Submit List Conformance Request\n\nThe `List Conformance` API is an HTTP `GET` request that returns a list of all requirements classes specified in the OGC standard that the server conforms to.",
"operationId": "Features_ListConformance",
"x-ms-examples": {
"GetConformance": {
"$ref": "./examples/features/Features_ListConformance.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "./dataset.json#/parameters/DatasetId"
}
],
"responses": {
"200": {
"description": "Ok",
"schema": {
"$ref": "#/definitions/ConformanceResult"
}
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
}
},
"/features/datasets/{datasetId}/collections": {
"get": {
"summary": "Use to get a list of feature collections.",
"description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> 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).\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n\n\n### Submit Get Collections Request\n\nThe `Get Collections` API is an HTTP `GET` request that returns a list of all feature collections in a dataset.",
"operationId": "Features_GetCollections",
"x-ms-examples": {
"GetCollections": {
"$ref": "./examples/features/Features_GetCollections.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "./dataset.json#/parameters/DatasetId"
}
],
"responses": {
"200": {
"description": "Ok",
"schema": {
"$ref": "#/definitions/CollectionsResult"
}
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
}
},
"/features/datasets/{datasetId}/collections/{collectionId}": {
"get": {
"summary": "Use to get details of a feature collection.",
"description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> 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).\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n ### Submit Get Collection Request\n\nThe `Get Collection` API is an HTTP `GET` request that returns the details of a specific feature collection as defined by the provided `collectionId` in the specified dataset.",
"operationId": "Features_GetCollection",
"x-ms-examples": {
"GetCollection": {
"$ref": "./examples/features/Features_GetCollection.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "./dataset.json#/parameters/DatasetId"
},
{
"$ref": "#/parameters/CollectionId"
}
],
"responses": {
"200": {
"description": "Ok",
"schema": {
"$ref": "#/definitions/CollectionResult"
}
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
}
},
"/features/datasets/{datasetId}/collections/{collectionId}/definition": {
"get": {
"summary": "Use to get a detailed data model of the specified feature collection.",
"description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> 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).\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n### Submit Get Collection Definition Request\n\nThe `Get Collection Definition` API is an HTTP `GET` request that returns a detailed data model of a feature collection as defined by the provided `collectionId`.",
"operationId": "Features_GetCollectionDefinition",
"x-ms-examples": {
"GetCollectionDefinition": {
"$ref": "./examples/features/Features_GetCollectionDefinition.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "./dataset.json#/parameters/DatasetId"
},
{
"$ref": "#/parameters/CollectionId"
}
],
"responses": {
"200": {
"description": "Ok",
"schema": {
"$ref": "#/definitions/CollectionDefinitionResult"
}
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
}
},
"/features/datasets/{datasetId}/collections/{collectionId}/items": {
"get": {
"summary": "Use to get a detailed list of features in the specified feature collection.",
"description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> 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).\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n### Submit Get Items Request\n\nThe `Get Items` API is an HTTP `GET` request that returns the features in a feature collection as defined by the provided `collectionId` in the specified dataset.",
"operationId": "Features_GetItems",
"x-ms-examples": {
"GetFeatures": {
"$ref": "./examples/features/Features_GetItems.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "./dataset.json#/parameters/DatasetId"
},
{
"$ref": "#/parameters/CollectionId"
},
{
"$ref": "#/parameters/LimitFeatures"
},
{
"$ref": "#/parameters/Bbox"
},
{
"$ref": "#/parameters/Filter"
}
],
"responses": {
"200": {
"description": "Ok",
"schema": {
"$ref": "#/definitions/ExtendedGeoJsonFeatureCollection"
}
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
},
"post": {
"summary": "Use to create a [feature](https://tools.ietf.org/html/rfc7946#section-3.2).",
"description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> 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).\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n### Submit Create Request\n\n The `Feature` API is an HTTP `POST` request that allows the caller to create a new feature that conforms with the **drafted** [Open Geospatial Consortium API - Features - Part 4: Create, Replace, Update and Delete](http://docs.opengeospatial.org/DRAFTS/20-002.html) specification. This API creates a feature with the provided attributes in the given collection.",
"operationId": "Features_Create",
"x-ms-examples": {
"PostFeature": {
"$ref": "./examples/features/Features_Create.json"
}
},
"consumes": [
"application/geo+json"
],
"parameters": [
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "./dataset.json#/parameters/DatasetId"
},
{
"$ref": "#/parameters/CollectionId"
},
{
"$ref": "#/parameters/FeatureBody"
}
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/CreateFeatureResult"
}
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
}
},
"/features/datasets/{datasetId}/collections/{collectionId}/items/{featureId}": {
"get": {
"summary": "Use to get the details of a [feature](https://tools.ietf.org/html/rfc7946#section-3.2).",
"description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> 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).\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n### Submit Get Request\n\nThe `Get` API is an HTTP `GET` request that returns the feature identified by the provided `featureId` in the specified dataset and collection.",
"operationId": "Features_Get",
"x-ms-examples": {
"GetFeature": {
"$ref": "./examples/features/Features_Get.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "./dataset.json#/parameters/DatasetId"
},
{
"$ref": "#/parameters/CollectionId"
},
{
"$ref": "#/parameters/FeatureId"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FeatureResult"
}
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
},
"put": {
"summary": "Use to overwrite all existing attributes of a [feature](https://tools.ietf.org/html/rfc7946#section-3.2).",
"description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> 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).\n\nThe `Replace` API conforms to the **drafted** [Open Geospatial Consortium API - Features - Part 4: Create, Replace, Update and Delete](http://docs.opengeospatial.org/DRAFTS/20-002.html) specification.\n\nThis is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n### Submit Replace Request\n\nThe `Replace` API is an HTTP `PUT` request that **replaces** the feature identified by the provided `featureId` in the specified collection, meaning the data supplied in the request body overwrites all attributes of the feature.",
"operationId": "Features_Replace",
"x-ms-examples": {
"PutFeature": {
"$ref": "./examples/features/Features_Replace.json"
}
},
"consumes": [
"application/geo+json"
],
"parameters": [
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "./dataset.json#/parameters/DatasetId"
},
{
"$ref": "#/parameters/CollectionId"
},
{
"$ref": "#/parameters/FeatureId"
},
{
"$ref": "#/parameters/FeatureBody"
}
],
"responses": {
"204": {
"description": "Feature Updated."
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
},
"patch": {
"summary": "Use to modify individual attributes of a [feature](https://tools.ietf.org/html/rfc7946#section-3.2).",
"description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> 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).\n\nThe `Update` API conforms with the **drafted** [Open Geospatial Consortium API - Features - Part 4: Create, Replace, Update and Delete](http://docs.opengeospatial.org/DRAFTS/20-002.html) specification.\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n### Submit Update Request\n\nThe `Update` API is an HTTP `PATCH` request that is used to change individual attributes of a feature as specified by the `featureId`. The only attributes that will be updated are those explicitly included in the request body.",
"operationId": "Features_Update",
"x-ms-examples": {
"PatchFeature": {
"$ref": "./examples/features/Features_Update.json"
}
},
"consumes": [
"application/merge-patch+json"
],
"parameters": [
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "./dataset.json#/parameters/DatasetId"
},
{
"$ref": "#/parameters/CollectionId"
},
{
"$ref": "#/parameters/FeatureId"
},
{
"$ref": "#/parameters/FeatureAttributesBody"
}
],
"responses": {
"204": {
"description": "Feature Updated."
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
},
"delete": {
"summary": "Use to delete a [feature](https://tools.ietf.org/html/rfc7946#section-3.2).",
"description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> 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).\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n### Submit Delete Request \n\nThe `Delete` API is an HTTP `DELETE` request that is used to delete a feature specified by its `featureId`. The delete request will fail if the feature has any dependent features, so be sure and delete them first. The features `Delete` API conforms with the **drafted** [Open Geospatial Consortium API - Features - Part 4: Create, Replace, Update and Delete](http://docs.opengeospatial.org/DRAFTS/20-002.html) specification.",
"operationId": "Features_Delete",
"x-ms-examples": {
"DeleteFeature": {
"$ref": "./examples/features/Features_Delete.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "./dataset.json#/parameters/DatasetId"
},
{
"$ref": "#/parameters/CollectionId"
},
{
"$ref": "#/parameters/FeatureId"
}
],
"responses": {
"204": {
"description": "Feature Deleted."
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
}
}
},
"definitions": {
"LandingPageResult": {
"description": "Response after a successful request to the landing page.",
"type": "object",
"required": [
"links"
],
"properties": {
"ontology": {
"$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology"
},
"links": {
"description": "Links to other Features endpoints.",
"type": "array",
"items": {
"$ref": "#/definitions/FeaturesEndpointLink"
}
}
}
},
"ApiDefinitionResult": {
"description": "Response after a successful request to get the API definition.",
"type": "object",
"required": [
"openapi",
"info",
"paths",
"components",
"tags"
],
"properties": {
"openapi": {
"description": "The OpenAPI version.",
"type": "string",
"example": "3.0.1"
},
"info": {
"description": "The OpenAPI info object.",
"type": "object",
"properties": {
"title": {
"description": "The title of the API.",
"type": "string",
"example": "Azure Maps Web Feature Service"
},
"version": {
"description": "The version of the API.",
"type": "string",
"example": "2023-03-01-preview"
},
"description": {
"description": "The description of the API.",
"type": "string",
"example": "Azure Maps Web Feature REST APIs"
}
}
},
"paths": {
"description": "The OpenAPI paths object.",
"type": "object"
},
"components": {
"description": "The OpenAPI components object.",
"type": "object",
"properties": {
"parameters": {
"description": "The OpenAPI parameters object.",
"type": "object",
"additionalProperties": true
},
"schemas": {
"description": "The OpenAPI schemas object.",
"type": "object",
"additionalProperties": true
}
}
},
"tags": {
"description": "The OpenAPI tags object.",
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"description": "The name of the tag.",
"type": "string",
"example": "Features"
},
"description": {
"description": "The description of the tag.",
"type": "string",
"example": "Access to data (features)."
}
}
}
}
}
},
"ConformanceResult": {
"description": "Response after a successful request to the conformance page.",
"type": "object",
"required": [
"conformsTo"
],
"properties": {
"conformsTo": {
"description": "List of requirements classes that the server conforms to.",
"type": "array",
"items": {
"type": "string"
},
"example": [
"http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/core",
"http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/oas3",
"http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/geojson"
]
}
}
},
"FeaturesEndpointLink": {
"description": "Links to other Features endpoints. For more details about link relations, please visit the [OGC API - Features - Part 1](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1#_link_relations) standard.",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "The link target.",
"type": "string",
"format": "uri",
"example": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4"
},
"rel": {
"description": "The relation type.",
"type": "string",
"example": "self"
},
"title": {
"description": "Used to label the destination of a link such that it can be used as a human-readable identifier (e.g., a menu entry) in the language indicated by the Content-Language header field (if present).",
"type": "string",
"example": "Azure Maps Features"
}
}
},
"CollectionsResult": {
"description": "Response after a successful request to list collections.",
"type": "object",
"required": [
"links",
"collections"
],
"properties": {
"ontology": {
"$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology"
},
"collections": {
"description": "All the collections in a given dataset.",
"type": "array",
"items": {
"$ref": "#/definitions/CollectionResult"
}
},
"links": {
"description": "Links to other Features endpoints.",
"type": "array",
"items": {
"$ref": "#/definitions/FeaturesEndpointLink"
},
"example": [
{
"href": "http://data.example.org/collections.json",
"rel": "self",
"title": "this document"
}
]
}
}
},
"CollectionResult": {
"description": "Response after a successful request to get a collection.",
"type": "object",
"required": [
"id",
"title",
"links"
],
"properties": {
"id": {
"description": "Identifier of the collection used, for example, in URIs.",
"type": "string",
"example": "buildings"
},
"title": {
"description": "Human readable title of the collection.",
"type": "string",
"example": "Buildings"
},
"ontology": {
"$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology"
},
"itemType": {
"description": "The type of the items in the collection.",
"type": "string",
"example": "feature"
},
"description": {
"description": "A description of the features in the collection.",
"type": "string",
"example": "Buildings in the city of Bonn."
},
"links": {
"description": "Links to other Features endpoints.",
"type": "array",
"items": {
"$ref": "#/definitions/FeaturesEndpointLink"
},
"example": [
{
"href": "http://data.example.org/collections/buildings/items",
"rel": "items",
"title": "Buildings"
},
{
"href": "http://data.example.org/collections/buildings/definition",
"rel": "describedBy",
"title": "Metadata catalogue for unit"
},
{
"href": "http://data.example.org/collections/buildings",
"rel": "self",
"title": "Information for unit collection"
}
]
}
}
},
"CollectionDefinitionResult": {
"description": "Response after a successful request to read a collection's definition.",
"type": "object",
"required": [
"id",
"title",
"geometryType"
],
"properties": {
"id": {
"description": "Identifier of the collection used, for example, in URIs.",
"type": "string",
"example": "buildings"
},
"title": {
"description": "Title of collection.",
"type": "string",
"example": "Feature Class buildings"
},
"ontology": {
"$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology"
},
"itemType": {
"description": "The type of the items in the collection.",
"type": "string",
"example": "feature"
},
"description": {
"description": "Describes the collection.",
"type": "string"
},
"geometryType": {
"description": "Type of geometry returned.",
"type": "string",
"enum": [
"Point",
"MultiPoint",
"LineString",
"MultiLineString",
"Polygon",
"MultiPolygon",
"GeometryCollection"
],
"x-ms-enum": {
"name": "GeoJsonGeometryType",
"modelAsString": true,
"values": [
{
"value": "Point",
"description": "`GeoJSON Point` geometry.",
"name": "GeoJsonPoint"
},
{
"value": "MultiPoint",
"description": "`GeoJSON MultiPoint` geometry.",
"name": "GeoJsonMultiPoint"
},
{
"value": "LineString",
"description": "`GeoJSON LineString` geometry.",
"name": "GeoJsonLineString"
},
{
"value": "MultiLineString",
"description": "`GeoJSON MultiLineString` geometry.",
"name": "GeoJsonMultiLineString"
},
{
"value": "Polygon",
"description": "`GeoJSON Polygon` geometry.",
"name": "GeoJsonPolygon"
},
{
"value": "MultiPolygon",
"description": "`GeoJSON MultiPolygon` geometry.",
"name": "GeoJsonMultiPolygon"
},
{
"value": "GeometryCollection",
"description": "`GeoJSON GeometryCollection` geometry.",
"name": "GeoJsonGeometryCollection"
}
]
}
},
"properties": {
"description": "Attributes of the collection used.",
"type": "array",
"items": {
"$ref": "#/definitions/DefinitionProperty"
}
},
"links": {
"description": "Links to other Features endpoints.",
"type": "array",
"items": {
"$ref": "#/definitions/FeaturesEndpointLink"
}
}
}
},
"DefinitionProperty": {
"description": "The definition of a property in a collection.",
"type": "object",
"required": [
"name",
"required",
"type"
],
"properties": {
"name": {
"description": "Name of attribute.",
"type": "string",
"example": "external_id"
},
"required": {
"description": "Is attribute required.",
"type": "boolean"
},
"type": {
"description": "Type of attribute.",
"type": "object"
}
}
},
"ExtendedGeoJsonFeatureCollection": {
"description": "A valid `GeoJSON FeatureCollection` object type extended with numberReturned and links array. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.3) for details.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/FeatureCollectionData"
},
{
"$ref": "#/definitions/ExtendedGeoJsonFeatureCollectionData"
}
],
"properties": {
"type": {
"description": "Specifies the `GeoJSON` type: FeatureCollection.",
"type": "string",
"enum": [
"FeatureCollection"
],
"x-ms-enum": {
"name": "GeoJsonObjectType",
"modelAsString": false,
"values": [
{
"value": "FeatureCollection",
"description": "`GeoJSON FeatureCollection` object."
}
]
}
}
}
},
"ExtendedGeoJsonFeatureCollectionData": {
"type": "object",
"properties": {
"ontology": {
"$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology"
},
"numberReturned": {
"description": "Number of returned features.",
"type": "integer",
"format": "int32"
},
"links": {
"description": "Links to other Features endpoints.",
"type": "array",
"items": {
"$ref": "#/definitions/FeaturesEndpointLink"
}
}
}
},
"FeatureResult": {