Package org.camunda.bpm.engine.rest

Interface UserRestService

All Known Implementing Classes:

UserRestServiceImpl

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

Author:

Daniel Meyer

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
ResourceOptionsDto	availableOperations(javax.ws.rs.core.UriInfo context)
void	createUser(UserDto userDto)
UserResource	getUser(java.lang.String id)
CountResultDto	getUserCount(javax.ws.rs.core.UriInfo uriInfo)
java.util.List<UserProfileDto>	queryUsers(javax.ws.rs.core.UriInfo uriInfo, java.lang.Integer firstResult, java.lang.Integer maxResults)

Field Detail

PATH

static final java.lang.String PATH

See Also:

Constant Field Values

Method Detail

getUser

@Path("/{id}")
UserResource getUser(@PathParam("id")
                     java.lang.String id)

queryUsers

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

getUserCount

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

createUser

@POST
@Path("/create")
@Consumes("application/json")
void createUser(UserDto userDto)

availableOperations

@OPTIONS
@Produces("application/json")
ResourceOptionsDto availableOperations(@Context
                                       javax.ws.rs.core.UriInfo context)