Class CaseInstanceResource

java.lang.Object

org.flowable.cmmn.rest.service.api.runtime.caze.BaseCaseInstanceResource

org.flowable.cmmn.rest.service.api.runtime.caze.CaseInstanceResource

@RestController
public class CaseInstanceResource
extends BaseCaseInstanceResource

Author:

Tijs Rademakers, Joram Barrez

Field Summary

Fields

Modifier and Type	Field	Description
protected CmmnEngineConfiguration	cmmnEngineConfiguration
protected CmmnMigrationService	cmmnMigrationService

Fields inherited from class BaseCaseInstanceResource

repositoryService, restApiInterceptor, restResponseFactory, runtimeService

Constructor Summary

Constructors

Constructor	Description
CaseInstanceResource()

Method Summary

Modifier and Type	Method	Description
void	changePlanItemState(String caseInstanceId, ChangePlanItemStateRequest planItemStateRequest)
void	deleteCaseInstance(String caseInstanceId)
CaseInstanceResponse	getCaseInstance(String caseInstanceId)
List<StageResponse>	getStageOverview(String caseInstanceId)
void	migrateCaseInstance(String caseInstanceId, String migrationDocumentJson)
void	terminateCaseInstance(String caseInstanceId)
CaseInstanceResponse	updateCaseInstance(String caseInstanceId, CaseInstanceUpdateRequest updateRequest, jakarta.servlet.http.HttpServletResponse response)
CaseInstanceMigrationValidationResponse	validateCaseInstanceMigration(String caseInstanceId, String migrationDocumentJson)

Methods inherited from class BaseCaseInstanceResource

addVariables, getCaseInstanceFromRequest, getCaseInstanceFromRequestWithoutAccessCheck, getQueryResponse

Methods inherited from class Object

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

Field Details

cmmnEngineConfiguration

@Autowired
protected CmmnEngineConfiguration cmmnEngineConfiguration

cmmnMigrationService

@Autowired
protected CmmnMigrationService cmmnMigrationService

Constructor Details

CaseInstanceResource

public CaseInstanceResource()

Method Details

getCaseInstance

@GetMapping(value="/cmmn-runtime/case-instances/{caseInstanceId}",
            produces="application/json")
public CaseInstanceResponse getCaseInstance(@PathVariable
 String caseInstanceId)

updateCaseInstance

@PutMapping(value="/cmmn-runtime/case-instances/{caseInstanceId}",
            produces="application/json")
public CaseInstanceResponse updateCaseInstance(@PathVariable
 String caseInstanceId,
 @RequestBody
 CaseInstanceUpdateRequest updateRequest,
 jakarta.servlet.http.HttpServletResponse response)

terminateCaseInstance

@DeleteMapping("/cmmn-runtime/case-instances/{caseInstanceId}")
@ResponseStatus(NO_CONTENT)
public void terminateCaseInstance(@PathVariable
 String caseInstanceId)

deleteCaseInstance

@DeleteMapping("/cmmn-runtime/case-instances/{caseInstanceId}/delete")
@ResponseStatus(NO_CONTENT)
public void deleteCaseInstance(@PathVariable
 String caseInstanceId)

getStageOverview

@GetMapping(value="/cmmn-runtime/case-instances/{caseInstanceId}/stage-overview",
            produces="application/json")
public List<StageResponse> getStageOverview(@PathVariable
 String caseInstanceId)

changePlanItemState

@PostMapping(value="/cmmn-runtime/case-instances/{caseInstanceId}/change-state",
             produces="application/json")
public void changePlanItemState(@PathVariable
 String caseInstanceId,
 @RequestBody
 ChangePlanItemStateRequest planItemStateRequest)

migrateCaseInstance

@PostMapping(value="/cmmn-runtime/case-instances/{caseInstanceId}/migrate",
             produces="application/json")
public void migrateCaseInstance(@PathVariable
 String caseInstanceId,
 @RequestBody
 String migrationDocumentJson)

validateCaseInstanceMigration

@PostMapping(value="/cmmn-runtime/case-instances/{caseInstanceId}/validate-migration",
             produces="application/json")
public CaseInstanceMigrationValidationResponse validateCaseInstanceMigration(@PathVariable
 String caseInstanceId,
 @RequestBody
 String migrationDocumentJson)