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 final String	PATH

Method Summary

Modifier and Type	Method	Description
void	fetchAndLock(FetchExternalTasksExtendedDto dto, jakarta.ws.rs.container.AsyncResponse asyncResponse)
ExternalTaskResource	getExternalTask(String externalTaskId)
List<ExternalTaskDto>	getExternalTasks(jakarta.ws.rs.core.UriInfo uriInfo, Integer firstResult, Integer maxResults)
CountResultDto	getExternalTasksCount(jakarta.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 Details

PATH

static final String PATH

See Also:

• Constant Field Values

Method Details

getExternalTasks

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

queryExternalTasks

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

getExternalTasksCount

@GET
@Path("/count")
@Produces("application/json")
CountResultDto getExternalTasksCount(@Context
 jakarta.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
 jakarta.ws.rs.container.AsyncResponse asyncResponse)

getExternalTask

@Path("/{id}")
ExternalTaskResource getExternalTask(@PathParam("id")
 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")
List<String> getTopicNames(@QueryParam("withLockedTasks")
 boolean withLockedTasks,
 @QueryParam("withUnlockedTasks")
 boolean withUnlockedTasks,
 @QueryParam("withRetriesLeft")
 boolean withRetriesLeft)