Package org.camunda.bpm.engine.rest

Interface TaskRestService

All Known Implementing Classes:

TaskRestServiceImpl

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PATH

Method Summary

Modifier and Type	Method	Description
void	createTask(TaskDto taskDto)
TaskResource	getTask(String id, boolean withCommentAttachmentInfo)
TaskReportResource	getTaskReportResource()
Object	getTasks(jakarta.ws.rs.core.Request request, jakarta.ws.rs.core.UriInfo uriInfo, Integer firstResult, Integer maxResults)
CountResultDto	getTasksCount(jakarta.ws.rs.core.UriInfo uriInfo)
List<TaskDto>	queryTasks(TaskQueryDto query, Integer firstResult, Integer maxResults)	Expects the same parameters as TaskRestService#getTasks(UriInfo, Integer, Integer) (as JSON message body) and allows more than one variable check.
CountResultDto	queryTasksCount(TaskQueryDto query)

Field Details

PATH

static final String PATH

See Also:

• Constant Field Values

Method Details

getTask

@Path("/{id}")
TaskResource getTask(@PathParam("id")
 String id,
 @QueryParam("withCommentAttachmentInfo")
 boolean withCommentAttachmentInfo)

getTasks

@GET
@Produces({"application/json","application/hal+json"})
Object getTasks(@Context
 jakarta.ws.rs.core.Request request,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 @QueryParam("firstResult")
 Integer firstResult,
 @QueryParam("maxResults")
 Integer maxResults)

queryTasks

@POST
@Consumes("application/json")
@Produces("application/json")
List<TaskDto> queryTasks(TaskQueryDto query,
 @QueryParam("firstResult")
 Integer firstResult,
 @QueryParam("maxResults")
 Integer maxResults)

Expects the same parameters as TaskRestService#getTasks(UriInfo, Integer, Integer) (as JSON message body) and allows more than one variable check.

Parameters:

query -

firstResult -

maxResults -

Returns:

getTasksCount

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

queryTasksCount

@POST
@Path("/count")
@Consumes("application/json")
@Produces("application/json")
CountResultDto queryTasksCount(TaskQueryDto query)

createTask

@POST
@Path("/create")
@Consumes("application/json")
void createTask(TaskDto taskDto)

getTaskReportResource

@Path("/report")
TaskReportResource getTaskReportResource()