Case Instance Variables

Update a single variable on a case instance

This endpoint can be used in 2 ways: By passing a JSON Body (RestVariable) or by passing a multipart/form-data Object. Note that scope is ignored, only global variables can be set in a case instance. NB: Swagger V2 specification doesn't support this use case that is why this endpoint might be buggy/incomplete if used with other tools.

put/cmmn-runtime/case-instances/{caseInstanceId}/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/case-instances/:caseInstanceId/variables/:variableName/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

caseInstanceIdstring required

variableNamestring required

Request body

CaseInstanceVariableResource required

Response

successful operation

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.