URI
<mycontent_uri>/groups[.<format>]
Supported methods
Parent resource
Introduction
myGroups is the collection of all the groups created by the current user.
Supported Methods:
- GET: Get the list of all the groups created by the current user.
- HEAD: Check whether the myGroups resource exists. or if the current user has the permission to access myGroups resource.
Supported output formats: rjson, json, html, xml.
Resource hierarchy
HTTP request methods
Execute the HTTP request on the following URI, where supermapiserver is the server name, with rjson being the output format.
http://supermapiportal:8090/iportal/web/mycontent/groups.rjson
GET request
Gets the list of all the groups created by the current user.
Request parameter
If this parameter is not set, then the list of groups on the first page will be returned. If the parameter is set, the list of the groups specified by the user will be returned. The request parameters are included in URI.
| Name | Type | Description |
| tags | String[] | Search by group tag. |
| isEnabled | Boolean | Search by the enable/disable status. |
| isPublic | Boolean | Search by whether the group is open. |
| orderBy | GroupOrderBy | Search by the sorting type of the group. |
| keywords | String[] | Search by keywords. |
| filterFields | FilterFields[] | Field filtering for keyword queries. Field names need to be capitalized. For example, to filter according to the key word of the group name, you need to set: keywords=["FA"]&filterFields=["GROUPNAME"]. |
Response structure
Execute a GET request on the myGroups resource to return the list of all the groups that the current user is allowed to check. It includes the following fields:
| Field | Type | Description |
| content | List<GroupBasicInfo> | Page content. |
| currentPage | int | The current page number. |
| pageSize | int | The size of each page. |
| searchParameter | SearchParameter | The search parameter for the current page. |
| total | int | The total record number. |
| totalPage | int | The total number of pages. |
Response example
The returned rjson format representation after executing the GET request on the user resource http://localhost:8090/iportal/web/mycontent/groups.rjson is as follows:
{
"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 request
Asks for the response identical to the one that would correspond to a GET request, but without the response body. This is useful for retrieving meta-information written in response headers, without having to transport the entire content. The meta-information includes the media-type, content-encoding, transfer-encoding, content-length, etc.
HEAD request can be used to check if the myGroups resource exists, or if the myGroups resource can be accessed by clients. It can also determine if the myGroups resource supports an output format <format> if performed on a URI with .<format> included.