Sets the serialized value for a binary variable or the binary value for a file variable.

Method

POST /case-execution/{id}/variables/{varName}/data

Parameters

Path Parameters

Name Description
id The id of the case execution to set the variable for.
varName The name of the variable to set.

Request Body

For binary variables a multipart form submit with the following parts:

Form Part Name Content Type Description
data application/octet-stream

The binary data to be set.

For File variables, this multipart can contain the filename, binary value and MIME type of the file variable to be set. Only the filename is mandatory.

|valueType|text/plain|The name of the variable type. Either Bytes for a byte array variable or File for a file variable.
|data|application/json|Deprecated: This only works if the REST API is aware of the involved Java classes.
A JSON representation of a serialized Java Object. Form part type (see below) must be provided.

|type|text/plain|Deprecated: This only works if the REST API is aware of the involved Java classes.
The canonical java type name of the case variable to be set. Example: foo.bar.Customer. If this part is provided, data must be a JSON object which can be converted into an instance of the provided class. The content type of the data part must be application/json in that case (see above).

Result

This method returns no content.

Response Codes

Code Media type Description
204 Request successful.
400 application/json The variable value or type is invalid, for example if no filename is set. See the Introduction for the error response format.

Example

Request

(1) Post binary content of a byte array variable:

POST /case-execution/aCaseExecutionId/variables/aVarName/data

  1. ---OSQH1f8lzs83iXFHphqfIuitaQfNKFY74Y
  2. Content-Disposition: form-data; name="data"; filename="unspecified"
  3. Content-Type: application/octet-stream
  4. Content-Transfer-Encoding: binary
  6. <<Byte Stream ommitted>>
  7. ---OSQH1f8lzs83iXFHphqfIuitaQfNKFY74Y
  8. Content-Disposition: form-data; name="valueType"
  9. Content-Type: text/plain; charset=US-ASCII
  10. Content-Transfer-Encoding: 8bit
  12. Bytes
  13. ---OSQH1f8lzs83iXFHphqfIuitaQfNKFY74Y--

(2) Post the JSON serialization of a Java Class (deprecated):

POST /case-execution/aCaseExecutionId/variables/aVarName/data

  1. ---OSQH1f8lzs83iXFHphqfIuitaQfNKFY74Y
  2. Content-Disposition: form-data; name="data"
  3. Content-Type: application/json; charset=US-ASCII
  4. Content-Transfer-Encoding: 8bit
  6. ["foo", "bar"]
  7. ---OSQH1f8lzs83iXFHphqfIuitaQfNKFY74Y
  8. Content-Disposition: form-data; name="type"
  9. Content-Type: text/plain; charset=US-ASCII
  10. Content-Transfer-Encoding: 8bit
  12. java.util.ArrayList<java.lang.Object>
  13. ---OSQH1f8lzs83iXFHphqfIuitaQfNKFY74Y--

(3) Post a text file:

POST /case-execution/aCaseExecutionId/variables/aVarName/data

  1. ---OSQH1f8lzs83iXFHphqfIuitaQfNKFY74Y
  2. Content-Disposition: form-data; name="data"; filename="myFile.txt"
  3. Content-Type: text/plain; charset=US-ASCII
  4. Content-Transfer-Encoding: binary
  6. <<Byte Stream ommitted>>
  7. ---OSQH1f8lzs83iXFHphqfIuitaQfNKFY74Y
  8. Content-Disposition: form-data; name="valueType"
  9. Content-Type: text/plain; charset=US-ASCII
  10. Content-Transfer-Encoding: 8bit
  12. File
  13. ---OSQH1f8lzs83iXFHphqfIuitaQfNKFY74Y--

原文: https://docs.camunda.org/manual/7.9/reference/rest/case-execution/variables/post-variable-binary/