Package 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	Description
static java.lang.String	PATH

Method Summary

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

Field Detail

PATH

static final java.lang.String PATH

See Also:

Constant Field Values

Method Detail

getExternalTasks

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

queryExternalTasks

@POST
@Consumes("application/json")
@Produces("application/json")
java.util.List<ExternalTaskDto> queryExternalTasks(ExternalTaskQueryDto query,
                                                   @QueryParam("firstResult")
                                                   java.lang.Integer firstResult,
                                                   @QueryParam("maxResults")
                                                   java.lang.Integer maxResults)

getExternalTasksCount

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

queryExternalTasksCount

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

fetchAndLock

@POST
@Path("/fetchAndLock")
@Consumes("application/json")
@Produces("application/json")
void fetchAndLock(FetchExternalTasksExtendedDto dto,
                  @Suspended
                  javax.ws.rs.container.AsyncResponse asyncResponse)

getExternalTask

@Path("/{id}")
ExternalTaskResource getExternalTask(@PathParam("id")
                                     java.lang.String externalTaskId)

setRetries

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

setRetriesAsync

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

getTopicNames

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