Performs a transition from DISABLED
state to ENABLED
state. In relation to the state transition, it is possible to update or delete case instance variables (please note: deletion precedes update).
Method
POST /case-execution/{id}/reenable
Parameters
Path Parameters
Name | Description |
---|---|
id | The id of the case execution to re-enable. |
Request Body
A JSON object with the following properties:
Name | Description |
---|---|
Name | Description |
——- | |
variables | A JSON object containing variable key-value pairs. Each key is a variable name and each value a JSON variable value object. |
Name | Description |
---|---|
value | The variable's value. For variables of type Object , the serialized value has to be submitted as a String value.For variables of type File the value has to be submitted as Base64 encoded string. |
type | The value type of the variable. |
valueInfo | A JSON object containing additional, value-type-dependent properties. For serialized variables of type Object , the following properties can be provided:- objectTypeName: A string representation of the object's type name. - serializationDataFormat: The serialization format used to store the variable. For serialized variables of type File , the following properties can be provided:- filename: The name of the file. This is not the variable name but the name that will be used when downloading the file again. - mimetype: The MIME type of the file that is being uploaded. - encoding: The encoding of the file that is being uploaded. The following property can be provided for all value types: - transient: Indicates whether the variable should be transient or not. See documentation for more informations. |
local | Indicates whether the variable must be created and/or update locally or not. If set to true , the creation or update happens locally and will not be propagated upwards in the execution hierarchy. |
|value|The variable's value. For variables of type Object
, the serialized value has to be submitted as a String value.
For variables of type File
the value has to be submitted as Base64 encoded string.
|type|The value type of the variable.|valueInfo| A JSON object containing additional, value-type-dependent properties.
For serialized variables of type Object
, the following properties can be provided:
- objectTypeName: A string representation of the object's type name.
serializationDataFormat: The serialization format used to store the variable.
For serialized variables of typeFile
, the following properties can be provided:filename: The name of the file. This is not the variable name but the name that will be used when downloading the file again.
- mimetype: The MIME type of the file that is being uploaded.
encoding: The encoding of the file that is being uploaded.
The following property can be provided for all value types:transient: Indicates whether the variable should be transient or not. See documentation for more informations.|local|Indicates whether the variable must be created and/or update locally or not. If set to
true
, the creation or update happens locally and will not be propagated upwards in the execution hierarchy.
|Name|Description
|——-
|value|The variable's value. For variables of typeObject
, the serialized value has to be submitted as a String value.
For variables of typeFile
the value has to be submitted as Base64 encoded string.
|type|The value type of the variable.
|valueInfo| A JSON object containing additional, value-type-dependent properties.
For serialized variables of type Object
, the following properties can be provided:
- objectTypeName: A string representation of the object's type name.
serializationDataFormat: The serialization format used to store the variable.
For serialized variables of typeFile
, the following properties can be provided:filename: The name of the file. This is not the variable name but the name that will be used when downloading the file again.
- mimetype: The MIME type of the file that is being uploaded.
encoding: The encoding of the file that is being uploaded.
The following property can be provided for all value types:transient: Indicates whether the variable should be transient or not. See documentation for more informations.
|local|Indicates whether the variable must be created and/or update locally or not. If set totrue
, the creation or update happens locally and will not be propagated upwards in the execution hierarchy.
|deletions|An array containg JSON objects. Each JSON object has a propertyname
, which is the name of the variable to delete, and a propertylocal
, to indicate whether the variable must be deleted locally or not. Iflocal
is set totrue
the deletion does not propagate upwards in the case execution hierarchy.
Result
This method returns no content.
Response Codes
Code | Media type | Description |
---|---|---|
204 | Request successful. | |
400 | application/json | The state transition is not allowed to be performed, for example when the case execution is active or is already enabled. See the Introduction for the error response format. |
403 | application/json | The case execution cannot be reenabled because of CMMN restrictions. See the Introduction for the error response format. |
404 | application/json | The case execution with given id is not found. See the Introduction for the error response format. |
Example
Request
POST /case-execution/aCaseExecutionId/reenable
Request Body:
{
"variables":
{
"aVariable" : { "value" : "aStringValue", "type": "String" },
"anotherVariable" : { "value" : true, "type": "Boolean", "local" : true }
},
"deletions":
[
{ "name" : "aVariableToDelete", "local" : true },
{ "name" : "anotherVariableToDelete", "local" : false }
]
}
Response
Status 204. No content.
原文: https://docs.camunda.org/manual/7.9/reference/rest/case-execution/post-reenable/