lumis.service.analytics.usersegmentation.rest

Class UserSegmentationRestAPI

java.lang.Object

lumis.service.analytics.usersegmentation.rest.UserSegmentationRestAPI

@Path(value="/lumis/service/analytics/usersegmentation/{si:[a-fA-F0-9]{32}}/rest")
public class UserSegmentationRestAPI
extends Object

User segmentation resource.

Since:

11.0.0

Version:

$Revision: 21881 $ $Date: 2018-09-21 20:09:37 +0000 (Fri, 21 Sep 2018) $

Constructor Summary

Constructors

Constructor and Description
UserSegmentationRestAPI()

Method Summary

Modifier and Type	Method and Description
Response	getUserDetails(String userId) Returns the user details.
Response	getUsers(String jsonData, int maxSize, int startAt) Returns the users list based on the given filters.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserSegmentationRestAPI

public UserSegmentationRestAPI()

Method Detail

getUsers

@Path(value="/users")
 @POST
 @Produces(value="application/json")
public Response getUsers(@FormParam(value="filters")
                                                                                           String jsonData,
                                                                                           @FormParam(value="maxSize") @DefaultValue(value="50") @Min(value=1L) @Max(value=50L)
                                                                                           int maxSize,
                                                                                           @FormParam(value="startAt") @Min(value=1L) @DefaultValue(value="1")
                                                                                           int startAt)
                                                                                    throws PortalException

Returns the users list based on the given filters.

Parameters:

jsonData - the JSON data of applied filters.

maxSize - the maximum number of hits of the query.

startAt - the number of first hit of the query.

serviceInstanceId - the service instance identifier.

Returns:

the users list based on the given filters.

Throws:

PortalException

Since:

11.0.0

getUserDetails

@Path(value="/user/{userId:[\\w\\-]{32}}")
 @GET
 @Produces(value="application/json")
public Response getUserDetails(@PathParam(value="userId")
                                                                                                                     String userId)
                                                                                                              throws PortalException

Returns the user details.

Parameters:

jsonData - the JSON data of applied filters.

Returns:

the users list based on the given filters.

Throws:

PortalException

Since:

11.0.0