com.gentics.contentnode.rest.resource

Interface ActivitiResource

All Superinterfaces:

AuthenticatedResource

@Path(value="activiti")
public interface ActivitiResource
extends AuthenticatedResource

Resource for integration of Activiti with the CMS. Usage of this resource requires the feature activiti_integration to be activated.

Method Summary

Modifier and Type	Method and Description
GenericResponse	assign(String id, PageTask pageTask) Assign a page to the given task
GenericResponse	delete(String id) Delete all assignments for a given task
PageTaskListResponse	get(String id) Get the pages assigned to the given task
ProcessQueueResponse	processQueue(List<String> objTypes, List<String> states, String sortBy, String sortOrder) Get the entries in the process queue.
GenericResponse	status() Get the activiti integration status

Methods inherited from interface com.gentics.contentnode.rest.resource.AuthenticatedResource

setSessionId

Method Detail

get

@GET
 @Path(value="/task/{id}")
PageTaskListResponse get(@PathParam(value="id")
                                                         String id)
                                                  throws Exception

Get the pages assigned to the given task

Parameters:

id - Task ID

Returns:

Response containing the assigned pages

Throws:

Exception

assign

@POST
 @Path(value="/task/{id}")
GenericResponse assign(@PathParam(value="id")
                                                        String id,
                                                        PageTask pageTask)
                                                 throws Exception

Assign a page to the given task

Parameters:

id - Task ID

pageTask - Assigned page and event info

Returns:

Generic response

Throws:

Exception

delete

@DELETE
 @Path(value="/task/{id}")
GenericResponse delete(@PathParam(value="id")
                                                          String id)
                                                   throws Exception

Delete all assignments for a given task

Parameters:

id - Task ID

Returns:

Generic response

Throws:

Exception

processQueue

@GET
 @Path(value="/processqueue")
ProcessQueueResponse processQueue(@QueryParam(value="objtypes")
                                                                     List<String> objTypes,
                                                                     @QueryParam(value="states")
                                                                     List<String> states,
                                                                     @QueryParam(value="sortby") @DefaultValue(value="")
                                                                     String sortBy,
                                                                     @QueryParam(value="sortorder") @DefaultValue(value="asc")
                                                                     String sortOrder)
                                                              throws Exception

Get the entries in the process queue.

Parameters:

objTypes - For which object types to load the process queues, or an empty list to retrieve entries for all types (default).

states - Only entries with one of these states will be returned or an empty list to retrieve entries of all states (default).

sortBy - The field to sort the results by, or an empty string to disable sorting.

sortOrder - Whether to sort ascending or descending (anything other than desc will be interpreted as asc

Returns:

The list of entries in the process queues.

Throws:

Exception

status

@GET
 @Path(value="/status")
GenericResponse status()
                                             throws Exception

Get the activiti integration status

Returns:

status

Throws:

Exception