你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Features - Get Items

使用 获取指定特征集合中功能的详细列表。

功能 API 是 Creator 的一部分,它允许使用 Azure Maps API 和 SDK 基于专用室内地图数据开发应用程序。 功能 GET API 遵循开放地理空间联盟 API - 功能 - 第 1 部分:查询数据集的核心更正标准。 数据集由多个特征集合组成,这些功能集合是通用架构定义的 特征 分组。

提交获取项目请求

API Get Items 是一个 HTTP GET 请求,它返回由指定数据集中提供的 collectionId 定义的特征集合中的特征。

GET https://{geography}.atlas.microsoft.com/features/datasets/{datasetId}/collections/{collectionId}/items?api-version=2023-03-01-preview
GET https://{geography}.atlas.microsoft.com/features/datasets/{datasetId}/collections/{collectionId}/items?api-version=2023-03-01-preview&limit={limit}&bbox={bbox}&filter={filter}

URI 参数

名称 必需 类型 说明
collectionId
path True

string

标识符 (特定集合的名称) 。

datasetId
path True

string

要从中查询的数据集的标识符。

geography
path True

string

此参数指定 Azure Maps Creator 资源所在的位置。 有效值为 us 和 eu。

api-version
query True

string

Azure Maps API 的版本号。

bbox
query

number[]

仅选择几何图形与提供的边界框相交的特征。

  • 左下角,坐标轴 1 * 左下角,坐标轴 2 * 右上角,坐标轴 1 * 右上角,坐标轴 2 值的坐标参考系统为 WGS84 经度/纬度 (http://www.opengis.net/def/crs/OGC/1.3/CRS84) ,除非在 参数 bbox-crs中指定了不同的坐标参考系统。 对于 WGS84 经度/纬度,值在大多数情况下是最小经度、最小纬度、最大经度和最大纬度的序列。 但是,如果框跨越时间线,则最西边) (第一个值大于第三个值 (最东边的框边缘) 。
filter
query

string

筛选表达式以搜索给定集合中具有特定属性值的特征。 仅支持标量类型和等于运算符的特征属性。 这是一个特殊参数,其中参数名称是区分大小写的属性名称。 此参数的方案为 {property name}={property value}。 除非“filter”是集合中的属性名称之一,否则不应将“filter”用作参数名称。 若要搜索具有“name”属性值“21N13”的特征,请使用“name=21N13”。 支持多个筛选器,应表示为多个查询参数。 例如, =&= 字符串值区分大小写。

limit
query

integer

int32

可选的 limit 参数限制响应文档中显示的特征数。 仅对响应文档中集合第一级别的功能进行计数。 显式请求的功能中包含的嵌套对象不应进行计数。

  • 最小值 = 1 * 最大值 = 500 * 默认值 = 10

请求头

名称 必需 类型 说明
x-ms-client-id

string

指定要与Microsoft Entra ID安全模型结合使用的帐户。 它表示Azure Maps帐户的唯一 ID,可从Azure Maps管理平面帐户 API 检索。 若要在 Azure Maps 中使用Microsoft Entra ID安全性,请参阅以下文章以获取指导。

响应

名称 类型 说明
200 OK

ExtendedGeoJsonFeatureCollection

正常

Other Status Codes

ErrorResponse

发生了意外错误。

安全性

AADToken

这些是 Azure Active Directory OAuth2 流。 与 Azure 基于角色的访问控制配对时,它可用于控制对Azure Maps REST API 的访问。 Azure 基于角色的访问控制用于指定对一个或多个Azure Maps资源帐户或子资源的访问权限。 可以通过内置角色或由一个或多个权限组成的自定义角色授予任何用户、组或服务主体的访问权限,以Azure Maps REST API。

若要实现方案,建议查看 身份验证概念。 总之,此安全定义提供了一种解决方案,用于通过能够对特定 API 和作用域进行访问控制的对象对应用程序 () 建模。

备注

  • 此安全定义需要使用x-ms-client-id 标头来指示应用程序请求访问的Azure Maps资源。 这可以从 地图管理 API 获取。

Authorization URL特定于 Azure 公有云实例。 主权云具有唯一的授权 URL 和 Azure Active Directory 配置。 * Azure 基于角色的访问控制是通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 从 Azure 管理平面配置的。 * 使用 Azure Maps Web SDK 允许针对多个用例对应用程序进行基于配置的设置。

  • 目前,Azure Active Directory v1.0 或 v2.0 支持工作、学校和来宾,但不支持个人帐户。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称 说明
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

这是在通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 通过 Azure 管理平面创建Azure Maps资源时预配的共享密钥。

使用此密钥,任何应用程序都有权访问所有 REST API。 换而言之,这些密钥当前可被视为为其颁发帐户的主密钥。

对于公开的应用程序,我们建议使用服务器到服务器访问Azure Maps REST API,可在其中安全存储此密钥。

Type: apiKey
In: query

SAS Token

这是一个共享访问签名令牌,通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API,通过 Azure 管理平面在Azure Maps资源上列出 SAS 操作创建。

使用此令牌,任何应用程序都有权使用 Azure 基于角色的访问控制进行访问,并精细控制特定令牌的过期、速率和区域 () 。 换句话说,SAS 令牌可用于允许应用程序以比共享密钥更安全的方式控制访问。

对于公开的应用程序,我们建议在 Map 帐户资源 上配置允许的来源的特定列表,以限制呈现滥用,并定期续订 SAS 令牌。

Type: apiKey
In: header

示例

GetFeatures

Sample Request

GET https://us.atlas.microsoft.com/features/datasets/018fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2023-03-01-preview&limit=1&bbox=-122,47,-120,46

Sample Response

{
  "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,
        "isRoutable": false,
        "levelId": "LVL18",
        "occupants": [],
        "addressId": "DIR16",
        "name": "21N13"
      },
      "id": "UNIT39"
    }
  ],
  "numberReturned": 1,
  "links": [
    {
      "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?limit=1",
      "rel": "self",
      "title": "Unit"
    },
    {
      "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit",
      "rel": "collection",
      "title": "Information for unit collection"
    },
    {
      "href": "https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?n=PMRG4ZLYOQRDUMJMEJYHEZLWEI5C2ML5&limit=1",
      "rel": "next",
      "title": "Next page"
    }
  ]
}

