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

Interface ProcessInstanceVariableAdminController

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

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      org.springframework.hateoas.CollectionModel<org.springframework.hateoas.EntityModel<CloudVariableInstance>> getVariables​(String processInstanceId)  
      org.springframework.http.ResponseEntity<Void> removeVariables​(String processInstanceId, org.activiti.api.process.model.payloads.RemoveProcessVariablesPayload removeProcessVariablesPayload)  
      org.springframework.http.ResponseEntity<Void> updateVariables​(String processInstanceId, org.activiti.api.process.model.payloads.SetProcessVariablesPayload setProcessVariablesPayload)  

    • Method Detail

      • getVariables

        @RequestMapping(method=GET)
org.springframework.hateoas.CollectionModel<org.springframework.hateoas.EntityModel<CloudVariableInstance>> getVariables​(@PathVariable
                                                                                                                         String processInstanceId)

      • updateVariables

        @PutMapping
org.springframework.http.ResponseEntity<Void> updateVariables​(@PathVariable
                                                              String processInstanceId,
                                                              @RequestBody
                                                              org.activiti.api.process.model.payloads.SetProcessVariablesPayload setProcessVariablesPayload)
        Parameters:
        processInstanceId - id of process instance
        setProcessVariablesPayload - process variables payload
        Returns:
        list of error messages, empty list if no error message

      • removeVariables

        @DeleteMapping
org.springframework.http.ResponseEntity<Void> removeVariables​(@PathVariable
                                                              String processInstanceId,
                                                              @RequestBody
                                                              org.activiti.api.process.model.payloads.RemoveProcessVariablesPayload removeProcessVariablesPayload)
        Parameters:
        processInstanceId - id of process instance
        removeProcessVariablesPayload - process variables payload