Package org.finos.fluxnova.bpm.engine.rest

Interface IncidentRestService

All Known Implementing Classes:

IncidentRestServiceImpl

@Produces("application/json")
public interface IncidentRestService

Author:

Roman Smirnov

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PATH

Method Summary

Modifier and Type	Method	Description
IncidentResource	getIncident(String incidentId)
List<IncidentDto>	getIncidents(jakarta.ws.rs.core.UriInfo uriInfo, Integer firstResult, Integer maxResults)	Exposes the IncidentQuery interface as a REST service.
CountResultDto	getIncidentsCount(jakarta.ws.rs.core.UriInfo uriInfo)
List<ProcessInstanceIncidentCountStatisticsDto>	getProcessInstanceIncidentStatistics(ProcessInstanceIncidentCountRequestDto request)	Retrieves statistics about incidents grouped by process instance, based on the provided request criteria.

Field Details

PATH

static final String PATH

See Also:

• Constant Field Values

Method Details

getIncidents

@GET
@Produces("application/json")
List<IncidentDto> getIncidents(@Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 @QueryParam("firstResult")
 Integer firstResult,
 @QueryParam("maxResults")
 Integer maxResults)

Exposes the IncidentQuery interface as a REST service.

Parameters:

uriInfo -

firstResult -

maxResults -

Returns:

getIncidentsCount

@GET
@Path("/count")
@Produces("application/json")
CountResultDto getIncidentsCount(@Context
 jakarta.ws.rs.core.UriInfo uriInfo)

getIncident

@Path("/{id}")
IncidentResource getIncident(@PathParam("id")
 String incidentId)

getProcessInstanceIncidentStatistics

@POST
@Path("/process-instance-statistics")
@Consumes("application/json")
@Produces("application/json")
List<ProcessInstanceIncidentCountStatisticsDto> getProcessInstanceIncidentStatistics(ProcessInstanceIncidentCountRequestDto request)

Retrieves statistics about incidents grouped by process instance, based on the provided request criteria.

This endpoint accepts a ProcessInstanceIncidentCountRequestDto in the request body, which can specify various filters and grouping options. The response is a list of ProcessInstanceIncidentCountStatisticsDto objects, each representing aggregated incident statistics for process instances matching the criteria.

Typical use cases include reporting, monitoring, or dashboarding scenarios where grouped or filtered incident counts are required for process instances.

Parameters:

request - the request object containing filtering and grouping criteria

Returns:

a list of statistics objects, each containing incident count information for a group of process instances