定义

名称 说明
ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

ExtendedGeoJsonFeatureCollection

使用 numberReturned 和 links 数组扩展的有效 GeoJSON FeatureCollection 对象类型。 有关详细信息,请参阅 RFC 7946

Feature

有效的 GeoJSON Feature 对象类型。 有关详细信息,请参阅 RFC 7946

FeaturesEndpointLink

指向其他功能终结点的链接。 有关链接关系的更多详细信息,请访问 OGC API - 功能 - 第 1 部分 标准。

GeoJsonGeometry

有效的 GeoJSON geometry 对象。 类型必须是七种有效的 GeoJSON 几何类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon 和 GeometryCollection。 有关详细信息,请参阅 RFC 7946

GeoJsonGeometryCollection

有效的 GeoJSON GeometryCollection 对象类型。 有关详细信息,请参阅 RFC 7946

GeoJsonLineString

有效的 GeoJSON LineString 几何类型。 有关详细信息,请参阅 RFC 7946

GeoJsonMultiLineString

有效的 GeoJSON MultiLineString 几何类型。 有关详细信息,请参阅 RFC 7946

GeoJsonMultiPoint

有效的 GeoJSON MultiPoint 几何类型。 有关详细信息,请参阅 RFC 7946

GeoJsonMultiPolygon

有效的 GeoJSON MultiPolygon 对象类型。 有关详细信息,请参阅 RFC 7946

GeoJsonObjectType

指定 GeoJSON 类型:FeatureCollection。

GeoJsonPoint

有效的 GeoJSON Point 几何类型。 有关详细信息,请参阅 RFC 7946

GeoJsonPolygon

有效的 GeoJSON Polygon 几何类型。 有关详细信息,请参阅 RFC 7946

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

ExtendedGeoJsonFeatureCollection

使用 numberReturned 和 links 数组扩展的有效 GeoJSON FeatureCollection 对象类型。 有关详细信息,请参阅 RFC 7946

名称 类型 说明
features

Feature[]

包含有效 GeoJSON Feature 对象的列表。

links

FeaturesEndpointLink[]

指向其他功能终结点的链接。

numberReturned

integer

返回的特征数。

ontology

string

此数据集的本体版本。

type

GeoJsonObjectType

