Interface ProcessRestOpenApi
-
- All Known Implementing Classes:
ProcessRestController
@RequestMapping("/v2.1.1/process-manager/") public interface ProcessRestOpenApi
Swagger documentation for process manager.- Author:
- Mauricio Ruiz Beltrán <mauricio.ruiz@kuwaiba.org>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
commitActivity(@NotNull @Valid String processInstanceId, @NotNull @Valid String activityDefinitionId, @Valid TransientArtifact artifact, @NotNull @Valid String sessionId)
String
createProcessDefinition(@NotNull @Valid String name, @NotNull @Valid String description, @NotNull @Valid String version, @javax.validation.constraints.NotNull,@javax.validation.Valid boolean enabled, @NotNull @Valid String structure, @NotNull @Valid String sessionId)
String
createProcessInstance(@NotNull @Valid String processDefinitionId, @NotNull @Valid String name, @NotNull @Valid String description, @NotNull @Valid String sessionId)
void
deleteProcessDefinition(@NotNull @Valid String processDefinitionId, @NotNull @Valid String sessionId)
void
deleteProcessInstance(@NotNull @Valid String processInstanceId, @NotNull @Valid String sessionId)
ActivityDefinition
getActivityDefinition(@NotNull @Valid String processDefinitionId, @NotNull @Valid String activityDefinitionId, @NotNull @Valid String sessionId)
ArtifactDefinition
getArtifactDefinitionForActivity(@NotNull @Valid String processDefinitionId, @NotNull @Valid String activityDefinitionId, @NotNull @Valid String sessionId)
Artifact
getArtifactForActivity(@NotNull @Valid String processInstanceId, @NotNull @Valid String activityId, @NotNull @Valid String sessionId)
ActivityDefinition
getNextActivityForProcessInstance(@NotNull @Valid String processInstanceId, @NotNull @Valid String sessionId)
ProcessDefinition
getProcessDefinition(@NotNull @Valid String processDefinitionId, @NotNull @Valid String sessionId)
List<ProcessDefinition>
getProcessDefinitions(@NotNull @Valid String sessionId)
ProcessInstance
getProcessInstance(@NotNull @Valid String processInstanceId, @NotNull @Valid String sessionId)
List<ActivityDefinition>
getProcessInstanceActivitiesPath(@NotNull @Valid String processInstanceId, @NotNull @Valid String sessionId)
List<ProcessInstance>
getProcessInstances(@NotNull @Valid String processDefinitionId, @NotNull @Valid String sessionId)
void
reloadProcessDefinitions(@NotNull @Valid String sessionId)
void
updateActivity(@NotNull @Valid String processInstanceId, @NotNull @Valid String activityDefinitionId, @Valid TransientArtifact artifact, @NotNull @Valid String sessionId)
void
updateProcessDefinition(@NotNull @Valid String processDefinitionId, @Valid List<StringPair> properties, @NotNull @Valid String structure, @NotNull @Valid String sessionId)
void
updateProcessInstance(@NotNull @Valid String processInstanceId, @NotNull @Valid String name, @NotNull @Valid String description, @NotNull @Valid String sessionId)
-
-
-
Field Detail
-
PATH
static final String PATH
- See Also:
- Constant Field Values
-
-
Method Detail
-
getArtifactForActivity
@RequestMapping(method=GET, value="getArtifactForActivity/{processInstanceId}/{activityId}/{sessionId}", produces="application/json") Artifact getArtifactForActivity(@NotNull @Valid @PathVariable(value="processInstanceId",required=true) @NotNull @Valid String processInstanceId, @NotNull @Valid @PathVariable(value="activityId",required=true) @NotNull @Valid String activityId, @NotNull @Valid @PathVariable(value="sessionId",required=true) @NotNull @Valid String sessionId)
-
getArtifactDefinitionForActivity
@RequestMapping(method=GET, value="getArtifactDefinitionForActivity/{processDefinitionId}/{activityDefinitionId}/{sessionId}", produces="application/json") ArtifactDefinition getArtifactDefinitionForActivity(@NotNull @Valid @PathVariable(value="processDefinitionId",required=true) @NotNull @Valid String processDefinitionId, @NotNull @Valid @PathVariable(value="activityDefinitionId",required=true) @NotNull @Valid String activityDefinitionId, @NotNull @Valid @PathVariable(value="sessionId",required=true) @NotNull @Valid String sessionId)
-
commitActivity
@RequestMapping(method=PUT, value="commitActivity/{processInstanceId}/{activityDefinitionId}/{sessionId}", produces="application/json") void commitActivity(@NotNull @Valid @PathVariable(value="processInstanceId",required=true) @NotNull @Valid String processInstanceId, @NotNull @Valid @PathVariable(value="activityDefinitionId",required=true) @NotNull @Valid String activityDefinitionId, @Valid @RequestBody @Valid TransientArtifact artifact, @NotNull @Valid @PathVariable(value="sessionId",required=true) @NotNull @Valid String sessionId)
-
updateActivity
@RequestMapping(method=PUT, value="updateActivity/{processInstanceId}/{activityDefinitionId}/{sessionId}", produces="application/json") void updateActivity(@NotNull @Valid @PathVariable(value="processInstanceId",required=true) @NotNull @Valid String processInstanceId, @NotNull @Valid @PathVariable(value="activityDefinitionId",required=true) @NotNull @Valid String activityDefinitionId, @Valid @RequestBody @Valid TransientArtifact artifact, @NotNull @Valid @PathVariable(value="sessionId",required=true) @NotNull @Valid String sessionId)
-
getProcessInstanceActivitiesPath
@RequestMapping(method=GET, value="getProcessInstanceActivitiesPath/{processInstanceId}/{sessionId}", produces="application/json") List<ActivityDefinition> getProcessInstanceActivitiesPath(@NotNull @Valid @PathVariable(value="processInstanceId",required=true) @NotNull @Valid String processInstanceId, @NotNull @Valid @PathVariable(value="sessionId",required=true) @NotNull @Valid String sessionId)
-
getNextActivityForProcessInstance
@RequestMapping(method=GET, value="getNextActivityForProcessInstance/{processInstanceId}/{sessionId}", produces="application/json") ActivityDefinition getNextActivityForProcessInstance(@NotNull @Valid @PathVariable(value="processInstanceId",required=true) @NotNull @Valid String processInstanceId, @NotNull @Valid @PathVariable(value="sessionId",required=true) @NotNull @Valid String sessionId)
-
getProcessDefinition
@RequestMapping(method=GET, value="getProcessDefinition/{processDefinitionId}/{sessionId}", produces="application/json") ProcessDefinition getProcessDefinition(@NotNull @Valid @PathVariable(value="processDefinitionId",required=true) @NotNull @Valid String processDefinitionId, @NotNull @Valid @PathVariable(value="sessionId",required=true) @NotNull @Valid String sessionId)
-
getActivityDefinition
@RequestMapping(method=GET, value="getActivityDefinition/{processDefinitionId}/{activityDefinitionId}/{sessionId}", produces="application/json") ActivityDefinition getActivityDefinition(@NotNull @Valid @PathVariable(value="processDefinitionId",required=true) @NotNull @Valid String processDefinitionId, @NotNull @Valid @PathVariable(value="activityDefinitionId",required=true) @NotNull @Valid String activityDefinitionId, @NotNull @Valid @PathVariable(value="sessionId",required=true) @NotNull @Valid String sessionId)
-
deleteProcessDefinition
@RequestMapping(method=DELETE, value="deleteProcessDefinition/{processDefinitionId}/{sessionId}", produces="application/json") void deleteProcessDefinition(@NotNull @Valid @PathVariable(value="processDefinitionId",required=true) @NotNull @Valid String processDefinitionId, @NotNull @Valid @PathVariable(value="sessionId",required=true) @NotNull @Valid String sessionId)
-
updateProcessDefinition
@RequestMapping(method=PUT, value="updateProcessDefinition/{processDefinitionId}/{structure}/{sessionId}", produces="application/json") void updateProcessDefinition(@NotNull @Valid @PathVariable(value="processDefinitionId",required=true) @NotNull @Valid String processDefinitionId, @Valid @RequestBody @Valid List<StringPair> properties, @NotNull @Valid @PathVariable(value="structure",required=true) @NotNull @Valid String structure, @NotNull @Valid @PathVariable(value="sessionId",required=true) @NotNull @Valid String sessionId)
-
createProcessDefinition
@RequestMapping(method=POST, value="createProcessDefinition/{name}/{description}/{version}/{enabled}/{structure}/{sessionId}", produces="application/json") String createProcessDefinition(@NotNull @Valid @PathVariable(value="name",required=true) @NotNull @Valid String name, @NotNull @Valid @PathVariable(value="description",required=true) @NotNull @Valid String description, @NotNull @Valid @PathVariable(value="version",required=true) @NotNull @Valid String version, @NotNull @Valid @PathVariable(value="enabled",required=true) @javax.validation.constraints.NotNull,@javax.validation.Valid boolean enabled, @NotNull @Valid @PathVariable(value="structure",required=true) @NotNull @Valid String structure, @NotNull @Valid @PathVariable(value="sessionId",required=true) @NotNull @Valid String sessionId)
-
getProcessInstances
@RequestMapping(method=GET, value="getProcessInstances/{processDefinitionId}/{sessionId}", produces="application/json") List<ProcessInstance> getProcessInstances(@NotNull @Valid @PathVariable(value="processDefinitionId",required=true) @NotNull @Valid String processDefinitionId, @NotNull @Valid @PathVariable(value="sessionId",required=true) @NotNull @Valid String sessionId)
-
getProcessDefinitions
@RequestMapping(method=GET, value="getProcessDefinitions/{sessionId}", produces="application/json") List<ProcessDefinition> getProcessDefinitions(@NotNull @Valid @PathVariable(value="sessionId",required=true) @NotNull @Valid String sessionId)
-
getProcessInstance
@RequestMapping(method=GET, value="getProcessInstance/{processInstanceId}/{sessionId}", produces="application/json") ProcessInstance getProcessInstance(@NotNull @Valid @PathVariable(value="processInstanceId",required=true) @NotNull @Valid String processInstanceId, @NotNull @Valid @PathVariable(value="sessionId",required=true) @NotNull @Valid String sessionId)
-
reloadProcessDefinitions
@RequestMapping(method=PUT, value="reloadProcessDefinitions/{sessionId}", produces="application/json") void reloadProcessDefinitions(@NotNull @Valid @PathVariable(value="sessionId",required=true) @NotNull @Valid String sessionId)
-
createProcessInstance
@RequestMapping(method=POST, value="createProcessInstance/{processDefinitionId}/{name}/{description}/{sessionId}", produces="application/json") String createProcessInstance(@NotNull @Valid @PathVariable(value="processDefinitionId",required=true) @NotNull @Valid String processDefinitionId, @NotNull @Valid @PathVariable(value="name",required=true) @NotNull @Valid String name, @NotNull @Valid @PathVariable(value="description",required=true) @NotNull @Valid String description, @NotNull @Valid @PathVariable(value="sessionId",required=true) @NotNull @Valid String sessionId)
-
updateProcessInstance
@RequestMapping(method=PUT, value="updateProcessInstance/{processInstanceId}/{name}/{description}/{sessionId}", produces="application/json") void updateProcessInstance(@NotNull @Valid @PathVariable(value="processInstanceId",required=true) @NotNull @Valid String processInstanceId, @NotNull @Valid @PathVariable(value="name",required=true) @NotNull @Valid String name, @NotNull @Valid @PathVariable(value="description",required=true) @NotNull @Valid String description, @NotNull @Valid @PathVariable(value="sessionId",required=true) @NotNull @Valid String sessionId)
-
deleteProcessInstance
@RequestMapping(method=DELETE, value="deleteProcessInstance/{processInstanceId}/{sessionId}", produces="application/json") void deleteProcessInstance(@NotNull @Valid @PathVariable(value="processInstanceId",required=true) @NotNull @Valid String processInstanceId, @NotNull @Valid @PathVariable(value="sessionId",required=true) @NotNull @Valid String sessionId)
-
-