URI
<portal_uri>/tags[.<format>]
支持的方法
父资源
介绍
tags 资源是地图、服务、场景、应用、数据、群组等的标签查询资源。
支持的方法:
支持的表述格式:RJSON、JSON、HTML、XML。
资源层次
HTTP 请求方法
对如下 URI 执行 HTTP 请求,以 rjson 输出格式为例加以说明,其中,supermapiportal 是服务器名。
http://supermapiportal:8190/iportal/web/tags.rjson
GET 请求
获取地图、服务、场景、应用、数据、群组等资源的标签信息。
请求参数
如果 searchType 参数未设置,默认返回地图的标签信息,如果设置了 searchType 参数,会返回相对应的地图、服务、应用、数据或群组的标签信息,请求参数必须包含在 URI 中。
名称 | 类型 | 含义 |
sourceTypes | SourceType[] | 根据来源类型过滤。 |
joinTypes | JoinType[] | 根据群组类型过滤。 |
keywords | String[] | 根据关键字过滤。 |
userName | String | 根据指定用户名过滤。 |
searchType | TagSearchType | 标签查询类型,如 MAP、SERVICE、SCENE、APP、DATA、GROUP。 |
start | Integer | 从 start 条数据开始查询。 |
length | Integer | 返回的标签个数。 |
authorizedOnly | Boolean | 根据是否是已授权访问的服务过滤,默认 false,返回全部的服务列表;如果为 true,则只返回经过授权访问的服务。此参数仅在服务共享 v2 模式下有效,iPortal 默认使用的是 v2模式。 |
响应结构
对 tags 资源执行 GET 请求,返回的单个标签的表述结构如下:
字段 | 类型 | 说明 |
tag | String | 标签名。 |
counts | int | 使用次数。 |
响应示例
对 tags 资源:http://localhost:8190/iportal/web/tags.rjson 执行 GET 请求,默认获取所有地图的标签信息,返回 rjson 格式的资源表述如下:
[
{
"counts": 2,
"tag": "上海"
},
{
"counts": 1,
"tag": "北京"
},
{
"counts": 1,
"tag": "海图"
}
]
如果希望获取指定的标签信息,如根据用户名和标签查询类型过滤,则需要设置 userName=admin&searchType=SERVICE,即对 maps 资源:http://localhost:8190/iportal/web/tags.rjson?userName=admin&searchType=SERVICE 执行 GET 请求,返回的 rjson 格式的资源表述如下:
[
{
"counts": 1,
"tag": "WMS"
}
]
HEAD 请求
返回跟 GET 请求一样的 HTTP 响应头,但是没有响应实体。可以在不必传输整个响应内容的情况下,获取包含在响应消息头中的元数据信息。元数据信息包括媒体类型,字符编码,压缩编码,实体内容长度等。
HEAD 请求可以用来判断 tags 资源是否存在,或者客户端是否有权限访问 tags 资源。通过对加.<format>的 URI 执行 HEAD 请求,还可以快速判断 tags 资源是否支持<format>格式的表述。