Package org.kie.server.remote.rest.jbpm

Class ProcessResource

  • @Path("server/containers/{containerId}/processes")
public class ProcessResource
extends Object

    • Field Detail

      • logger

        public static final org.slf4j.Logger logger

    • Constructor Detail

      • ProcessResource

        public ProcessResource()

      • ProcessResource

        public ProcessResource​(org.kie.server.services.jbpm.ProcessServiceBase processServiceBase,
                       org.kie.server.services.jbpm.RuntimeDataServiceBase runtimeDataServiceBase,
                       org.kie.server.services.api.KieServerRegistry context)

    • Method Detail

      • getRelativePath

        protected static String getRelativePath​(javax.servlet.http.HttpServletRequest httpRequest)

      • startProcess

        @POST
@Path("{processId}/instances")
@Consumes({"application/json","application/xml"})
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response startProcess​(@Context
                                              javax.ws.rs.core.HttpHeaders headers,
                                              @PathParam("containerId")
                                              String containerId,
                                              @PathParam("processId")
                                              String processId,
                                              @DefaultValue("")
                                              String payload)

      • startSynchronousProcess

        @POST
@Path("{processId}/computedInstances")
@Consumes({"application/json","application/xml"})
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response startSynchronousProcess​(@Context
                                                         javax.ws.rs.core.HttpHeaders headers,
                                                         @PathParam("containerId")
                                                         String containerId,
                                                         @PathParam("processId")
                                                         String processId,
                                                         @DefaultValue("")
                                                         String payload)

      • startProcessFromNodeIds

        @POST
@Path("{processId}/instances/fromNodes")
@Consumes({"application/json","application/xml"})
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response startProcessFromNodeIds​(@Context
                                                         javax.ws.rs.core.HttpHeaders headers,
                                                         @PathParam("containerId")
                                                         String containerId,
                                                         @PathParam("processId")
                                                         String processId,
                                                         @DefaultValue("")
                                                         String payload)

      • startProcessWithCorrelationKeyFromNodeIds

        @POST
@Path("{processId}/instances/correlation/{correlationKey}/fromNodes")
@Consumes({"application/json","application/xml"})
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response startProcessWithCorrelationKeyFromNodeIds​(@Context
                                                                           javax.ws.rs.core.HttpHeaders headers,
                                                                           @PathParam("containerId")
                                                                           String containerId,
                                                                           @PathParam("processId")
                                                                           String processId,
                                                                           @PathParam("correlationKey")
                                                                           String correlationKey,
                                                                           @DefaultValue("")
                                                                           String payload)

      • startProcessWithCorrelation

        @POST
@Path("{processId}/instances/correlation/{correlationKey}")
@Consumes({"application/json","application/xml"})
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response startProcessWithCorrelation​(@Context
                                                             javax.ws.rs.core.HttpHeaders headers,
                                                             @PathParam("containerId")
                                                             String containerId,
                                                             @PathParam("processId")
                                                             String processId,
                                                             @PathParam("correlationKey")
                                                             String correlationKey,
                                                             @DefaultValue("")
                                                             String payload)

      • abortProcessInstance

        @DELETE
@Path("instances/{processInstanceId}")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response abortProcessInstance​(@Context
                                                      javax.ws.rs.core.HttpHeaders headers,
                                                      @PathParam("containerId")
                                                      String containerId,
                                                      @PathParam("processInstanceId")
                                                      Long processInstanceId)

      • abortProcessInstances

        @DELETE
@Path("instances")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response abortProcessInstances​(@Context
                                                       javax.ws.rs.core.HttpHeaders headers,
                                                       @PathParam("containerId")
                                                       String containerId,
                                                       @QueryParam("instanceId")
                                                       List<Long> processInstanceIds)

      • signalProcessInstance

        @POST
@Path("instances/{processInstanceId}/signal/{signalName}")
@Consumes({"application/json","application/xml"})
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response signalProcessInstance​(@Context
                                                       javax.ws.rs.core.HttpHeaders headers,
                                                       @PathParam("containerId")
                                                       String containerId,
                                                       @PathParam("processInstanceId")
                                                       Long processInstanceId,
                                                       @PathParam("signalName")
                                                       String signalName,
                                                       String eventPayload)

      • signalProcessInstanceByCorrelationKey

        @POST
