FLflowable
Case Instances

Update case instance properties or execute an action on a case instance (body needs to contain an 'action' property for the latter).

put/cmmn-runtime/case-instances/{caseInstanceId}

Request

Path parameters

caseInstanceIdstring required

Request body

actionstring
namestring
businessKeystring
businessStatusstring
dueDatestring date-time
assigneestring

Response

Indicates the case instance was found and the action/update is performed.

idstring
namestring
urlstring
businessKeystring
businessStatusstring
dueDatestring date-time
claimTimestring date-time
claimedBystring
startTimestring date-time
startUserIdstring
statestring
endedboolean
caseDefinitionIdstring
caseDefinitionUrlstring
caseDefinitionNamestring
caseDefinitionDescriptionstring
parentIdstring
callbackIdstring
callbackTypestring
referenceIdstring
referenceTypestring
tenantIdstring
completedboolean

Example response

{
  "id": "187",
  "name": "processName",
  "url": "http://localhost:8182/cmmn-repository/case-definitions/caseOne%3A1%3A4",
  "businessKey": "myBusinessKey",
  "businessStatus": "myBusinessStatus",
  "startTime": "2019-04-17T10:17:43.902+0000",
  "startUserId": "aUserId",
  "state": "active",
  "caseDefinitionId": "oneTaskCase:1:158",
  "caseDefinitionUrl": "http://localhost:8182/cmmn-repository/case-definitions/caseOne%3A1%3A4",
  "caseDefinitionName": "aCaseDefinitionName",
  "caseDefinitionDescription": "A case definition description",
  "parentId": "123",
  "callbackId": "123",
  "callbackType": "cmmn-1.1-to-cmmn-1.1-child-case",
  "referenceId": "123",
  "referenceType": "event-to-cmmn-1.1-case",
  "variables": [
    {
      "name": "myVariable",
      "type": "string",
      "valueUrl": "http://...."
    }
  ],
  "tenantId": "null"
}

Changes

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