Package org.activiti.cloud.services.rest.api

Interface ProcessInstanceController

  • @RequestMapping(value="/v1/process-instances",
                produces={"application/hal+json","application/json"})
public interface ProcessInstanceController

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      org.springframework.hateoas.Resource<org.activiti.cloud.api.process.model.CloudProcessInstance> createProcessInstance​(org.activiti.api.process.model.payloads.CreateProcessInstancePayload cmd)  
      org.springframework.hateoas.Resource<org.activiti.cloud.api.process.model.CloudProcessInstance> deleteProcessInstance​(java.lang.String processInstanceId)  
      java.lang.String getProcessDiagram​(java.lang.String processInstanceId)  
      org.springframework.hateoas.Resource<org.activiti.cloud.api.process.model.CloudProcessInstance> getProcessInstanceById​(java.lang.String processInstanceId)  
      org.springframework.hateoas.PagedResources<org.springframework.hateoas.Resource<org.activiti.cloud.api.process.model.CloudProcessInstance>> getProcessInstances​(org.springframework.data.domain.Pageable pageable)  
      org.springframework.http.ResponseEntity<java.lang.Void> receive​(org.activiti.api.process.model.payloads.ReceiveMessagePayload receiveMessagePayload)  
      org.springframework.hateoas.Resource<org.activiti.cloud.api.process.model.CloudProcessInstance> resume​(java.lang.String processInstanceId)  
      org.springframework.http.ResponseEntity<java.lang.Void> sendSignal​(org.activiti.api.process.model.payloads.SignalPayload signalPayload)  
      org.springframework.hateoas.Resource<org.activiti.cloud.api.process.model.CloudProcessInstance> sendStartMessage​(org.activiti.api.process.model.payloads.StartMessagePayload startMessagePayload)  
      org.springframework.hateoas.Resource<org.activiti.cloud.api.process.model.CloudProcessInstance> startCreatedProcess​(java.lang.String processInstanceId, org.activiti.api.process.model.payloads.StartProcessPayload payload)  
      org.springframework.hateoas.Resource<org.activiti.cloud.api.process.model.CloudProcessInstance> startProcess​(org.activiti.api.process.model.payloads.StartProcessPayload cmd)  
      org.springframework.hateoas.PagedResources<org.springframework.hateoas.Resource<org.activiti.cloud.api.process.model.CloudProcessInstance>> subprocesses​(java.lang.String processInstanceId, org.springframework.data.domain.Pageable pageable)  
      org.springframework.hateoas.Resource<org.activiti.cloud.api.process.model.CloudProcessInstance> suspend​(java.lang.String processInstanceId)  
      org.springframework.hateoas.Resource<org.activiti.cloud.api.process.model.CloudProcessInstance> updateProcess​(java.lang.String processInstanceId, org.activiti.api.process.model.payloads.UpdateProcessPayload payload)  

    • Method Detail

      • getProcessInstances

        @RequestMapping(method=GET)
org.springframework.hateoas.PagedResources<org.springframework.hateoas.Resource<org.activiti.cloud.api.process.model.CloudProcessInstance>> getProcessInstances​(org.springframework.data.domain.Pageable pageable)

      • startProcess

        @RequestMapping(method=POST)
org.springframework.hateoas.Resource<org.activiti.cloud.api.process.model.CloudProcessInstance> startProcess​(@RequestBody
                                                                                                             org.activiti.api.process.model.payloads.StartProcessPayload cmd)

      • startCreatedProcess

        @RequestMapping(value="/{processInstanceId}/start",
                method=POST)
org.springframework.hateoas.Resource<org.activiti.cloud.api.process.model.CloudProcessInstance> startCreatedProcess​(@PathVariable
                                                                                                                    java.lang.String processInstanceId,
                                                                                                                    @RequestBody(required=false)
                                                                                                                    org.activiti.api.process.model.payloads.StartProcessPayload payload)

      • createProcessInstance

        @RequestMapping(value="/create",
                method=POST)
org.springframework.hateoas.Resource<org.activiti.cloud.api.process.model.CloudProcessInstance> createProcessInstance​(@RequestBody
                                                                                                                      org.activiti.api.process.model.payloads.CreateProcessInstancePayload cmd)

      • getProcessInstanceById

        @RequestMapping(value="/{processInstanceId}",
                method=GET)
org.springframework.hateoas.Resource<org.activiti.cloud.api.process.model.CloudProcessInstance> getProcessInstanceById​(@PathVariable
                                                                                                                       java.lang.String processInstanceId)

      • getProcessDiagram

        @RequestMapping(value="/{processInstanceId}/model",
                method=GET,
                produces="image/svg+xml")
@ResponseBody
java.lang.String getProcessDiagram​(@PathVariable
                                   java.lang.String processInstanceId)

      • sendSignal

        @RequestMapping(value="/signal",
                method=POST)
org.springframework.http.ResponseEntity<java.lang.Void> sendSignal​(@RequestBody
                                                                   org.activiti.api.process.model.payloads.SignalPayload signalPayload)

      • sendStartMessage

        @RequestMapping(value="/message",
                method=POST)
org.springframework.hateoas.Resource<org.activiti.cloud.api.process.model.CloudProcessInstance> sendStartMessage​(@RequestBody
                                                                                                                 org.activiti.api.process.model.payloads.StartMessagePayload startMessagePayload)

      • receive

        @RequestMapping(value="/message",
                method=PUT)
org.springframework.http.ResponseEntity<java.lang.Void> receive​(@RequestBody
                                                                org.activiti.api.process.model.payloads.ReceiveMessagePayload receiveMessagePayload)

      • suspend

        @RequestMapping(value="{processInstanceId}/suspend",
                method=POST)
org.springframework.hateoas.Resource<org.activiti.cloud.api.process.model.CloudProcessInstance> suspend​(@PathVariable
                                                                                                        java.lang.String processInstanceId)

      • resume

        @RequestMapping(value="{processInstanceId}/resume",
                method=POST)
org.springframework.hateoas.Resource<org.activiti.cloud.api.process.model.CloudProcessInstance> resume​(@PathVariable
                                                                                                       java.lang.String processInstanceId)

      • deleteProcessInstance

        @RequestMapping(value="/{processInstanceId}",
                method=DELETE)
org.springframework.hateoas.Resource<org.activiti.cloud.api.process.model.CloudProcessInstance> deleteProcessInstance​(@PathVariable
                                                                                                                      java.lang.String processInstanceId)

      • updateProcess

        @RequestMapping(value="/{processInstanceId}",
                method=PUT)
org.springframework.hateoas.Resource<org.activiti.cloud.api.process.model.CloudProcessInstance> updateProcess​(@PathVariable("processInstanceId")
                                                                                                              java.lang.String processInstanceId,
                                                                                                              @RequestBody
                                                                                                              org.activiti.api.process.model.payloads.UpdateProcessPayload payload)

      • subprocesses

        @RequestMapping(value="/{processInstanceId}/subprocesses",
                method=GET)
org.springframework.hateoas.PagedResources<org.springframework.hateoas.Resource<org.activiti.cloud.api.process.model.CloudProcessInstance>> subprocesses​(@PathVariable("processInstanceId")
                                                                                                                                                         java.lang.String processInstanceId,
                                                                                                                                                         org.springframework.data.domain.Pageable pageable)