Plan Item Instances

Update a variable on a plan item

This endpoint can be used in 2 ways: By passing a JSON Body (RestVariable) or by passing a multipart/form-data Object. NB: Swagger V2 specification does not support this use case that is why this endpoint might be buggy/incomplete if used with other tools.

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

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/plan-item-instances/:planItemInstanceId/variables/:variableName/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

planItemInstanceIdstring required

variableNamestring required

Request body

PlanItemInstanceVariableResource required

Response

Indicates both the plan item instance and variable were found and variable is updated.

namestring

Name of the variable

typestring

Type of the variable.

valueobject

Value of the variable.

valueUrlstring

scopestring

Example response

{
  "name": "myVariable",
  "type": "string",
  "valueUrl": "http://...."
}

Changes

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