@Path("instances/correlation/{correlationKey}/signal/{signalName}")
@Consumes({"application/json","application/xml"})
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response signalProcessInstanceByCorrelationKey​(@Context
                                                                       javax.ws.rs.core.HttpHeaders headers,
                                                                       @PathParam("containerId")
                                                                       String containerId,
                                                                       @PathParam("correlationKey")
                                                                       String correlationKey,
                                                                       @PathParam("signalName")
                                                                       String signalName,
                                                                       String eventPayload)

      • signalProcessInstances

        @POST
@Path("instances/signal/{signalName}")
@Consumes({"application/json","application/xml"})
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response signalProcessInstances​(@Context
                                                        javax.ws.rs.core.HttpHeaders headers,
                                                        @PathParam("containerId")
                                                        String containerId,
                                                        @QueryParam("instanceId")
                                                        List<Long> processInstanceIds,
                                                        @QueryParam("correlationKey")
                                                        List<String> correlationKeys,
                                                        @PathParam("signalName")
                                                        String signalName,
                                                        String eventPayload)

      • getProcessInstance

        @GET
@Path("instances/{processInstanceId}")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response getProcessInstance​(@Context
                                                    javax.ws.rs.core.HttpHeaders headers,
                                                    @PathParam("containerId")
                                                    String containerId,
                                                    @PathParam("processInstanceId")
                                                    Long processInstanceId,
                                                    @QueryParam("withVars")
                                                    boolean withVars)

      • setProcessVariable

        @PUT
@Path("instances/{processInstanceId}/variable/{varName}")
@Consumes({"application/json","application/xml"})
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response setProcessVariable​(@Context
                                                    javax.ws.rs.core.HttpHeaders headers,
                                                    @PathParam("containerId")
                                                    String containerId,
                                                    @PathParam("processInstanceId")
                                                    Long processInstanceId,
                                                    @PathParam("varName")
                                                    String varName,
                                                    String variablePayload)

      • setProcessVariables

        @POST
@Path("instances/{processInstanceId}/variables")
@Consumes({"application/json","application/xml"})
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response setProcessVariables​(@Context
                                                     javax.ws.rs.core.HttpHeaders headers,
                                                     @PathParam("containerId")
                                                     String containerId,
                                                     @PathParam("processInstanceId")
                                                     Long processInstanceId,
                                                     String variablePayload)

      • getProcessInstanceVariable

        @GET
@Path("instances/{processInstanceId}/variable/{varName}")
@Produces({"application/json","application/xml"})
public Object getProcessInstanceVariable​(@Context
                                         javax.ws.rs.core.HttpHeaders headers,
                                         @PathParam("containerId")
                                         String containerId,
                                         @PathParam("processInstanceId")
                                         Long processInstanceId,
                                         @PathParam("varName")
                                         String varName)

      • getProcessInstanceVariables

        @GET
@Path("instances/{processInstanceId}/variables")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response getProcessInstanceVariables​(@Context
                                                             javax.ws.rs.core.HttpHeaders headers,
                                                             @PathParam("containerId")
                                                             String containerId,
                                                             @PathParam("processInstanceId")
                                                             Long processInstanceId)

      • getAvailableSignals

        @GET
@Path("instances/{processInstanceId}/signals")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response getAvailableSignals​(@Context
                                                     javax.ws.rs.core.HttpHeaders headers,
                                                     @PathParam("containerId")
                                                     String containerId,
                                                     @PathParam("processInstanceId")
                                                     Long processInstanceId)

      • completeWorkItem

        @PUT
@Path("instances/{processInstanceId}/workitems/{workItemId}/completed")
@Consumes({"application/json","application/xml"})
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response completeWorkItem​(@Context
                                                  javax.ws.rs.core.HttpHeaders headers,
                                                  @PathParam("containerId")
                                                  String containerId,
                                                  @PathParam("processInstanceId")
                                                  Long processInstanceId,
                                                  @PathParam("workItemId")
                                                  Long workItemId,
                                                  String resultPayload)

      • abortWorkItem

        @PUT
@Path("instances/{processInstanceId}/workitems/{workItemId}/aborted")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response abortWorkItem​(@Context
                                               javax.ws.rs.core.HttpHeaders headers,
                                               @PathParam("containerId")
                                               String containerId,
                                               @PathParam("processInstanceId")
                                               Long processInstanceId,
                                               @PathParam("workItemId")
                                               Long workItemId)

      • getWorkItem

        @GET
