org.camunda.bpm.engine.rest

Interface JobDefinitionRestService

All Known Implementing Classes:

JobDefinitionRestServiceImpl

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

Author:

roman.smirnov

Field Summary

Fields

Modifier and Type	Field and Description
static String	PATH

Method Summary

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

Field Detail

PATH

static final String PATH

See Also:

Constant Field Values

Method Detail

getJobDefinition

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

getJobDefinitions

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

Exposes the JobDefinitionQuery interface as a REST service.

Parameters:

uriInfo -

firstResult -

maxResults -

Returns:

queryJobDefinitions

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

getJobDefinitionsCount

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

queryJobDefinitionsCount

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

updateSuspensionState

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