myGroups


URI

<myContent_uri>/groups[.<format>]

支持的方法

GETHEAD

父资源

myContent

介绍

myGroups 资源是当前用户创建的所有群组的集合。

支持的方法:

支持的表述格式:RJSON、JSON、HTML、XML。

资源层次

HTTP 请求方法

对如下 URI 执行 HTTP 请求,以 rjson 输出格式为例加以说明,其中,supermapiportal 是服务器名。

http://supermapiportal:8190/iportal/web/mycontent/groups.rjson

GET 请求

获取当前用户创建的群组列表信息。

请求参数

如果参数未设置,则返回当前用户创建的当前第一页中的群组列表信息,设置参数后,会返回用户指定的群组列表信息,请求参数必须包含在 URI 中。

名称 类型 含义
tags String[] 根据群组标签查询。
isEnabled Boolean 根据群组的启用、禁用状态查询。
isPublic Boolean 根据群组是否公开的状态查询。
orderBy GroupOrderBy 根据群组的排序类型查询。
keywords String[] 根据关键词查询。
filterFields FilterFields[] 用于关键字查询时的字段过滤。字段名称需大写。例如:根据群组名称的关键字符过滤,则需要设置 keywords=["FA"]&filterFields=["GROUPNAME"]。

响应结构

对 myGroups 资源执行 GET 请求,返回当前用户创建的所有群组列表信息。由以下字段组成:

字段 类型 说明
content List<GroupBasicInfo> 页面内容。
currentPage int 当前第几页。
pageSize int 每页大小。
searchParameter SearchParameter 当前页搜索参数。
total int 总记录数。
totalPage int 总页数。

响应示例

对 myGroups 资源:http://localhost:8190/iportal/web/mycontent/groups.rjson 执行 GET 请求,返回的 rjson 格式的表述结构如下:

{

    "content": [

        {

            "createTime": 1461721285156,

            "creator": "admin",

            "description": "",

            "groupName": "FA",

            "icon": null,

            "id": 1,

            "isEnabled": true,

            "isNeedCheck": true,

            "isPublic": true,

            "nickname": "admin",

            "resourceSharer": "MEMBER",

            "tags": [

                "iPortal"

            ],

            "updateTime": 1461721285156

        }

    ],

    "currentPage": 1,

    "pageSize": 9,

    "searchParameter": {

        "currentPage": 1,

        "currentUser": null,

        "filterFields": null,

        "isEnabled": null,

        "isPublic": null,

        "joinTypes": null,

        "keywords": null,

        "orderBy": null,

        "orderType": "ASC",

        "pageSize": 9,

        "returnCanJoin": false,

        "returnCreate": false,

        "returnJoined": false,

        "tags": null,

        "userNames": [

            "admin"

        ]

    },

    "total": 1,

    "totalPage": 1

}

HEAD 请求

返回跟 GET 请求一样的 HTTP 响应头,但是没有响应实体。可以在不必传输整个响应内容的情况下,获取包含在响应消息头中的元数据信息。元数据信息包括媒体类型,字符编码,压缩编码,实体内容长度等。

HEAD 请求可以用来判断 myGroups 资源是否存在,或者客户端是否有权限访问 myGroups 资源。通过对加.<format>的 URI 执行 HEAD 请求,还可以快速判断 myGroups 资源是否支持<format>格式的表述。

请参见