@Path("instances/{processInstanceId}/workitems/{workItemId}")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response getWorkItem​(@Context
                                             javax.ws.rs.core.HttpHeaders headers,
                                             @PathParam("containerId")
                                             String containerId,
                                             @PathParam("processInstanceId")
                                             Long processInstanceId,
                                             @PathParam("workItemId")
                                             Long workItemId)

      • getWorkItemByProcessInstance

        @GET
@Path("instances/{processInstanceId}/workitems")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response getWorkItemByProcessInstance​(@Context
                                                              javax.ws.rs.core.HttpHeaders headers,
                                                              @PathParam("containerId")
                                                              String containerId,
                                                              @PathParam("processInstanceId")
                                                              Long processInstanceId)

      • getProcessInstancesByDeploymentId

        @GET
@Path("instances")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response getProcessInstancesByDeploymentId​(@Context
                                                                   javax.ws.rs.core.HttpHeaders headers,
                                                                   @PathParam("containerId")
                                                                   String containerId,
                                                                   @QueryParam("status")
                                                                   List<Integer> status,
                                                                   @QueryParam("page") @DefaultValue("0")
                                                                   Integer page,
                                                                   @QueryParam("pageSize") @DefaultValue("10")
                                                                   Integer pageSize,
                                                                   @QueryParam("sort")
                                                                   String sort,
                                                                   @QueryParam("sortOrder") @DefaultValue("true")
                                                                   boolean sortOrder)

      • getProcessesByDeploymentId

        @GET
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response getProcessesByDeploymentId​(@Context
                                                            javax.ws.rs.core.HttpHeaders headers,
                                                            @PathParam("containerId")
                                                            String containerId,
                                                            @QueryParam("page") @DefaultValue("0")
                                                            Integer page,
                                                            @QueryParam("pageSize") @DefaultValue("10")
                                                            Integer pageSize,
                                                            @QueryParam("sort")
                                                            String sort,
                                                            @QueryParam("sortOrder") @DefaultValue("true")
                                                            boolean sortOrder)

      • getProcessInstanceHistory

        @GET
@Path("instances/{processInstanceId}/nodes/instances")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response getProcessInstanceHistory​(@Context
                                                           javax.ws.rs.core.HttpHeaders headers,
                                                           @PathParam("containerId")
                                                           String containerId,
                                                           @PathParam("processInstanceId")
                                                           long processInstanceId,
                                                           @QueryParam("activeOnly")
                                                           Boolean active,
                                                           @QueryParam("completedOnly")
                                                           Boolean completed,
                                                           @QueryParam("processInstanceHistoryType")
                                                           String processInstHistoryType,
                                                           @QueryParam("page") @DefaultValue("0")
                                                           Integer page,
                                                           @QueryParam("pageSize") @DefaultValue("10")
                                                           Integer pageSize)

      • getVariablesCurrentState

        @GET
@Path("instances/{processInstanceId}/variables/instances")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response getVariablesCurrentState​(@Context
                                                          javax.ws.rs.core.HttpHeaders headers,
                                                          @PathParam("containerId")
                                                          String containerId,
                                                          @PathParam("processInstanceId")
                                                          long processInstanceId)

      • getVariableHistory

        @GET
@Path("instances/{processInstanceId}/variables/instances/{varName}")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response getVariableHistory​(@Context
                                                    javax.ws.rs.core.HttpHeaders headers,
                                                    @PathParam("containerId")
                                                    String containerId,
                                                    @PathParam("processInstanceId")
                                                    long processInstanceId,
                                                    @PathParam("varName")
                                                    String variableName,
                                                    @QueryParam("page") @DefaultValue("0")
                                                    Integer page,
                                                    @QueryParam("pageSize") @DefaultValue("10")
                                                    Integer pageSize)

      • getProcessInstances

        @GET
@Path("instances/{processInstanceId}/processes")
@Produces({"application/json","application/xml"})
public javax.ws.rs.core.Response getProcessInstances​(@Context
                                                     javax.ws.rs.core.HttpHeaders headers,
                                                     @PathParam("containerId")
                                                     String containerId,
                                                     @PathParam("processInstanceId")
                                                     long parentProcessInstanceId,
                                                     @QueryParam("status")
                                                     List<Integer> status,
                                                     @QueryParam("page") @DefaultValue("0")
                                                     Integer page,
                                                     @QueryParam("pageSize") @DefaultValue("10")
                                                     Integer pageSize,
                                                     @QueryParam("sort")
                                                     String sort,
                                                     @QueryParam("sortOrder") @DefaultValue("true")
                                                     boolean sortOrder)