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

Method Summary

Modifier and Type	Method	Description
JobResource	getJob(String jobId)
List<JobDto>	getJobs(jakarta.ws.rs.core.UriInfo uriInfo, Integer firstResult, Integer maxResults)
CountResultDto	getJobsCount(jakarta.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 Details

PATH

static final String PATH

See Also:

• Constant Field Values

Method Details

getJob

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

getJobs

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

queryJobs

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

getJobsCount

@GET
@Path("/count")
@Produces("application/json")
CountResultDto getJobsCount(@Context
 jakarta.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)