org.camunda.bpm.engine.rest

Interface ExternalTaskRestService

All Known Implementing Classes:

ExternalTaskRestServiceImpl

public interface ExternalTaskRestService

Author:

Thorben Lindhauer

Field Summary

Fields

Modifier and Type	Field and Description
static String	PATH

Method Summary

Modifier and Type	Method and Description
List<LockedExternalTaskDto>	fetchAndLock(FetchExternalTasksDto fetchingDto)
ExternalTaskResource	getExternalTask(String externalTaskId)
List<ExternalTaskDto>	getExternalTasks(javax.ws.rs.core.UriInfo uriInfo, Integer firstResult, Integer maxResults)
CountResultDto	getExternalTasksCount(javax.ws.rs.core.UriInfo uriInfo)
List<String>	getTopicNames(boolean withLockedTasks, boolean withUnlockedTasks, boolean withRetriesLeft)
List<ExternalTaskDto>	queryExternalTasks(ExternalTaskQueryDto query, Integer firstResult, Integer maxResults)
CountResultDto	queryExternalTasksCount(ExternalTaskQueryDto query)
void	setRetries(SetRetriesForExternalTasksDto retriesDto)
BatchDto	setRetriesAsync(SetRetriesForExternalTasksDto retriesDto)

Field Detail

PATH

static final String PATH

See Also:

Constant Field Values

Method Detail

getExternalTasks

@GET
 @Produces(value="application/json")
List<ExternalTaskDto> getExternalTasks(@Context
                                                                                 javax.ws.rs.core.UriInfo uriInfo,
                                                                                 @QueryParam(value="firstResult")
                                                                                 Integer firstResult,
                                                                                 @QueryParam(value="maxResults")
                                                                                 Integer maxResults)

queryExternalTasks

@POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
List<ExternalTaskDto> queryExternalTasks(ExternalTaskQueryDto query,
                                                                                                                         @QueryParam(value="firstResult")
                                                                                                                         Integer firstResult,
                                                                                                                         @QueryParam(value="maxResults")
                                                                                                                         Integer maxResults)

getExternalTasksCount

@GET
 @Path(value="/count")
 @Produces(value="application/json")
CountResultDto getExternalTasksCount(@Context
                                                                                                      javax.ws.rs.core.UriInfo uriInfo)

queryExternalTasksCount

@POST
 @Path(value="/count")
 @Consumes(value="application/json")
 @Produces(value="application/json")
CountResultDto queryExternalTasksCount(ExternalTaskQueryDto query)

fetchAndLock

@POST
 @Path(value="/fetchAndLock")
 @Consumes(value="application/json")
 @Produces(value="application/json")
List<LockedExternalTaskDto> fetchAndLock(FetchExternalTasksDto fetchingDto)

getExternalTask

@Path(value="/{id}")
ExternalTaskResource getExternalTask(@PathParam(value="id")
                                                          String externalTaskId)

setRetries

@PUT
 @Path(value="/retries")
 @Consumes(value="application/json")
void setRetries(SetRetriesForExternalTasksDto retriesDto)

setRetriesAsync

@POST
 @Path(value="/retries-async")
 @Consumes(value="application/json")
 @Produces(value="application/json")
BatchDto setRetriesAsync(SetRetriesForExternalTasksDto retriesDto)

getTopicNames

@GET
 @Path(value="/topic-names")
 @Produces(value="application/json")
List<String> getTopicNames(@QueryParam(value="withLockedTasks")
                                                                                                  boolean withLockedTasks,
                                                                                                  @QueryParam(value="withUnlockedTasks")
                                                                                                  boolean withUnlockedTasks,
                                                                                                  @QueryParam(value="withRetriesLeft")
                                                                                                  boolean withRetriesLeft)