Package org.camunda.bpm.engine.rest.impl.optimize

Class OptimizeRestService

java.lang.Object

org.camunda.bpm.engine.rest.spi.impl.AbstractProcessEngineAware

org.camunda.bpm.engine.rest.impl.AbstractRestProcessEngineAware

org.camunda.bpm.engine.rest.impl.optimize.OptimizeRestService

@Produces("application/json")
public class OptimizeRestService
extends AbstractRestProcessEngineAware

Field Summary

Fields

Modifier and Type	Field	Description
static String	PATH

Fields inherited from class org.camunda.bpm.engine.rest.impl.AbstractRestProcessEngineAware

objectMapper, relativeRootResourcePath

Fields inherited from class org.camunda.bpm.engine.rest.spi.impl.AbstractProcessEngineAware

processEngine

Constructor Summary

Constructors

Constructor	Description
OptimizeRestService(String engineName, com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Method Summary

Modifier and Type	Method	Description
protected int	ensureValidMaxResults(int givenMaxResults)
List<OptimizeHistoricActivityInstanceDto>	getCompletedHistoricActivityInstances(String finishedAfterAsString, String finishedAtAsString, int maxResults)
List<HistoricIncidentDto>	getCompletedHistoricIncidents(String finishedAfterAsString, String finishedAtAsString, int maxResults)
List<HistoricProcessInstanceDto>	getCompletedHistoricProcessInstances(String finishedAfterAsString, String finishedAtAsString, int maxResults)
List<HistoricTaskInstanceDto>	getCompletedHistoricTaskInstances(String finishedAfterAsString, String finishedAtAsString, int maxResults)
List<HistoricDecisionInstanceDto>	getHistoricDecisionInstances(String evaluatedAfterAsString, String evaluatedAtAsString, int maxResults)
List<OptimizeHistoricIdentityLinkLogDto>	getHistoricIdentityLinkLogs(String occurredAfterAsString, String occurredAtAsString, int maxResults)
List<UserOperationLogEntryDto>	getHistoricUserOperationLogs(String occurredAfterAsString, String occurredAtAsString, int maxResults)
List<OptimizeHistoricVariableUpdateDto>	getHistoricVariableUpdates(String occurredAfterAsString, String occurredAtAsString, boolean excludeObjectValues, int maxResults)
List<HistoricIncidentDto>	getOpenHistoricIncidents(String createdAfterAsString, String createdAtAsString, int maxResults)
List<OptimizeHistoricActivityInstanceDto>	getRunningHistoricActivityInstances(String startedAfterAsString, String startedAtAsString, int maxResults)
List<HistoricProcessInstanceDto>	getRunningHistoricProcessInstances(String startedAfterAsString, String startedAtAsString, int maxResults)
List<HistoricTaskInstanceDto>	getRunningHistoricTaskInstances(String startedAfterAsString, String startedAtAsString, int maxResults)

Methods inherited from class org.camunda.bpm.engine.rest.impl.AbstractRestProcessEngineAware

getObjectMapper, getProcessEngine, setRelativeRootResourceUri

Methods inherited from class java.lang.Object

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

Field Detail

PATH

public static final String PATH

See Also:

Constant Field Values

Constructor Detail

OptimizeRestService

public OptimizeRestService(String engineName,
                           com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Method Detail

getCompletedHistoricActivityInstances

@GET
@Path("/activity-instance/completed")
public List<OptimizeHistoricActivityInstanceDto> getCompletedHistoricActivityInstances(@QueryParam("finishedAfter")
                                                                                       String finishedAfterAsString,
                                                                                       @QueryParam("finishedAt")
                                                                                       String finishedAtAsString,
                                                                                       @QueryParam("maxResults")
                                                                                       int maxResults)

getRunningHistoricActivityInstances

@GET
@Path("/activity-instance/running")
public List<OptimizeHistoricActivityInstanceDto> getRunningHistoricActivityInstances(@QueryParam("startedAfter")
                                                                                     String startedAfterAsString,
                                                                                     @QueryParam("startedAt")
                                                                                     String startedAtAsString,
                                                                                     @QueryParam("maxResults")
                                                                                     int maxResults)

getCompletedHistoricTaskInstances

@GET
@Path("/task-instance/completed")
public List<HistoricTaskInstanceDto> getCompletedHistoricTaskInstances(@QueryParam("finishedAfter")
                                                                       String finishedAfterAsString,
                                                                       @QueryParam("finishedAt")
                                                                       String finishedAtAsString,
                                                                       @QueryParam("maxResults")
                                                                       int maxResults)

getRunningHistoricTaskInstances

@GET
@Path("/task-instance/running")
public List<HistoricTaskInstanceDto> getRunningHistoricTaskInstances(@QueryParam("startedAfter")
                                                                     String startedAfterAsString,
                                                                     @QueryParam("startedAt")
                                                                     String startedAtAsString,
                                                                     @QueryParam("maxResults")
                                                                     int maxResults)

getHistoricUserOperationLogs

@GET
@Path("/user-operation")
public List<UserOperationLogEntryDto> getHistoricUserOperationLogs(@QueryParam("occurredAfter")
                                                                   String occurredAfterAsString,
                                                                   @QueryParam("occurredAt")
                                                                   String occurredAtAsString,
                                                                   @QueryParam("maxResults")
                                                                   int maxResults)

getHistoricIdentityLinkLogs

@GET
@Path("/identity-link-log")
public List<OptimizeHistoricIdentityLinkLogDto> getHistoricIdentityLinkLogs(@QueryParam("occurredAfter")
                                                                            String occurredAfterAsString,
                                                                            @QueryParam("occurredAt")
                                                                            String occurredAtAsString,
                                                                            @QueryParam("maxResults")
                                                                            int maxResults)

getCompletedHistoricProcessInstances

@GET
@Path("/process-instance/completed")
public List<HistoricProcessInstanceDto> getCompletedHistoricProcessInstances(@QueryParam("finishedAfter")
                                                                             String finishedAfterAsString,
                                                                             @QueryParam("finishedAt")
                                                                             String finishedAtAsString,
                                                                             @QueryParam("maxResults")
                                                                             int maxResults)

getRunningHistoricProcessInstances

@GET
@Path("/process-instance/running")
public List<HistoricProcessInstanceDto> getRunningHistoricProcessInstances(@QueryParam("startedAfter")
                                                                           String startedAfterAsString,
                                                                           @QueryParam("startedAt")
                                                                           String startedAtAsString,
                                                                           @QueryParam("maxResults")
                                                                           int maxResults)

getHistoricVariableUpdates

@GET
@Path("/variable-update")
public List<OptimizeHistoricVariableUpdateDto> getHistoricVariableUpdates(@QueryParam("occurredAfter")
                                                                          String occurredAfterAsString,
                                                                          @QueryParam("occurredAt")
                                                                          String occurredAtAsString,
                                                                          @QueryParam("excludeObjectValues")
                                                                          boolean excludeObjectValues,
                                                                          @QueryParam("maxResults")
                                                                          int maxResults)

getCompletedHistoricIncidents

@GET
@Path("/incident/completed")
public List<HistoricIncidentDto> getCompletedHistoricIncidents(@QueryParam("finishedAfter")
                                                               String finishedAfterAsString,
                                                               @QueryParam("finishedAt")
                                                               String finishedAtAsString,
                                                               @QueryParam("maxResults")
                                                               int maxResults)

getOpenHistoricIncidents

@GET
@Path("/incident/open")
public List<HistoricIncidentDto> getOpenHistoricIncidents(@QueryParam("createdAfter")
                                                          String createdAfterAsString,
                                                          @QueryParam("createdAt")
                                                          String createdAtAsString,
                                                          @QueryParam("maxResults")
                                                          int maxResults)

getHistoricDecisionInstances

@GET
@Path("/decision-instance")
public List<HistoricDecisionInstanceDto> getHistoricDecisionInstances(@QueryParam("evaluatedAfter")
                                                                      String evaluatedAfterAsString,
                                                                      @QueryParam("evaluatedAt")
                                                                      String evaluatedAtAsString,
                                                                      @QueryParam("maxResults")
                                                                      int maxResults)

ensureValidMaxResults

protected int ensureValidMaxResults(int givenMaxResults)