---
title: "Execute an action on a plan item instance"
method: PUT
path: "/cmmn-runtime/plan-item-instances/{planItemInstanceId}"
tags: ["Plan Item Instances"]
---

# Execute an action on a plan item instance

`PUT /cmmn-runtime/plan-item-instances/{planItemInstanceId}`

## Request

- Base URL: `https://developer-docs.flowable.com/cmmn-api`
- URL: `https://developer-docs.flowable.com/cmmn-api/cmmn-runtime/plan-item-instances/{planItemInstanceId}`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/flowable/apis/flowable-cmmn-rest-api/docs/cmmn-runtime/plan-item-instances/:planItemInstanceId/put.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `planItemInstanceId` string, required

## Request body

- RestActionRequest
  - `action` string

## Response `200`

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

- PlanItemInstanceResponse
  - `id` string
  - `url` string
  - `name` string
  - `caseInstanceId` string
  - `caseInstanceUrl` string
  - `caseDefinitionId` string
  - `caseDefinitionUrl` string
  - `derivedCaseDefinitionId` string
  - `derivedCaseDefinitionUrl` string
  - `stageInstanceId` string
  - `stageInstanceUrl` string
  - `planItemDefinitionId` string
  - `planItemDefinitionType` string
  - `state` string
  - `stage` boolean
  - `elementId` string
  - `createTime` string, date-time
  - `lastAvailableTime` string, date-time
  - `lastEnabledTime` string, date-time
  - `lastDisabledTime` string, date-time
  - `lastStartedTime` string, date-time
  - `lastSuspendedTime` string, date-time
  - `completedTime` string, date-time
  - `occurredTime` string, date-time
  - `terminatedTime` string, date-time
  - `exitTime` string, date-time
  - `endedTime` string, date-time
  - `startUserId` string
  - `assignee` string
  - `completedBy` string
  - `referenceId` string
  - `referenceType` string
  - `completable` boolean
  - `entryCriterionId` string
  - `exitCriterionId` string
  - `formKey` string
  - `extraValue` string
  - `tenantId` string
  - `localVariables` RestVariable[]
    - `name` string: Name of the variable
    - `type` string: Type of the variable.
    - `value` object: Value of the variable.
    - `valueUrl` string
    - `scope` string

## Other responses

- `204`: Indicates the plan item instance was found, the action was performed and the action caused the plan item instance to end.
- `400`: Indicates an illegal action was requested, required parameters are missing in the request body or illegal variables are passed in. Status description contains additional information about the error.
- `404`: Indicates the plan item instance was not found.

---

[API](https://skmtc.dev/flowable/apis/flowable-cmmn-rest-api.md) - [All operations](https://skmtc.dev/flowable/apis/flowable-cmmn-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/flowable/apis/flowable-cmmn-rest-api/revisions/afdfa1fcacd0?raw)