Package org.camunda.bpm.engine.rest

Interface JobDefinitionRestService

All Known Implementing Classes:

JobDefinitionRestServiceImpl

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

Author:

roman.smirnov

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PATH

Method Summary

Modifier and Type	Method	Description
JobDefinitionResource	getJobDefinition(String jobDefinitionId)
List<JobDefinitionDto>	getJobDefinitions(jakarta.ws.rs.core.UriInfo uriInfo, Integer firstResult, Integer maxResults)	Exposes the JobDefinitionQuery interface as a REST service.
CountResultDto	getJobDefinitionsCount(jakarta.ws.rs.core.UriInfo uriInfo)
List<JobDefinitionDto>	queryJobDefinitions(JobDefinitionQueryDto queryDto, Integer firstResult, Integer maxResults)
CountResultDto	queryJobDefinitionsCount(JobDefinitionQueryDto queryDto)
void	updateSuspensionState(JobDefinitionSuspensionStateDto dto)

Field Details

PATH

static final String PATH

See Also:

• Constant Field Values

Method Details

getJobDefinition

@Path("/{id}")
JobDefinitionResource getJobDefinition(@PathParam("id")
 String jobDefinitionId)

getJobDefinitions

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

Exposes the JobDefinitionQuery interface as a REST service.

Parameters:

uriInfo -

firstResult -

maxResults -

Returns:

queryJobDefinitions

@POST
@Consumes("application/json")
@Produces("application/json")
List<JobDefinitionDto> queryJobDefinitions(JobDefinitionQueryDto queryDto,
 @QueryParam("firstResult")
 Integer firstResult,
 @QueryParam("maxResults")
 Integer maxResults)

getJobDefinitionsCount

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

queryJobDefinitionsCount

@POST
@Path("/count")
@Consumes("application/json")
@Produces("application/json")
CountResultDto queryJobDefinitionsCount(JobDefinitionQueryDto queryDto)

updateSuspensionState

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