Package org.camunda.bpm.engine.rest

Interface GroupRestService

All Known Implementing Classes:

GroupRestServiceImpl

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

Author:

Daniel Meyer

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PATH

Method Summary

Modifier and Type	Method	Description
ResourceOptionsDto	availableOperations(jakarta.ws.rs.core.UriInfo context)
void	createGroup(GroupDto GroupDto)
GroupResource	getGroup(String id)
CountResultDto	getGroupCount(jakarta.ws.rs.core.UriInfo uriInfo)
CountResultDto	queryGroupCount(GroupQueryDto query)
List<GroupDto>	queryGroups(jakarta.ws.rs.core.UriInfo uriInfo, Integer firstResult, Integer maxResults)
List<GroupDto>	queryGroups(GroupQueryDto query, Integer firstResult, Integer maxResults)

Field Details

PATH

static final String PATH

See Also:

• Constant Field Values

Method Details

getGroup

@Path("/{id}")
GroupResource getGroup(@PathParam("id")
 String id)

queryGroups

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

getGroupCount

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

queryGroups

@POST
@Consumes("application/json")
@Produces("application/json")
List<GroupDto> queryGroups(GroupQueryDto query,
 @QueryParam("firstResult")
 Integer firstResult,
 @QueryParam("maxResults")
 Integer maxResults)

queryGroupCount

@POST
@Path("/count")
@Consumes("application/json")
@Produces("application/json")
CountResultDto queryGroupCount(GroupQueryDto query)

createGroup

@POST
@Path("/create")
@Consumes("application/json")
void createGroup(GroupDto GroupDto)

availableOperations

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