WFS - Get Features
Используйте для получения подробного списка функций коллекции.
Примечание.
Выход на пенсию создателя Azure Maps
Служба azure Maps Creator в помещении теперь устарела и будет прекращена 9.30.25. Дополнительные сведения см. в разделе "Завершение жизни" создателя Azure Maps.
API Get Features
— это запрос HTTP GET
, который возвращает подробный список функций в указанной коллекции.
API WFS следует стандарту API открытого геопространственного консорциума для функций для запроса наборов данных.
Набор данных состоит из нескольких коллекций компонентов. Коллекция признаков — это коллекция признаков аналогичного типа, основанная на общей схеме.
Отправка запроса на получение функций
GET https://{geography}.atlas.microsoft.com/wfs/datasets/{datasetId}/collections/{collectionId}/items?api-version=2.0
GET https://{geography}.atlas.microsoft.com/wfs/datasets/{datasetId}/collections/{collectionId}/items?api-version=2.0&limit={limit}&bbox={bbox}&filter={filter}
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
collection
|
path | True |
string |
Идентификатор (имя) определенной коллекции |
dataset
|
path | True |
string |
Идентификатор набора данных для запроса. |
geography
|
path | True |
string |
Этот параметр указывает расположение ресурса Создателя Azure Maps. Допустимые значения являются нами и eu. |
api-version
|
query | True |
string |
Номер версии API Azure Maps. |
bbox
|
query |
number[] |
Выбраны только признаки, имеющие геометрию, пересекающую заданное ограничивающее поле.
|
|
filter
|
query |
string |
Фильтрация выражений для поиска признаков с определенными значениями свойств в данной коллекции. Поддерживаются только свойства признаков скалярного типа и оператора равенства. Это специальный параметр, в котором имя параметра — это имя конфиденциального регистра. Схема этого параметра — {property name}={property value}. Если "filter" не является одним из имен свойств в коллекции, "filter" не следует использовать в качестве имени параметра. Чтобы найти функции со значением свойства "name" "21N13", используйте "name=21N13". Поддерживаются несколько фильтров и должны представляться в виде нескольких параметров запроса. Например, =&= строковые значения чувствительны к регистру. |
|
limit
|
query |
integer minimum: 1maximum: 500 |
Необязательный параметр ограничения ограничивает количество функций, представленных в документе ответа. Учитываются только функции, которые находятся на первом уровне коллекции в документе ответа. Вложенные объекты, содержащиеся в явно запрошенных функциях, не учитываются.
|
Заголовок запроса
Имя | Обязательно | Тип | Описание |
---|---|---|---|
x-ms-client-id |
string |
Указывает, какая учетная запись предназначена для использования в сочетании с моделью безопасности идентификатора Microsoft Entra. Он представляет уникальный идентификатор учетной записи Azure Maps и может быть получен из API учетной записи уровня управления Azure Maps. Сведения о том, как использовать безопасность идентификатора Microsoft Entra в Azure Maps, см. в следующих статьях |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Хорошо |
|
Other Status Codes |
Произошла непредвиденная ошибка. |
Безопасность
AADToken
Это потоки Microsoft Entra OAuth 2.0. При паре с доступом на основе ролей Azure его можно использовать для управления доступом к REST API Azure Maps. Управление доступом на основе ролей Azure используется для назначения доступа к одной или нескольким учетным записям ресурсов Azure Maps или вложенным ресурсам. Доступ к любому пользователю, группе или субъекту-службе можно предоставить через встроенную роль или пользовательскую роль, состоящую из одного или нескольких разрешений для REST API Azure Maps.
Для реализации сценариев рекомендуется просматривать концепции проверки подлинности . В целом, это определение безопасности предоставляет решение для моделирования приложений через объекты, способные управлять доступом в определенных API и областях.
Примечания.
- Для этого определения безопасности требуется использовать заголовок
x-ms-client-id
, чтобы указать, к какой ресурсу Azure Maps приложение запрашивает доступ. Это можно получить изAPI управления картами.
Authorization URL
зависит от экземпляра общедоступного облака Azure. В национальных облаках есть уникальные URL-адреса авторизации и конфигурации идентификатора Microsoft Entra.
* Управление доступом на основе ролей Azure настраивается с плоскости управления Azure с помощью портала Azure, PowerShell, CLI, пакетов SDK Azure или REST API.
* Использование веб-пакета SDK Azure Maps позволяет настроить приложение на основе конфигурации для нескольких вариантов использования.
- Дополнительные сведения о платформе удостоверений Майкрософт см. в обзоре платформы удостоверений Майкрософт.
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
Имя | Описание |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Это общий ключ, подготовленный при создания учетной записи Azure Maps на портале Azure или с помощью PowerShell, CLI, пакетов SDK Azure или REST API.
С помощью этого ключа любой приложение может получить доступ ко всем REST API. Другими словами, этот ключ можно использовать в качестве главного ключа в учетной записи, в которую они выданы.
Для общедоступных приложений мы рекомендуем использовать конфиденциальные клиентские приложения, подход для доступа к REST API Azure Maps, чтобы ваш ключ можно было безопасно хранить.
Тип:
apiKey
В:
query
SAS Token
Это маркер подписанного URL-адреса создается из операции SAS списка на ресурсе Azure Maps через плоскость управления Azure с помощью портала Azure, PowerShell, CLI, пакетов SDK Azure или REST API.
С помощью этого маркера любой приложению разрешен доступ с помощью управления доступом на основе ролей Azure и точного управления сроком действия, скоростью и регионами, используемыми для конкретного маркера. Другими словами, маркер SAS можно использовать для разрешения приложений управлять доступом более защищенным способом, чем общий ключ.
Для общедоступных приложений мы рекомендуем настроить определенный список разрешенных источников в ресурсе учетной записи карты карты, чтобы ограничить злоупотребление отрисовкой и регулярно обновлять маркер SAS.
Тип:
apiKey
В:
header
Примеры
GetFeatures
Образец запроса
GET https://us.atlas.microsoft.com/wfs/datasets/018fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2.0&limit=1&bbox=-122,47,-120,46
Пример ответа
{
"type": "FeatureCollection",
"ontology": "Facility-2.0",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
139.6330405782921,
35.45768668610856
],
[
139.63296283234274,
35.45778390425868
],
[
139.63308672404617,
35.45785022906202
],
[
139.6331451691671,
35.45777714569986
],
[
139.6331274703629,
35.45776767074717
],
[
139.63314677109963,
35.45774353588138
],
[
139.6330405782921,
35.45768668610856
]
]
]
},
"properties": {
"originalId": "ddbbb583-4621-4e11-8859-299d1057e843",
"categoryId": "CTG10",
"isOpenArea": false,
"navigableBy": [
"pedestrian"
],
"isRoutable": false,
"routeThroughBehavior": "allowed",
"nonPublic": false,
"levelId": "LVL18",
"occupants": [],
"addressId": "DIR16",
"addressRoomNumber": "",
"name": "21N13",
"nameSubtitle": "",
"nameAlt": ""
},
"id": "UNIT39",
"featureType": ""
}
],
"numberReturned": 1,
"links": [
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2.0&limit=1",
"rel": "self"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit?api-version=2.0",
"rel": "data"
},
{
"href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?n=PMRG4ZLYOQRDUMJMEJYHEZLWEI5C2ML5&api-version=2.0&limit=1",
"rel": "next"
}
]
}
Определения
Имя | Описание |
---|---|
Error |
Дополнительные сведения об ошибке управления ресурсами. |
Error |
Сведения об ошибке. |
Error |
Ответ на ошибку |
Extended |
Допустимый тип объекта |
Geo |
Допустимый тип объекта |
Geo |
Допустимый объект |
Geo |
Допустимый тип объекта |
Geo |
Допустимый тип геометрии |
Geo |
Допустимый тип геометрии |
Geo |
Допустимый тип геометрии |
Geo |
Допустимый тип объекта |
Geo |
Указывает тип |
Geo |
Допустимый тип геометрии |
Geo |
Допустимый тип геометрии |
WFSEndpoint |
Ссылки на другие конечные точки WFS |
ErrorAdditionalInfo
Дополнительные сведения об ошибке управления ресурсами.
Имя | Тип | Описание |
---|---|---|
info |
object |
Дополнительные сведения. |
type |
string |
Дополнительный тип сведений. |
ErrorDetail
Сведения об ошибке.
Имя | Тип | Описание |
---|---|---|
additionalInfo |
Дополнительные сведения об ошибке. |
|
code |
string |
Код ошибки. |
details |
Сведения об ошибке. |
|
message |
string |
Сообщение об ошибке. |
target |
string |
Целевой объект ошибки. |
ErrorResponse
Ответ на ошибку
Имя | Тип | Описание |
---|---|---|
error |
Объект ошибки. |
ExtendedGeoJsonFeatureCollection
Допустимый тип объекта GeoJSON FeatureCollection
, расширенный с числомReturned и массивом ссылок. Дополнительные сведения см. в RFC 7946.
Имя | Тип | Описание |
---|---|---|
features |
Содержит список допустимых объектов |
|
links |
Ссылки на другие конечные точки WFS. |
|
numberReturned |
integer |
Количество возвращаемых функций. |
ontology |
string |
Версия ontology этого набора данных. |
type |
Указывает тип |
GeoJsonFeature
Допустимый тип объекта GeoJSON Feature
. Дополнительные сведения см. в RFC 7946.
Имя | Тип | Описание |
---|---|---|
featureType |
string |
Тип функции. Значение зависит от модели данных, из которой входит текущая функция. Некоторые модели данных могут иметь пустое значение. |
geometry | GeoJsonGeometry: |
Допустимый объект |
id |
string |
Идентификатор функции. |
type |
string:
Feature |
Указывает тип |
GeoJsonGeometry
Допустимый объект GeoJSON
геометрии. Тип должен быть одним из семи допустимых типов геометрии GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon и GeometryCollection. Дополнительные сведения см. в RFC 7946.
Имя | Тип | Описание |
---|---|---|
type |
Указывает тип |
GeoJsonGeometryCollection
Допустимый тип объекта GeoJSON GeometryCollection
. Дополнительные сведения см. в RFC 7946.
Имя | Тип | Описание |
---|---|---|
geometries | GeoJsonGeometry[]: |
Содержит список допустимых |
type |
string:
Geometry |
Указывает тип |
GeoJsonLineString
Допустимый тип геометрии GeoJSON LineString
. Дополнительные сведения см. в RFC 7946.
Имя | Тип | Описание |
---|---|---|
coordinates |
number[] (double) |
Координаты геометрии |
type |
string:
Line |
Указывает тип |
GeoJsonMultiLineString
Допустимый тип геометрии GeoJSON MultiLineString
. Дополнительные сведения см. в RFC 7946.
Имя | Тип | Описание |
---|---|---|
coordinates |
number[] (double) |
Координаты геометрии |
type |
string:
Multi |
Указывает тип |
GeoJsonMultiPoint
Допустимый тип геометрии GeoJSON MultiPoint
. Дополнительные сведения см. в RFC 7946.
Имя | Тип | Описание |
---|---|---|
coordinates |
number[] (double) |
Координаты геометрии |
type |
string:
Multi |
Указывает тип |
GeoJsonMultiPolygon
Допустимый тип объекта GeoJSON MultiPolygon
. Дополнительные сведения см. в RFC 7946.
Имя | Тип | Описание |
---|---|---|
coordinates |
number[] (double) |
Содержит список допустимых объектов |
type |
string:
Multi |
Указывает тип |
GeoJsonObjectType
Указывает тип GeoJSON
: FeatureCollection.
Значение | Описание |
---|---|
FeatureCollection |
Объект |
GeoJsonPoint
Допустимый тип геометрии GeoJSON Point
. Дополнительные сведения см. в RFC 7946.
Имя | Тип | Описание |
---|---|---|
coordinates |
number[] (double) |
|
type |
string:
Point |
Указывает тип |
GeoJsonPolygon
Допустимый тип геометрии GeoJSON Polygon
. Дополнительные сведения см. в RFC 7946.
Имя | Тип | Описание |
---|---|---|
coordinates |
number[] (double) |
Координаты для типа геометрии |
type |
string:
Polygon |
Указывает тип |
WFSEndpointLink
Ссылки на другие конечные точки WFS
Имя | Тип | Описание |
---|---|---|
href |
string |
Целевой объект ссылки. |
hreflang |
string |
Указание, указывающее, какой язык результата расшифровки ссылки должен быть. |
rel |
string |
Тип отношения. |
title |
string |
Используется для метки назначения ссылки, чтобы ее можно было использовать в качестве удобочитаемого идентификатора (например, записи меню) на языке, указанном полем заголовка Content-Language (при наличии). |
type |
string |
Указание, указывающее тип носителя результата расшифровки ссылки. |