Plan Item Instances

Execute an action on a plan item instance

put/cmmn-runtime/plan-item-instances/{planItemInstanceId}

Request

Path parameters

planItemInstanceIdstring required

Request body

actionstring

Response

Indicates the plan item instance was found and the action is performed.

idstring
urlstring
namestring
caseInstanceIdstring
caseInstanceUrlstring
caseDefinitionIdstring
caseDefinitionUrlstring
derivedCaseDefinitionIdstring
derivedCaseDefinitionUrlstring
stageInstanceIdstring
stageInstanceUrlstring
planItemDefinitionIdstring
planItemDefinitionTypestring
statestring
stageboolean
elementIdstring
createTimestring date-time
lastAvailableTimestring date-time
lastEnabledTimestring date-time
lastDisabledTimestring date-time
lastStartedTimestring date-time
lastSuspendedTimestring date-time
completedTimestring date-time
occurredTimestring date-time
terminatedTimestring date-time
exitTimestring date-time
endedTimestring date-time
startUserIdstring
assigneestring
completedBystring
referenceIdstring
referenceTypestring
completableboolean
entryCriterionIdstring
exitCriterionIdstring
formKeystring
extraValuestring
tenantIdstring

Example response

{
  "id": "5",
  "url": "http://localhost:8182/cmmn-runtime/plan-item-instances/5",
  "tenantId": "null",
  "localVariables": [
    {
      "name": "myVariable",
      "type": "string",
      "valueUrl": "http://...."
    }
  ]
}

Changes

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