Package org.camunda.bpm.engine.rest

Interface JobRestService

All Known Implementing Classes:

JobRestServiceImpl

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

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PATH

Method Summary

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

Field Detail

PATH

static final java.lang.String PATH

See Also:

Constant Field Values

Method Detail

getJob

@Path("/{id}")
JobResource getJob(@PathParam("id")
                   java.lang.String jobId)

getJobs

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

queryJobs

@POST
@Consumes("application/json")
@Produces("application/json")
java.util.List<JobDto> queryJobs(JobQueryDto queryDto,
                                 @QueryParam("firstResult")
                                 java.lang.Integer firstResult,
                                 @QueryParam("maxResults")
                                 java.lang.Integer maxResults)

getJobsCount

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

queryJobsCount

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

setRetries

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

updateSuspensionState

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