org.camunda.bpm.engine.rest

Interface JobRestService

All Known Implementing Classes:

JobRestServiceImpl

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	PATH

Method Summary

Modifier and Type	Method and Description
JobResource	getJob(String jobId)
List<JobDto>	getJobs(javax.ws.rs.core.UriInfo uriInfo, Integer firstResult, Integer maxResults)
CountResultDto	getJobsCount(javax.ws.rs.core.UriInfo uriInfo)
List<JobDto>	queryJobs(JobQueryDto queryDto, Integer firstResult, Integer maxResults)
CountResultDto	queryJobsCount(JobQueryDto queryDto)
BatchDto	setRetries(SetJobRetriesDto setJobRetriesDto)
void	updateSuspensionState(JobSuspensionStateDto dto)

Field Detail

PATH

static final String PATH

See Also:

Constant Field Values

Method Detail

getJob

@Path(value="/{id}")
JobResource getJob(@PathParam(value="id")
                                        String jobId)

getJobs

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

queryJobs

@POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
List<JobDto> queryJobs(JobQueryDto queryDto,
                                                                                                       @QueryParam(value="firstResult")
                                                                                                       Integer firstResult,
                                                                                                       @QueryParam(value="maxResults")
                                                                                                       Integer maxResults)

getJobsCount

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

queryJobsCount

@POST
 @Path(value="/count")
 @Consumes(value="application/json")
 @Produces(value="application/json")
CountResultDto queryJobsCount(JobQueryDto queryDto)

setRetries

@POST
 @Path(value="/retries")
 @Consumes(value="application/json")
 @Produces(value="application/json")
BatchDto setRetries(SetJobRetriesDto setJobRetriesDto)

updateSuspensionState

@PUT
 @Path(value="/suspended")
 @Consumes(value="application/json")
void updateSuspensionState(JobSuspensionStateDto dto)