org.camunda.bpm.engine.rest

Interface TaskRestService

All Known Implementing Classes:

TaskRestServiceImpl

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	PATH

Method Summary

Modifier and Type	Method and Description
void	createTask(TaskDto taskDto)
TaskResource	getTask(String id)
TaskReportResource	getTaskReportResource()
Object	getTasks(javax.ws.rs.core.Request request, javax.ws.rs.core.UriInfo uriInfo, Integer firstResult, Integer maxResults)
CountResultDto	getTasksCount(javax.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 Detail

PATH

static final String PATH

See Also:

Constant Field Values

Method Detail

getTask

@Path(value="/{id}")
TaskResource getTask(@PathParam(value="id")
                                          String id)

getTasks

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

queryTasks

@POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
List<TaskDto> queryTasks(TaskQueryDto query,
                                                                                                         @QueryParam(value="firstResult")
                                                                                                         Integer firstResult,
                                                                                                         @QueryParam(value="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(value="/count")
 @Produces(value="application/json")
CountResultDto getTasksCount(@Context
                                                                                              javax.ws.rs.core.UriInfo uriInfo)

queryTasksCount

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

createTask

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

getTaskReportResource

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