<groups_uri>/{id}[.<format>]
group 资源是单个群组资源管理器,支持查看、更新、删除单个群组资源信息。
支持的方法:
支持的表述格式:RJSON、JSON、HTML、XML。
对如下 URI 执行 HTTP 请求,以 rjson 输出格式为例加以说明,其中,supermapiportal 是服务器名。
http://supermapiportal:8190/iportal/web/groups/{id}.rjson
查看单个群组资源信息。
对 group 资源执行 GET 请求,获取指定的群组信息,由以下字段组成:
字段 | 类型 | 说明 |
basicInfo | GroupBasicInfo | 群组的基本信息。 |
groupMembers | GroupMember | 群组的成员列表。 |
groupResources | GroupResourceEntity | 群组的资源列表。 |
对 group 资源:http://localhost:8190/iportal/web/groups/1.rjson 执行 GET 请求,返回的 rjson 格式的资源表述如下:
{
"basicInfo": {
"createTime": 1418891053489,
"creator": "admin",
"description": "",
"groupName": "FA",
"icon": null,
"id": 1,
"isEnabled": true,
"isNeedCheck": true,
"isPublic": true,
"nickname": "admin",
"resourceSharer": "MEMBER",
"tags": [
"iPortal"
],
"updateTime": 1418891053489
},
"groupMembers": {
"content": [
{
"groupId": 1,
"groupRole": "CREATOR",
"id": 1,
"joinTime": 1418891053489,
"memberDescription": null,
"roleUpdateTime": null,
"userName": "admin"
}
],
"currentPage": 1,
"pageSize": 9,
"searchParameter": null,
"total": 1,
"totalPage": 1
},
"groupResources": {
"content": null,
"currentPage": 1,
"pageSize": 0,
"searchParameter": null,
"total": 0,
"totalPage": 0
}
}
更新单个群组的基本信息。只有群组创建者、门户的系统管理员以及拥有群组管理权限的用户有权限对群组进行更新。
发送请求时,需要在请求体中包含如下参数:
名称 | 类型 | 含义 |
id | Integer | 群组 id。 |
tags | List<String> | 群组的标签。 |
groupName | String | 群组名称。 |
isPublic | Boolean | 群组的类型。 其值为 true:表示公开, 值为:false:表示私有。 |
description | String | 群组的描述信息。 |
resourceSharer | GroupRole | 群组的资源分享者。 |
isNeedCheck | Boolean | 申请加入群组时是否需要审核,默认值为:true,需要审核。 |
返回的资源表述结构如下:
字段 | 类型 | 说明 |
succeed | boolean | 更新单个群组的基本信息是否成功。 |
error | Httperror | 出错信息,如果更新单个群组的基本信息成功,则没有本字段。 |
对 group 资源:http://localhost:8190/iportal/web/groups/4.rjson 执行 PUT 请求,更新单个群组的基本信息,发送请求体如下:
{
"id": 4,
"tags": [
"cloud、iPortal"
],
"groupName": "FC",
"isPublic": true,
"description": "",
"resourceSharer": "MEMBER",
"isNeedCheck": true
}
返回的 rjson 格式的资源表述如下:
{"succeed": true}
删除指定 id 的群组信息。
返回的资源表述结构如下:
字段 | 类型 | 说明 |
succeed | boolean | 删除群组信息是否成功。 |
error | Httperror | 出错信息,如果删除群组信息成功,则没有本字段。 |
对 group 资源:http://localhost:8190/iportal/web/groups/8.rjson 执行 DELETE 请求,返回的 rjson 格式响应结果如下:
{ "succeed": true}
返回跟 GET 请求一样的 HTTP 响应头,但是没有响应实体。可以在不必传输整个响应内容的情况下,获取包含在响应消息头中的元数据信息。元数据信息包括媒体类型,字符编码,压缩编码,实体内容长度等。
HEAD 请求可以用来判断 group 资源是否存在,或者客户端是否有权限访问 group 资源。通过对加.<format>的 URI 执行 HEAD 请求,还可以快速判断 group 资源是否支持<format>格式的表述。