SuperMap iPortal统计api接口使用说明
SuperMap iPortal统计api接口使用说明
-
- 一、门户统计
-
-
-
- 1.1 用户数统计
- 1.2 新增用户
- 1.3 在线用户
-
-
- 二、资源统计
-
-
-
- 2.1 资源数统计
-
- 2.1.1 所有资源访问统计
- 2.1.2 某类或者某几类资源的总数
- 2.2 新增资源
-
- 2.2.1 累计新增资源数
- 2.2.2 新增资源的贡献者信息
- 2.2.3 新增资源详细信息
-
-
- 三、访问统计
-
-
-
- 3.1 服务访问统计
-
- 3.1.1 服务访问统计
- 3.1.2 服务访问者统计
- 3.2 地图访问统计
- 3.3 场景访问统计
- 3.4 数据下载统计
-
-
一、门户统计
1.1 用户数统计
URI：
介绍：
accumulatedUserCountChanges 资源是累计用户数随时间变化的信息资源。通过发送 GET 请求，可以获取一段时间内累计用户数随时间变化的信息。
支持的方法：
GET：获取一段时间内累计用户数随时间变化的信息。
HEAD：检查 accumulatedUserCountChanges 资源是否存在，或权限是否可以访问 accumulatedUserCountChanges 资源。
支持的表述格式：RJSON、JSON、HTML、XML。
HTTP 请求方法：
对如下 URI 执行 HTTP 请求，以 rjson 输出格式为例加以说明，其中，supermapiportal 是服务器名。
http://supermapiportal:8190/iportal/manager/portalstatistics/user/accumulatedcountchanges.rjson
GET 请求
获取一段时间内累计用户数随时间变化的信息。
请求参数
参数未设置，默认返回 iPortal 总的累计用户数变化信息，参数设置后，可获取一段时间内 iPortal 累计用户数变化信息， 请求参数必须包含在 URI 中。
| 名称 | 类型 | 含义 |
|---|---|---|
| startTime | Long | 累计用户数记录的起始时间，如果不为正数则从最早保存的历史记录开始查询。值为自 1970 年 1 月 1 日 00:00:00 GMT 以来此日期表示的毫秒数。 |
| endTime | Long | 累计用户数记录的终止时间，如果不为正数或不传此参数，则以服务器当前时间作为终止时间。值为自 1970 年 1 月 1 日 00:00:00 GMT 以来此日期表示的毫秒数。 |
| intervalType | IntervalType | 统计的时间间隔，如果不传此参数，系统会计算一个较合理的时间间隔进行统计。 |
响应结构
对 accumulatedUserCountChanges 资源执行 GET 请求，返回累计用户数变化信息。其中单个时间间隔的累计用户数信息由以下字段组成：
| 字段 | 类型 | 说明 |
|---|---|---|
| accumulatedCount | Integer | 累计用户数。 |
| time | Long | 时间参数未设置时，该参数以首次启用 iPortal 的时间为起始时间，服务器的当前时间为截止时间，单位是毫秒。设置时间参数后，按设置的起始时间和截止时间为准。 |
1.2 新增用户
URI:
介绍:
userList 资源是 iPortal 用户列表信息。通过发送 GET 请求，可以获取iPortal 用户列表信息。
支持的方法：
GET：获取 iPortal 用户列表信息。
HEAD：检查 userList 资源是否存在，或权限是否可以访问 userList 资源。
支持的表述格式：RJSON、JSON、HTML、XML。
HTTP 请求方法:
对如下 URI 执行 HTTP 请求，以 rjson 输出格式为例加以说明，其中，supermapiportal 是服务器名。
http://supermapiportal:8190/iportal/manager/portalstatistics/user/list.rjson
GET 请求
获取 iPortal 用户列表信息。
请求参数：
参数未设置，默认返回 iPortal 的所有用户列表中前10个用户的信息，参数设置后，可根据设置的参数返回指定的用户列表信息， 请求参数必须包含在 URI 中。
| 名称 | 类型 | 含义 |
|---|---|---|
| distributionTypeByRole | DistributionTypeByRole | 按用户的角色分布查询。 |
| startTime | Long | 按用户加入门户的起始时间查询。如果不为正数则从最早保存的历史记录开始查询。值为自 1970 年 1 月 1 日 00:00:00 GMT 以来此日期表示的毫秒数。 |
| endTime | Long | 按用户加入门户的截止时间查询。如果不为正数或不传此参数，则以服务器当前时间作为终止时间。值为自 1970 年 1 月 1 日 00:00:00 GMT 以来此日期表示的毫秒数。 |
| orderBy | Orderby | 按排序字段查询。 |
| orderType | OrderType | 按排序时升序/降序查询。 |
| currentPage | int | 分页页码。 |
| pageSize | int | 分页中每页大小。 |
响应结构
对 userList 资源执行 GET 请求，返回用户列表信息。由以下字段组成：
| 字段 | 类型 | 说明 |
|---|---|---|
| content | List | 页面内容。 |
| currentPage | int | 当前第几页。 |
| pageSize | int | 每页大小。 |
| searchParameter | SearchParameter | 当前页搜索参数。 |
| total | int | 总记录数。 |
| totalPage | int | 总页数。 |
1.3 在线用户
URI:
介绍:
onlineUserList 资源是 iPortal 在线用户数列表资源。通过发送 GET 请求，可以获取 iPortal 在线用户数列表。
支持的方法：
GET：获取 iPortal 在线用户数列表。
HEAD：检查 onlineUserList 资源是否存在，或权限是否可以访问 onlineUserList 资源。
支持的表述格式：RJSON、JSON、HTML、XML。
HTTP 请求方法:
对如下 URI 执行 HTTP 请求，以 rjson 输出格式为例加以说明，其中，supermapiportal 是服务器名。
http://supermapiportal:8190/iportal/manager/portalstatistics/user/onlinelist.rjson
GET 请求:
获取 iPortal 在线用户数列表。
请求参数:
参数未设置，默认返回按照用户名升序排序的在线用户列表信息，参数设置后，可根据设置的参数返回在线用户列表信息， 请求参数必须包含在 URI 中。
| 名称 | 类型 | 含义 |
|---|---|---|
| orderBy | Orderby | 按排序字段查询。 |
| orderType | OrderType | 按排序时升序/降序查询。 |
| currentPage | int | 分页页码。 |
| pageSize | int | 分页中每页大小。 |
响应结构:
对 onlineUserList 资源执行 GET 请求，返回在线用户列表信息。由以下字段组成：
| 字段 | 类型 | 说明 |
|---|---|---|
| content | List | 页面内容。 |
| currentPage | int | 当前第几页。 |
| pageSize | int | 每页大小。 |
| searchParameter | SearchParameter | 当前页搜索参数。 |
| total | int | 总记录数。 |
| totalPage | int | 总页数。 |
二、资源统计
2.1 资源数统计
2.1.1 所有资源访问统计
URI
介绍
totalAccumulatedResourceCountChanges 资源是所有资源总数随时间变化的信息资源。通过发送 GET 请求，可以获取一段时间内所有资源总数随时间变化的信息。
支持的方法：
GET：获取一段时间内所有资源总数随时间变化的信息。
HEAD：检查 totalAccumulatedResourceCountChanges 资源是否存在，或权限是否可以访问 totalAccumulatedResourceCountChanges 资源。
支持的表述格式：RJSON、JSON、HTML、XML。
HTTP 请求方法
对如下 URI 执行 HTTP 请求，以 rjson 输出格式为例加以说明，其中，supermapiportal 是服务器名。
http://supermapiportal:8190/iportal/manager/portalstatistics/resource/totalaccumulatedcountchanges.rjson
GET 请求
获取一段时间内所有资源总数随时间变化的信息。
请求参数
参数未设置，默认返回 iPortal 所有资源总数变化信息，参数设置后，可获取一段时间内 iPortal 所有资源总数变化信息， 请求参数必须包含在 URI 中。
| 字段 | 类型 | 说明 |
|---|---|---|
| startTime | Long | 所有资源总数记录的起始时间，如果不为正数则从最早保存的历史记录开始查询。值为自 1970 年 1 月 1 日 00:00:00 GMT 以来此日期表示的毫秒数。 |
| endTime | Long | 所有资源总数记录的终止时间，如果不为正数或不传此参数，则以服务器当前时间作为终止时间。值为自 1970 年 1 月 1 日 00:00:00 GMT 以来此日期表示的毫秒数。 |
| intervalType | IntervalType | 统计的时间间隔，如果不传此参数，系统会计算一个较合理的时间间隔进行统计。 |
响应结构
对 totalAccumulatedResourceCountChanges 资源执行 GET 请求，返回所有资源总数变化信息。其中单个时间间隔的所有资源总数信息由以下字段组成：
| 字段 | 类型 | 说明 |
|---|---|---|
| accumulatedCount | Integer | 累计资源总数。 |
| time | Long | 时间参数未设置时，该参数以首次启用 iPortal 的时间为起始时间，服务器的当前时间为截止时间，单位是毫秒。设置时间参数后，按设置的起始时间和截止时间为准。 |
2.1.2 某类或者某几类资源的总数
URI
介绍
accumulatedResourceCountChanges 资源是某几类资源的总数随时间变化的信息资源。通过发送 GET 请求，可以获取一段时间内某几类资源的总数随时间变化的信息。
支持的方法：
GET：获取一段时间内某几类资源的总数随时间变化的信息。
HEAD：检查 accumulatedResourceCountChanges 资源是否存在，或权限是否可以访问 accumulatedResourceCountChanges 资源。
支持的表述格式：RJSON、JSON、HTML、XML。
HTTP 请求方法
对如下 URI 执行 HTTP 请求，以 rjson 输出格式为例加以说明，其中，supermapiportal 是服务器名。
http://supermapiportal:8190/iportal/manager/portalstatistics/resource/accumulatedcountchanges.rjson
GET 请求
获取一段时间内某几类资源的总数随时间变化的信息。
请求参数
发送请求时，需要在请求体中包含如下参数， 请求参数必须包含在 URI 中。
| 字段 | 类型 | 说明 |
|---|---|---|
| types | List | 【必选参数】包含：MAP（地图资源）、SERVICE（服务资源）、SCENE（场景资源）、DATA（数据资源）、APP（应用资源）。 |
| startTime | Long | 【可选参数】累计资源数记录的起始时间，如果不为正数则从最早保存的历史记录开始查询。值为自 1970 年 1 月 1 日 00:00:00 GMT 以来此日期表示的毫秒数。 |
| endTime | Long | 【可选参数】累计资源数记录的终止时间，如果不为正数或不传此参数，则以服务器当前时间作为终止时间。值为自 1970 年 1 月 1 日 00:00:00 GMT 以来此日期表示的毫秒数。 |
| intervalType | IntervalType | 【可选参数】统计的时间间隔，如果不传此参数，系统会计算一个较合理的时间间隔进行统计。 |
响应结构
对 accumulatedResourceCountChanges 资源执行 GET 请求，返回某几类资源数变化信息。其中某类资源的单个时间间隔的累计资源数信息由以下字段组成：
| 字段 | 类型 | 说明 |
|---|---|---|
| accumulatedCount | Integer | 累计资源数。 |
| time | Long | 时间参数未设置时，该参数以首次启用 iPortal 的时间为起始时间，服务器的当前时间为截止时间，单位是毫秒。设置时间参数后，按设置的起始时间和截止时间为准。 |
2.2 新增资源
2.2.1 累计新增资源数
URI
介绍
accumulatedResourceCount 资源是一段时间内 iPortal 累计新增资源数资源。通过发送 GET 请求，可获取一段时间内 iPortal 某几类新增资源数。
支持的方法：
GET：获取一段时间内 iPortal 某几类新增资源数。
HEAD：检查 accumulatedResourceCount 资源是否存在，或权限是否可以访问 accumulatedResourceCount 资源。
支持的表述格式：RJSON、JSON、HTML、XML。
HTTP 请求方法
对如下 URI 执行 HTTP 请求，以 rjson 输出格式为例加以说明，其中，supermapiportal 是服务器名。
http://supermapiportal:8190/iportal/manager/portalstatistics/resource/accumulatedcount.rjson
GET 请求
获取一段时间内 iPortal 某几类新增资源数。
请求参数
发送请求时，需要在请求体中包含如下参数， 请求参数必须包含在 URI 中。
| 名称 | 类型 | 含义 |
|---|---|---|
| types | ResourceType[] | 【必选参数】资源类型。包含：MAP（地图资源）、SERVICE（服务资源）、SCENE（场景资源）、DATA（数据资源）、APP（应用资源）。 |
| startTime | Long | 【可选参数】累计资源数记录的起始时间，如果不为正数则从最早保存的历史记录开始查询。值为自 1970 年 1 月 1 日 00:00:00 GMT 以来此日期表示的毫秒数。 |
| endTime | Long | 【可选参数】累计资源数记录的终止时间，如果不为正数或不传此参数，则以服务器当前时间作为终止时间。值为自 1970 年 1 月 1 日 00:00:00 GMT 以来此日期表示的毫秒数。 |
2.2.2 新增资源的贡献者信息
URI
支持的方法
GET、HEAD
介绍
resourceContributors 资源是新增资源的贡献者信息资源。通过发送 GET 请求，可以获取一段时间内新增资源的贡献者信息。
支持的方法：
GET：获取一段时间内新增资源的贡献者信息。
HEAD：检查 resourceContributors 资源是否存在，或权限是否可以访问 resourceContributors 资源。
支持的表述格式：RJSON、JSON、HTML、XML。
HTTP 请求方法
对如下 URI 执行 HTTP 请求，以 rjson 输出格式为例加以说明，其中，supermapiportal 是服务器名。
http://supermapiportal:8190/iportal/manager/portalstatistics/resource/contributors.rjson
GET 请求
获取一段时间内新增资源的贡献者信息。
请求参数
参数未设置，默认返回 iPortal 所有新增资源的贡献者信息，参数设置后，可获取一段时间内 iPortal 新增资源的贡献者信息， 请求参数必须包含在 URI 中。
| 名称 | 类型 | 含义 |
|---|---|---|
| startTime | Long | 按资源创建的起始时间查询。 |
| endTime | Long | 按资源创建的截至时间查询。 |
| orderBy | OrderBy | 按排序字段查询。 |
| currentPage | int | 分页页码。 |
| pageSize | int | 分页中每页大小。 |
| orderType | OrderType | 按排序时升序/降序查询。 |
| resourceType | ResourceType | 资源类型。包含：MAP（地图资源）、SERVICE（服务资源）、SCENE（场景资源）、DATA（数据资源）、APP（应用资源）。 |
响应结构
对 resourceContributors 资源执行 GET 请求，返回新增资源贡献者列表信息。由以下字段组成：
| 字段 | 类型 | 说明 |
|---|---|---|
| content | List | 页面内容。 |
| currentPage | int | 当前第几页。 |
| pageSize | int | 每页大小。 |
| searchParameter | SearchParameter | 当前页搜索参数。 |
| total | int | 总记录数。 |
| totalPage | int | 总页数。 |
2.2.3 新增资源详细信息
URI
支持的方法
GET、HEAD
介绍
resourceList 资源是 iPortal 所有资源的概览列表信息。通过发送 GET 请求，可以获取 iPortal 所有资源的概览列表信息。
支持的方法：
GET：获取 iPortal 所有资源的概览列表信息。
HEAD：检查 resourceList 资源是否存在，或权限是否可以访问 resourceList 资源。
支持的表述格式：RJSON、JSON、HTML、XML。
HTTP 请求方法
对如下 URI 执行 HTTP 请求，以 rjson 输出格式为例加以说明，其中，supermapiportal 是服务器名。
http://supermapiportal:8190/iportal/manager/portalstatistics/resource/list.rjson
GET 请求
获取 iPortal 所有资源的概览列表信息。
请求参数
参数未设置，默认返回 iPortal 的所有资源中的前10个资源的概览列表信息，参数设置后，可根据设置的参数返回指定的资源概览列表信息， 请求参数必须包含在 URI 中。
| 名称 | 类型 | 含义 |
|---|---|---|
| createStart | Long | 按资源创建的起始时间查询。如果不为正数则从最早保存的历史记录开始查询。值为自 1970 年 1 月 1 日 00:00:00 GMT 以来此日期表示的毫秒数。 |
| createEnd | Long | 按资源创建的截止时间查询。如果不为正数或不传此参数，则以服务器当前时间作为终止时间。值为自 1970 年 1 月 1 日 00:00:00 GMT 以来此日期表示的毫秒数。 |
| orderBy | ResOverviewInfoOrderBy | 按排序字段查询。 |
| userNames | String[] | 根据资源贡献者名称查询。 |
| orderType | OrderType | 按排序时升序/降序查询。 |
| currentPage | int | 分页页码。 |
| pageSize | int | 分页中每页大小。 |
响应结构
对 resourceList 资源执行 GET 请求，返回资源概览列表信息。由以下字段组成：
| 字段 | 类型 | 说明 |
|---|---|---|
| content | List | 页面内容。 |
| currentPage | int | 当前第几页。 |
| pageSize | int | 每页大小。 |
| searchParameter | SearchParameter | 当前页搜索参数。 |
| total | int | 总记录数。 |
| totalPage | int | 总页数。 |
三、访问统计
3.1 服务访问统计
3.1.1 服务访问统计
URI
支持的方法
GET、POST、DELETE、HEAD
介绍
services 资源是当前用户有权限查看的服务的集合，通过发送 POST 请求，可以申请注册新的单个服务；通过发送 DETELE 请求，可以批量删除服务。普通的 iPortal 用户申请注册的服务默认不需要门户管理员审核即可注册到门户中。当然，门户管理员也可以开启服务审核功能，此时只有经过管理员审核通过后的服务才能注册到 iPortal 门户中。审核单个服务的资源请参见：serviceCheckStatus 资源的 PUT 请求。
支持的方法：
GET：根据查询参数获取服务列表信息。
POST：申请注册新的单个服务。
DELETE：删除服务，支持批量删除服务。
HEAD：检查 services 资源是否存在，或权限是否可以访问 services 资源。
支持的表述格式：RJSON、JSON、HTML、XML。
HTTP 请求方法
对如下 URI 执行 HTTP 请求，以 rjson 输出格式为例加以说明，其中，supermapiportal 是服务器名。
http://supermapiportal:8190/iportal/web/services.rjson
GET 请求
获取当前用户有权限查看的服务列表信息。
请求参数
如果参数未设置，则返回用户有权限查看的当前第一页中的服务列表信息，设置参数后，会返回用户指定的服务列表信息，请求参数必须包含在 URI 中。
| 字段 | 类型 | 说明 |
|---|---|---|
| ids | Integer[] | 由服务项 id 组成的整型数组。 |
| tags | String[] | 根据标签过滤。 |
| userNames | String[] | 根据服务注册者名称过滤。 |
| types | SourceType[] | 根据服务类型过滤。 |
| checkStatus | CheckStatus | 根据审核状态过滤。 |
| isDataItemService | Boolean | 根据是否为用户数据发布的服务过滤。 |
| enable | Boolean | 根据服务是否启用过滤。 |
| offline | Boolean | 根据服务是否离线过滤。 |
| permissionType | String | 根据权限类型过滤。权限类型包括 SEARCH（可检索）、READ（可查看）、DELETE（可删除）。 |
| shareToMe | Boolean | 是否查询直接分享给我的资源。该参数已过期。 |
| orderBy | ServiceOrderBy | 根据排序字段过滤。其中，按服务访问次数排序字段只有在启用服务代理功能后才生效。 |
| orderType | OrderType | 根据升序还是降序过滤。 |
| keywords | String[] | 根据关键字过滤。 |
| currentPage | int | 根据分页页码过滤。 |
| pageSize | int | 根据分页大小过滤。 |
| isBatch | Boolean | 根据服务是否是批量注册过滤。 |
| dirIds | Integer[] | 根据目录 id 过滤。 |
| returnSubDir | Boolean | 是否查询子目录的资源。true 表示返回当前查询目录及其子目录的资源，false 表示仅返回当前目录的资源。 |
| isNotInDir | Boolean | 根据是否是未分组的进行过滤，默认值为 false。如果为 true，则返回所有未分组的服务列表信息；如果为 false，则返回全部的服务列表信息。 未分组是指未添加到目录的服务列表资源。 |
| searchScope | SearchScope | 根据共享范围过滤。 |
| filterFields | FilterFields[] | 用于关键字查询时的字段过滤。字段名称需大写。例如：根据服务注册者的关键字符过滤，则需要设置 keywords=[“admin”]&filterFields=[“NICKNAME”]。 |
| accessMode | AccessMode | 根据服务访问模式过滤。该参数已过期。 |
| authorizedOnly | Boolean | 根据是否是已授权访问的服务过滤，默认 false，返回全部的服务列表；如果为 true，则只返回经过授权访问的服务。此参数仅在服务共享 v2 模式下有效，iPortal 默认使用的是 v2模式。该参数已过期。 |
| visitStart | Long | 查询此时间值及此时间值之后的访问量，如果为null或者小于0，则起始时间不限制。 |
| visitEnd | Long | 查询此时间值及此时间值之前的访问量，如果为null或者小于0，则截止时间不限制。 |
| createStart | Long | 查询此时间值及此时间值之后创建的服务，如果为null或者小于0，则起始时间不限制。 |
| createEnd | Long | 查询此时间值及此时间值之前创建的服务，如果为null或者小于0，则截止时间不限制。 |
响应结构
对 services 资源执行 GET 请求，返回当前用户有权查看的服务列表信息。由以下字段组成：
| 字段 | 类型 | 说明 |
|---|---|---|
| content | List | 页面内容。 |
| currentPage | int | 当前第几页。 |
| pageSize | int | 每页大小。 |
| searchParameter | SearchParameter | 当前页搜索参数。 |
| total | int | 总记录数。 |
| totalPage | int | 总页数。 |
3.1.2 服务访问者统计
URI
支持的方法
GET、HEAD
介绍
visitors 资源是某类资源的访问者概览信息资源。通过发送 GET 请求，可以获取某类资源的访问者概览信息。目前支持获取门户中服务资源的访问者概览信息，需要您开启服务代理功能以及服务代理访问统计功能。
支持的方法：
GET：获取某类资源的访问者概览信息。
HEAD：检查 visitors 资源是否存在，或权限是否可以访问 visitors 资源。
支持的表述格式：RJSON、JSON、HTML、XML。
HTTP 请求方法
对如下 URI 执行 HTTP 请求，以 rjson 输出格式为例加以说明，其中，supermapiportal 是服务器名。
http://supermapiportal:8190/iportal/manager/portalstatistics/resource/visit/visitors.rjson
GET 请求
获取某类资源的访问者概览信息。
请求参数
发送请求时，需要在请求体中包含如下参数， 请求参数必须包含在 URI 中。
| 名称 | 类型 | 含义 |
|---|---|---|
| resourceType | ResourceType | 【必选参数】资源类型。目前支持 SERVICE（服务资源）。 |
| resourceIds | List | 【可选参数】资源的 id 数组。 |
| startTime | Long | 【可选参数】资源访问者概况信息记录的起始时间，如果不为正数则从最早保存的历史记录开始查询。值为自 1970 年 1 月 1 日 00:00:00 GMT 以来此日期表示的毫秒数。 |
| endTime | Long | 【可选参数】资源访问者概况信息记录的终止时间，如果不为正数或不传此参数，则以服务器当前时间作为终止时间。值为自 1970 年 1 月 1 日 00:00:00 GMT 以来此日期表示的毫秒数。 |
| orderBy | ResVisitorOrderBy | 【可选参数】按排序字段查询。 |
| orderType | OrderType | 【可选参数】按排序时升序/降序查询。 |
| currentPage | int | 【可选参数】分页页码。 |
| pageSize | int | 【可选参数】分页中每页大小。 |
| keywords | String[] | 【可选参数】按用户名模糊查询。 |
响应结构
对 visitors 资源执行 GET 请求，返回资源访问者概况信息。由以下字段组成：
| 字段 | 类型 | 说明 |
|---|---|---|
| content | List | 页面内容。 |
| currentPage | int | 当前第几页。 |
| pageSize | int | 每页大小。 |
| searchParameter | SearchParameter | 当前页搜索参数。 |
| total | int | 总记录数。 |
| totalPage | int | 总页数。 |
3.2 地图访问统计
URI
支持的方法
GET、POST、DELETE、HEAD
介绍
maps 资源是当前用户有权查看的地图列表信息，支持创建新的地图，支持批量删除地图。
支持的方法：
GET：根据查询参数获取地图列表信息。
POST：创建新的地图。
DELETE：删除地图。支持批量删除地图。
HEAD：检查 maps 资源是否存在，或权限是否可以访问 maps 资源。
支持的表述格式：RJSON、JSON、HTML、XML。
HTTP 请求方法
对如下 URI 执行 HTTP 请求，以 rjson 输出格式为例加以说明，其中，supermapiportal 是服务器名。
http://supermapiportal:8190/iportal/web/maps.rjson
GET 请求
获取当前用户有权限查看的地图列表信息。
请求参数
如果参数未设置，则返回用户有权限查看的当前第一页中的地图列表信息，设置参数后，会返回用户指定的地图列表信息，请求参数必须包含在 URI 中。
| 名称 | 类型 | 含义 |
|---|---|---|
| userNames | String[] | 根据地图作者名过滤。 |
| tags | String[] | 根据地图标签过滤。 |
| suggest | Boolean | 是否是默认底图。该参数已过期。 |
| sourceTypes | SourceType[] | 根据地图来源类型过滤。包括：SUPERMAP_REST,MAPVIEWER,WMS,WMTS。 |
| mapStatus | ViewerMapStatus | 根据地图状态查询。该参数已过期。 |
| keywords | String[] | 关键字过滤。 |
| searchScope | SearchScope | 根据共享范围过滤。 |
| epsgCodes | Interger[] | 获取指定投影的地图。 |
| orderBy | OrderBy[] | 排序字段，支持多个字段的排序。 |
| orderType | OrderType | 根据升序还是降序过滤。 |
| currentPage | int | 分页页码。 |
| pageSize | int | 分页中每页大小。 |
| excludeIds | Interger[] | 排除的地图 id 列表。 |
| dirIds | Integer[] | 根据目录 id 过滤。 |
| isNotInDir | Boolean | 根据是否是未分组的进行过滤，默认值为 false。如果为 true，则返回所有未分组的地图列表信息；如果为 false，则返回全部的地图列表信息。 未分组是指未添加到目录的地图列表资源。 |
| returnSubDir Boolean 是否查询子目录的资源。true 表示返回当前查询目录及其子目录的资源，false 表示仅返回当前目录的资源。 | ||
| updateStart | Long | 查询此时间值及此时间值之后更新过的地图，如果为 null 或者小于零，则起始时间不限制。 |
| updateEnd | Long | 查询此时间值及此时间值之前更新过的地图，如果为 nul 或者小于零 l，则截止时间不限制。 |
| visitStart | Long | 查询此时间值及此时间值之后访问过的地图，如果为 null 或者小于零，则起始时间不限制。 |
| visitEnd | Long | 查询此时间值及此时间值之前访问过的地图，如果为 null 或者小于零，则截止时间不限制。 |
| filterFields | FilterFields[] | 用于关键字查询时的字段过滤。字段名称需大写。例如：根据地图创建者的关键字符过滤，则需要设置 keywords=[“admin”]&filterFields=[“NICKNAME”]。 |
| shareToMe | Boolean | 是否查询直接分享给我的资源。该参数过期。 |
| permissionType | String | 根据权限类型过滤。权限类型包括 SEARCH（可检索）、READ（可查看）、READWRITE（可编辑）、DELETE（可删除）。 |
| checkStatus | CheckStatus | 根据审核状态过滤。 |
| createStart | Long | 查询此时间值及此时间值之后创建的地图，如果为null或者小于0，则起始时间不限制。 |
| createEnd | Long | 查询此时间值及此时间值之前创建的地图，如果为null或者小于0，则截止时间不限制。 |
响应结构
对 maps 资源执行 GET 请求，返回当前用户有权限查看的地图列表。由以下字段组成：
| 字段 | 类型 | 说明 |
|---|---|---|
| content | List | 页面内容。 |
| currentPage | int | 当前第几页。 |
| pageSize | int | 每页大小。 |
| searchParameter | SearchParameter | 当前页搜索参数。 |
| total | int | 总记录数。 |
| totalPage | int | 总页数。 |
3.3 场景访问统计
URI
支持的方法
GET、POST、DELETE、HEAD
介绍
scenes 资源是当前用户有权限查看的场景列表信息，通过发送 DETELE 请求，可以批量删除场景。
支持的方法：
GET：根据查询参数获取场景列表信息。
POST：添加新的场景。
DELETE：删除场景，支持批量删除场景。
HEAD：检查 scenes 资源是否存在，或权限是否可以访问 scenes 资源。
支持的表述格式：RJSON、JSON、HTML、XML。
HTTP 请求方法
对如下 URI 执行 HTTP 请求，以 rjson 输出格式为例加以说明，其中，supermapiportal 是服务器名。
http://supermapiportal:8190/iportal/web/scenes.rjson
GET 请求
获取当前用户有权限查看的场景列表信息。
请求参数
如果参数未设置，则返回当前用户有权限查看的当前第一页中的场景列表信息，设置参数后，会返回用户指定的场景列表信息，请求参数必须包含在 URI 中。
| 字段 | 类型 | 说明 |
|---|---|---|
| tags | String[] | 根据场景的标签过滤。 |
| userNames | String[] | 根据场景添加者名称过滤。 |
| orderBy | SceneOrderBy | 根据排序字段过滤。 |
| orderType | OrderType | 根据升序还是降序过滤。 |
| keywords | String[] | 根据关键字过滤。 |
| currentPage | int | 根据分页页码过滤。 |
| permissionType | String | 根据权限类型过滤。权限类型包括 SEARCH（可检索）、READ（可查看）、READWRITE（可编辑）、DELETE（可删除）。 |
| returnSubDir | Boolean | 是否查询子目录的资源。true 表示返回当前查询目录及其子目录的资源，false 表示仅返回当前目录的资源。 |
| shareToMe | Boolean | 是否查询直接分享给我的资源。该参数已过期。 |
| searchScope | SearchScope | 根据共享范围过滤。 |
| pageSize | int | 根据分页大小过滤。 |
| dirIds | Integer[] | 根据目录 id 过滤。 |
| isNotInDir | Boolean | 根据是否是未分组的进行过滤，默认值为 false。如果为 true，则返回所有未分组的场景列表信息；如果为 false，则返回全部的场景列表信息。 未分组是指未添加到目录中的场景列表资源。 |
| filterFields | FilterFields[] | 用于关键字查询时的字段过滤。字段名称需大写。例如：根据场景名称的关键字符过滤，则需要设置 keywords=[“osgb”]&filterFields=[“NAME”]。 |
| createStart | Long | 查询此时间值及此时间值之后创建的场景，如果为null或者小于0，则起始时间不限制。 |
| createEnd | Long | 查询此时间值及此时间值之前创建的场景，如果为null或者小于0，则截止时间不限制。 |
响应结构
对 scenes 资源执行 GET 请求，返回当前用户有权查看的场景列表信息。由以下字段组成：
| 字段 | 类型 | 说明 |
|---|---|---|
| content | List | 页面内容。 |
| currentPage | int | 当前第几页。 |
| pageSize | int | 每页大小。 |
| searchParameter | SearchParameter | 当前页搜索参数。 |
| total | int | 总记录数。 |
| totalPage | int | 总页数。 |
3.4 数据下载统计
URI
支持的方法
GET、HEAD
介绍
totalDownloadCountChanges 资源是某类资源总下载次数随时间变化的信息资源。通过发送 GET 请求，可以获取某类资源总下载次数随时间变化的信息。目前支持获取门户中数据资源的下载次数随时间变化的信息。
支持的方法：
GET：获取某类资源总下载次数随时间变化的信息。
HEAD：检查 totalDownloadCountChanges 资源是否存在，或权限是否可以访问 totalDownloadCountChanges 资源。
支持的表述格式：RJSON、JSON、HTML、XML。
HTTP 请求方法
对如下 URI 执行 HTTP 请求，以 rjson 输出格式为例加以说明，其中，supermapiportal 是服务器名。
http://supermapiportal:8190/iportal/manager/portalstatistics/resource/download/totalcountchanges.rjson
GET 请求
获取某类资源总下载次数随时间变化的信息。
请求参数
发送请求时，需要在请求体中包含如下参数， 请求参数必须包含在 URI 中。
| 名称 | 类型 | 含义 |
|---|---|---|
| resourceType | ResourceType | 【必选参数】资源类型。目前支持 DATA（数据资源）。 |
| startTime | Long | 【可选参数】资源总下载次数记录的起始时间，如果不为正数则从最早保存的历史记录开始查询。值为自 1970 年 1 月 1 日 00:00:00 GMT 以来此日期表示的毫秒数。 |
| endTime | Long | 【可选参数】资源总下载次数记录的终止时间，如果不为正数或不传此参数，则以服务器当前时间作为终止时间。值为自 1970 年 1 月 1 日 00:00:00 GMT 以来此日期表示的毫秒数。 |
| intervalType | IntervalType | 【可选参数】统计的时间间隔，如果不传此参数，系统会计算一个较合理的时间间隔进行统计。 |
响应结构
对 totalDownloadCountChanges 资源执行 GET 请求，返回某类资源的总下载次数。其中单个时间间隔的资源总下载次数信息由以下字段组成：
| 字段 | 类型 | 说明 |
|---|---|---|
| time | String | 统计资源总下载次数的时间点。 |
| downloadCount | Long | 资源的总下载次数。 |