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: 22203 $ $Date: 2018-12-17 18:01:28 +0000 (Mon, 17 Dec 2018) $

Constructor Summary

Constructors

Constructor and Description
UserSegmentationRestAPI()

Method Summary

Modifier and Type	Method and Description
Response	downloadSegmentationCSV(String jsonData, List<String> fields, Character columnSeparator) Returns a CSV file containing the users in a given segmentation list.
static List<FieldReportCSV>	getOrderedFieldsReportCSV(List<String> requestFieldCodes) Receive a list of request fields like "_userAttribue_:" or "", then, return a ordered list of {link FieldReportCSV}
Response	getSegmentation(String id) Return segmentation by id.
Response	getSegmentations(String name) Returns the segmentations list.
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.
static org.json.JSONObject	parseToJsonObject(UserSegmentation userSegmentation) Receives a entity and returns a json client format.
Response	saveSegmentation(String body, String id) Quick save operation for segmentation.

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

downloadSegmentationCSV

@Path(value="/users/csv")
 @POST
 @Produces(value="text/csv")
public Response downloadSegmentationCSV(@FormParam(value="filters")
                                                                                                      String jsonData,
                                                                                                      @FormParam(value="field")
                                                                                                      List<String> fields,
                                                                                                      @FormParam(value="columnSeparator") @DefaultValue(value=";")
                                                                                                      Character columnSeparator)
                                                                                               throws PortalException

Returns a CSV file containing the users in a given segmentation list.

Parameters:

jsonData - the JSON data of applied filters in the segmentation.

fields - the service instance identifier.

Returns:

the users list based on the given filters.

Throws:

PortalException

Since:

11.1.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

saveSegmentation

@Path(value="/segmentation/{id:[a-fA-F0-9]{32}}")
 @PUT
 @Consumes(value="application/json")
 @Produces(value="application/json")
public Response saveSegmentation(String body,
                                                                                                                                                                   @PathParam(value="id") @NotBlank
                                                                                                                                                                   String id)

Quick save operation for segmentation.

Parameters:

segmentationFilter - the segmentation filter.

id - the segmentation identifier.

Returns:

the response.

Throws:

PortalException

Since:

11.1.0

getSegmentation

@Path(value="/segmentation/{id:[a-fA-F0-9]{32}}")
 @GET
 @Consumes(value="application/json")
 @Produces(value="application/json")
public Response getSegmentation(@PathParam(value="id") @NotBlank
                                                                                                                                                                  String id)

Return segmentation by id.

Parameters:

id - the segmentation identifier.

Returns:

the response.

Since:

11.1.0

parseToJsonObject

public static org.json.JSONObject parseToJsonObject(UserSegmentation userSegmentation)

Receives a entity and returns a json client format.

Parameters:

userSegmentation - the entity.

Returns:

the json object.

Since:

11.1.0

getSegmentations

@Path(value="/segmentations")
 @GET
 @Produces(value="application/json")
public Response getSegmentations(@QueryParam(value="name")
                                                                                                          String name)
                                                                                                   throws PortalException

Returns the segmentations list.

Returns:

the response.

Throws:

PortalException

Since:

11.1.0

getOrderedFieldsReportCSV

public static List<FieldReportCSV> getOrderedFieldsReportCSV(List<String> requestFieldCodes)

Receive a list of request fields like "_userAttribue_:" or "", then, return a ordered list of {link FieldReportCSV}

Parameters:

requestFieldCodes - code for each column field.

Returns:

structured and ordered list fields.

Since:

11.1.0