lumis.service.analytics.automationflow

Class FlowResource

java.lang.Object

lumis.service.analytics.automationflow.FlowResource

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

REST API for automation flow.

Since:

12.0.0

Version:

$Revision: 23035 $ $Date: 2019-08-05 19:55:10 +0000 (Mon, 05 Aug 2019) $

Constructor Summary

Constructors

Constructor and Description
FlowResource() Default constructor.

Method Summary

Modifier and Type	Method and Description
String	getFlowsByServiceInstance() Returns the flows of the given service instance as a JSON array.
String	getUserSegmentationsByServiceInstanceId() Returns the user segmentations of the given service instance.
String	quickSave(String flowId, String flowDefinition) Updates the definition of the flow with the given identifier.
static org.json.JSONObject	toJSON(FlowEntry flowEntry) Returns a JSON representation of the given flow.

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowResource

public FlowResource()

Default constructor.

Since:

12.0.0

Method Detail

getFlowsByServiceInstance

@GET
 @Produces(value="application/json")
 @Path(value="/flows")
public String getFlowsByServiceInstance()
                                                                                                  throws PortalException

Returns the flows of the given service instance as a JSON array.

Returns:

the flows of the given service instance as a JSON array.

Throws:

PortalException

Since:

12.0.0

quickSave

@Path(value="/flows/{id:[a-fA-F0-9]{32}}")
 @PUT
 @Consumes(value="application/json")
 @Produces(value="application/json")
public String quickSave(@PathParam(value="id")
                                                                                                                                                   String flowId,
                                                                                                                                                   String flowDefinition)
                                                                                                                                            throws PortalException

Updates the definition of the flow with the given identifier.

Parameters:

flowId - the flow identifier

flowDefinition - the flow definition

Returns:

the updated flow.

Throws:

PortalException

Since:

12.0.0

getUserSegmentationsByServiceInstanceId

@Path(value="/userSegmentations")
 @GET
 @Produces(value="application/json")
public String getUserSegmentationsByServiceInstanceId()
                                                                                                                            throws PortalException

Returns the user segmentations of the given service instance.

Returns:

the user segmentations of the given service instance.

Throws:

PortalException

Since:

12.0.0

toJSON

public static org.json.JSONObject toJSON(FlowEntry flowEntry)

Returns a JSON representation of the given flow.

Parameters:

flowEntry - the flow

Returns:

a JSON representation of the given flow.

Since:

12.0.0