指定 GeoJSON 类型:FeatureCollection。

Feature

有效的 GeoJSON Feature 对象类型。 有关详细信息,请参阅 RFC 7946

名称 类型 说明
geometry GeoJsonGeometry:

有效的 GeoJSON geometry 对象。 类型必须是七种有效的 GeoJSON 几何类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon 和 GeometryCollection。 有关详细信息,请参阅 RFC 7946

id

string

特定功能的标识符区分大小写。

properties

object

属性可以包含有关 Feature 的任何其他元数据,由 GET 集合定义 API 定义。 值可以是任何 JSON 对象或 JSON null 值,但请注意,集合定义中未定义的功能属性将被忽略。

type

string

指定 GeoJSON 类型:功能

指向其他功能终结点的链接。 有关链接关系的更多详细信息,请访问 OGC API - 功能 - 第 1 部分 标准。

名称 类型 说明
href

string

链接目标。

rel

string

关系类型。

title

string

用于标记链接的目标,以便它可以用作用户可读标识符 (例如,菜单项) 内容语言标头字段指示的语言 ((如果存在) )。

GeoJsonGeometry

有效的 GeoJSON geometry 对象。 类型必须是七种有效的 GeoJSON 几何类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon 和 GeometryCollection。 有关详细信息,请参阅 RFC 7946

名称 类型 说明
type

GeoJsonObjectType

指定 GeoJSON 类型。 必须是九种有效的 GeoJSON 对象类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonGeometryCollection

有效的 GeoJSON GeometryCollection 对象类型。 有关详细信息,请参阅 RFC 7946

名称 类型 说明
geometries GeoJsonGeometry[]:

包含有效 GeoJSON geometry 对象的列表。 请注意 ,GeoJSON 中的坐标采用 x、y 顺序 (经度、纬度) 。

type string:

GeometryCollection

指定 GeoJSON 类型。 必须是九种有效的 GeoJSON 对象类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonLineString

有效的 GeoJSON LineString 几何类型。 有关详细信息,请参阅 RFC 7946

名称 类型 说明
coordinates

number[]

几何图形的 GeoJson LineString 坐标。

type string:

LineString

指定 GeoJSON 类型。 必须是九种有效的 GeoJSON 对象类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonMultiLineString

有效的 GeoJSON MultiLineString 几何类型。 有关详细信息,请参阅 RFC 7946

名称 类型 说明
coordinates

number[]

几何图形的 GeoJson MultiLineString 坐标。

type string:

MultiLineString

指定 GeoJSON 类型。 必须是九种有效的 GeoJSON 对象类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonMultiPoint

有效的 GeoJSON MultiPoint 几何类型。 有关详细信息,请参阅 RFC 7946

名称 类型 说明
coordinates

number[]

几何图形的 GeoJson MultiPoint 坐标。

type string:

MultiPoint

指定 GeoJSON 类型。 必须是九种有效的 GeoJSON 对象类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonMultiPolygon

有效的 GeoJSON MultiPolygon 对象类型。 有关详细信息,请参阅 RFC 7946

名称 类型 说明
coordinates

number[]

包含有效 GeoJSON Polygon 对象的列表。 请注意 ,GeoJSON 中的坐标采用 x、y 顺序 (经度、纬度) 。

type string:

MultiPolygon

指定 GeoJSON 类型。 必须是九种有效的 GeoJSON 对象类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonObjectType

指定 GeoJSON 类型:FeatureCollection。

名称 类型 说明
FeatureCollection

string

GeoJSON FeatureCollection 对象。

GeoJsonPoint

有效的 GeoJSON Point 几何类型。 有关详细信息,请参阅 RFC 7946

名称 类型 说明
coordinates

number[]

Position 包含两个或多个元素的数字数组。 前两个元素是 经度纬度,精确按此顺序排列。 海拔高度 是可选的第三个元素。 有关详细信息,请参阅 RFC 7946

type string:

Point

指定 GeoJSON 类型。 必须是九种有效的 GeoJSON 对象类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonPolygon

有效的 GeoJSON Polygon 几何类型。 有关详细信息,请参阅 RFC 7946

名称 类型 说明
coordinates

number[]

GeoJson Polygon几何类型的坐标。

type string:

Polygon

指定 GeoJSON 类型。 必须是九种有效的 GeoJSON 对象类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。