<portalStatistics_uri>/user/list[.<format>]
The userList resource is the iPortal user list information. By sending a GET request, you can get the iPortal user list information.
Supported Methods:
Supported output formats: rjson, json, html, xml.
Implement the HTTP request on the following URI, where supermapiportal is the server name, with rjson being the output format.
http://supermapiportal:8090/iportal/manager/portalstatistics/user/list.rjson
Get the iPortal user list information.
If the parameter is not set, it will return the user list information of the first ten users in iPortal; if set, it will return according to the specified parameter. The request parameters should be contained in URI.
| Name | Type | Description |
| distributionTypeByRole | DistributionTypeByRole | Query according to the user role. |
| startTime | Long | Query according the user creating time in iPortal. If it is not a positive number it will query from the earliest saved record. It is the value in millisecond of the time since 00:00:00 GMT January 1, 1970. |
| endTime | Long | Query according the user ending time in Portal. If not set or it is a negative value, it will take the current server time as the end time. It is the value in millisecond of the time since 00:00:00 GMT January 1, 1970. |
| orderBy | Orderby | Query by the ordering field. |
| orderType | OrderType | Query according to sort ascending/descending order. |
| currentPage | int | Page number. |
| pageSize | int | Page size. |
Perform the GET request on the userList resource, to return the user list information. Including the following fields:
| Field | Type | Description |
| content | List<IportalUserWithLoginInfo> | Page content. |
| currentPage | int | The current page number. |
| pageSize | int | The page size. |
| searchParameter | SearchParameter | The search parameter for the current page. |
| total | int | The total record number. |
| totalPage | int | The total number of pages. |
The returned rjson format representation after implementing the GET request on the userList resource http://localhost:8090/iportal/manager/portalstatistics/user/list.rjson is as follows:
{
"content": [
{
"departmentId": null,
"departmentNames": null,
"description": null,
"elapsedTime": 458883,
"email": null,
"isLocked": false,
"joinTime": 1497430323280,
"loginCount": 1,
"loginTime": 1497430333117,
"name": "admin",
"nickname": "admin",
"ownRoles": [
"ADMIN",
"SYSTEM"
],
"password": null,
"passwordLastModified": {
"date": 14,
"hours": 16,
"minutes": 52,
"month": 5,
"seconds": 3,
"time": 1497430323170,
"year": 117
},
"passwordQuestion": null,
"roles": [
"ADMIN",
"SYSTEM"
],
"userGroups": []
},
{
"departmentId": null,
"departmentNames": null,
"description": "",
"elapsedTime": 319920,
"email": null,
"isLocked": false,
"joinTime": 1497430374014,
"loginCount": 1,
"loginTime": 1497430472080,
"name": "user1",
"nickname": "user1",
"ownRoles": [
"PORTAL_USER"
],
"password": null,
"passwordLastModified": {
"date": 14,
"hours": 16,
"minutes": 52,
"month": 5,
"seconds": 53,
"time": 1497430373922,
"year": 117
},
"passwordQuestion": null,
"roles": [
"PORTAL_USER"
],
"userGroups": []
}
],
"currentPage": 1,
"pageSize": 10,
"searchParameter": {
"currentPage": 1,
"distributionTypeByRole": null,
"endTime": -1,
"keywords": null,
"orderBy": null,
"orderType": "ASC",
"pageSize": 10,
"startTime": -1,
"userNames": [
"user1",
"admin"
]
},
"total": 2,
"totalPage": 1
}
If you need to get the user list information for a specified user such as the common user whose role is PORTAL_USER, then please set: distributionTypeByRole=NORMAL. The returned rjson format representation after implementing the GET request on the userList resource http://localhost:8090/iportal/manager/portalstatistics/user/list.rjson?distributionTypeByRole=NORMAL is as follows:
{
"content": [
{
"departmentId": null,
"departmentNames": null,
"description": "",
"elapsedTime": 391920,
"email": null,
"isLocked": false,
"joinTime": 1497430374014,
"loginCount": 1,
"loginTime": 1497430472080,
"name": "user1",
"nickname": "user1",
"ownRoles": [
"PORTAL_USER"
],
"password": null,
"passwordLastModified": {
"date": 14,
"hours": 16,
"minutes": 52,
"month": 5,
"seconds": 53,
"time": 1497430373922,
"year": 117
},
"passwordQuestion": null,
"roles": [
"PORTAL_USER"
],
"userGroups": []
}
],
"currentPage": 1,
"pageSize": 10,
"searchParameter": {
"currentPage": 1,
"distributionTypeByRole": "NORMAL",
"endTime": -1,
"keywords": null,
"orderBy": null,
"orderType": "ASC",
"pageSize": 10,
"startTime": -1,
"userNames": [
"user1"
]
},
"total": 1,
"totalPage": 1
}
Returns the same HTTP response header as the GET request, but does not have the response entity. It can get the metadata information in the response header without transferring the whole response content. Metadata information includes media type, character encoding, compression encoding, entity content length, and so on.
The HEAD request can be used to determine whether the userList resource exists or whether the client has authority to access the resource. It can quickly determine whether the userList resource supports the representation in <format> format by performing HEAD request on URI with <format>.