Case Instances

Change the state of a case instance

post/cmmn-runtime/case-instances/{caseInstanceId}/change-state

Request

Base URL
https://developer-docs.flowable.com/cmmn-api
Auth
HTTP basic
TypeScript
https://skmtc.dev/flowable/apis/flowable-cmmn-rest-api/docs/cmmn-runtime/case-instances/:caseInstanceId/change-state/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

caseInstanceIdstring required

Request body

activatePlanItemDefinitionIdsstring[]

plan item definition ids to be activated

moveToAvailablePlanItemDefinitionIdsstring[]

plan item definition ids to be moved to available state

terminatePlanItemDefinitionIdsstring[]

plan item definition ids to be terminated

addWaitingForRepetitionPlanItemDefinitionIdsstring[]

add waiting for repetition to provided plan item definition ids

removeWaitingForRepetitionPlanItemDefinitionIdsstring[]

remove waiting for repetition to provided plan item definition ids

changePlanItemIdsobject

map an existing plan item id to new plan item id, this should not be necessary in general, but could be needed when plan item ids change between case definition versions.

changePlanItemIdsWithDefinitionIdobject

map an existing plan item id to new plan item id with the plan item definition id, this should not be necessary in general, but could be needed when plan item ids change between case definition versions.

Response

Indicates the case instance was found and change state activity was executed.

Changes

No recorded changes to this operation across all 1 revision of this API.