io.nflow.rest.v1.springweb

Class WorkflowInstanceResource

java.lang.Object

io.nflow.rest.v1.ResourceBase

io.nflow.rest.v1.springweb.WorkflowInstanceResource

@RestController
 @RequestMapping(value="/${nflow.rest.path.prefix}/v1/workflow-instance",
                produces="application/json")
 @Component
public class WorkflowInstanceResource
extends ResourceBase

Field Summary

Fields inherited from class io.nflow.rest.v1.ResourceBase

actions, actionStateVariables, childWorkflows, currentStateVariables, INCLUDE_PARAM_DESC, INCLUDE_PARAM_VALUES

Constructor Summary

Constructors

Constructor and Description
WorkflowInstanceResource(io.nflow.engine.service.WorkflowInstanceService workflowInstances, CreateWorkflowConverter createWorkflowConverter, ListWorkflowInstanceConverter listWorkflowConverter, io.nflow.engine.workflow.instance.WorkflowInstanceFactory workflowInstanceFactory)

Method Summary

Modifier and Type	Method and Description
ResponseEntity<CreateWorkflowInstanceResponse>	createWorkflowInstance(CreateWorkflowInstanceRequest req)
ResponseEntity<ListWorkflowInstanceResponse>	fetchWorkflowInstance(int id, String include, Long maxActions)
Collection<ListWorkflowInstanceResponse>	listWorkflowInstances(List<Integer> ids, List<String> types, Integer parentWorkflowId, Integer parentActionId, List<String> states, List<io.nflow.engine.workflow.instance.WorkflowInstance.WorkflowInstanceStatus> statuses, String businessKey, String externalId, String include, Long maxResults, Long maxActions)
ResponseEntity<?>	setSignal(int id, @Valid SetSignalRequest req)
ResponseEntity<?>	updateWorkflowInstance(int id, UpdateWorkflowInstanceRequest req)

Methods inherited from class io.nflow.rest.v1.ResourceBase

fetchWorkflowInstance, listWorkflowDefinitions, listWorkflowInstances, updateWorkflowInstance

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkflowInstanceResource

@Inject
public WorkflowInstanceResource(io.nflow.engine.service.WorkflowInstanceService workflowInstances,
                                        CreateWorkflowConverter createWorkflowConverter,
                                        ListWorkflowInstanceConverter listWorkflowConverter,
                                        io.nflow.engine.workflow.instance.WorkflowInstanceFactory workflowInstanceFactory)

Method Detail

createWorkflowInstance

@PutMapping(consumes="application/json")
public ResponseEntity<CreateWorkflowInstanceResponse> createWorkflowInstance(@RequestBody
                                                                                                                      CreateWorkflowInstanceRequest req)

updateWorkflowInstance

@PutMapping(path="/id/{id}",
            consumes="application/json")
public ResponseEntity<?> updateWorkflowInstance(@PathVariable(value="id")
                                                                                                                      int id,
                                                                                                                      @RequestBody
                                                                                                                      UpdateWorkflowInstanceRequest req)

fetchWorkflowInstance

@GetMapping(path="/id/{id}")
public ResponseEntity<ListWorkflowInstanceResponse> fetchWorkflowInstance(@PathVariable(value="id")
                                                                                                       int id,
                                                                                                       @RequestParam(value="include",required=false)
                                                                                                       String include,
                                                                                                       @RequestParam(value="maxActions",required=false)
                                                                                                       Long maxActions)

listWorkflowInstances

@GetMapping
public Collection<ListWorkflowInstanceResponse> listWorkflowInstances(@RequestParam(value="id",defaultValue="")
                                                                                  List<Integer> ids,
                                                                                  @RequestParam(value="type",defaultValue="")
                                                                                  List<String> types,
                                                                                  @RequestParam(value="parentWorkflowId",required=false)
                                                                                  Integer parentWorkflowId,
                                                                                  @RequestParam(value="parentActionId",required=false)
                                                                                  Integer parentActionId,
                                                                                  @RequestParam(value="state",defaultValue="")
                                                                                  List<String> states,
                                                                                  @RequestParam(value="status",defaultValue="")
                                                                                  List<io.nflow.engine.workflow.instance.WorkflowInstance.WorkflowInstanceStatus> statuses,
                                                                                  @RequestParam(value="businessKey",required=false)
                                                                                  String businessKey,
                                                                                  @RequestParam(value="externalId",required=false)
                                                                                  String externalId,
                                                                                  @RequestParam(value="include",required=false)
                                                                                  String include,
                                                                                  @RequestParam(value="maxResults",required=false)
                                                                                  Long maxResults,
                                                                                  @RequestParam(value="maxActions",required=false)
                                                                                  Long maxActions)

setSignal

@PutMapping(path="/{id}/signal",
            consumes="application/json")
public ResponseEntity<?> setSignal(@PathVariable(value="id")
                                                                                                             int id,
                                                                                                             @RequestBody @Valid
                                                                                                             @Valid SetSignalRequest req)