Package org.openapitools.client.api
Class TaskVariableApi
- java.lang.Object
-
- org.openapitools.client.api.TaskVariableApi
-
public class TaskVariableApi extends Object
-
-
Constructor Summary
Constructors Constructor Description TaskVariableApi()TaskVariableApi(ApiClient apiClient)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voiddeleteTaskVariable(String id, String varName)Delete Task Variable Removes a variable that is visible to a task.okhttp3.CalldeleteTaskVariableAsync(String id, String varName, ApiCallback<Void> _callback)Delete Task Variable (asynchronously) Removes a variable that is visible to a task.okhttp3.CalldeleteTaskVariableCall(String id, String varName, ApiCallback _callback)Build call for deleteTaskVariableApiResponse<Void>deleteTaskVariableWithHttpInfo(String id, String varName)Delete Task Variable Removes a variable that is visible to a task.ApiClientgetApiClient()VariableValueDtogetTaskVariable(String id, String varName, Boolean deserializeValue)Get Task Variable Retrieves a variable from the context of a given task.okhttp3.CallgetTaskVariableAsync(String id, String varName, Boolean deserializeValue, ApiCallback<VariableValueDto> _callback)Get Task Variable (asynchronously) Retrieves a variable from the context of a given task.FilegetTaskVariableBinary(String id, String varName)Get Task Variable (Binary) Retrieves a binary variable from the context of a given task.okhttp3.CallgetTaskVariableBinaryAsync(String id, String varName, ApiCallback<File> _callback)Get Task Variable (Binary) (asynchronously) Retrieves a binary variable from the context of a given task.okhttp3.CallgetTaskVariableBinaryCall(String id, String varName, ApiCallback _callback)Build call for getTaskVariableBinaryApiResponse<File>getTaskVariableBinaryWithHttpInfo(String id, String varName)Get Task Variable (Binary) Retrieves a binary variable from the context of a given task.okhttp3.CallgetTaskVariableCall(String id, String varName, Boolean deserializeValue, ApiCallback _callback)Build call for getTaskVariableMap<String,VariableValueDto>getTaskVariables(String id, Boolean deserializeValues)Get Task Variables Retrieves all variables visible from the task.okhttp3.CallgetTaskVariablesAsync(String id, Boolean deserializeValues, ApiCallback<Map<String,VariableValueDto>> _callback)Get Task Variables (asynchronously) Retrieves all variables visible from the task.okhttp3.CallgetTaskVariablesCall(String id, Boolean deserializeValues, ApiCallback _callback)Build call for getTaskVariablesApiResponse<Map<String,VariableValueDto>>getTaskVariablesWithHttpInfo(String id, Boolean deserializeValues)Get Task Variables Retrieves all variables visible from the task.ApiResponse<VariableValueDto>getTaskVariableWithHttpInfo(String id, String varName, Boolean deserializeValue)Get Task Variable Retrieves a variable from the context of a given task.voidmodifyTaskVariables(String id, PatchVariablesDto patchVariablesDto)Update/Delete Task Variables Updates or deletes the variables visible from the task.okhttp3.CallmodifyTaskVariablesAsync(String id, PatchVariablesDto patchVariablesDto, ApiCallback<Void> _callback)Update/Delete Task Variables (asynchronously) Updates or deletes the variables visible from the task.okhttp3.CallmodifyTaskVariablesCall(String id, PatchVariablesDto patchVariablesDto, ApiCallback _callback)Build call for modifyTaskVariablesApiResponse<Void>modifyTaskVariablesWithHttpInfo(String id, PatchVariablesDto patchVariablesDto)Update/Delete Task Variables Updates or deletes the variables visible from the task.voidputTaskVariable(String id, String varName, VariableValueDto variableValueDto)Update Task Variable Updates a process variable that is visible from the Task scope.okhttp3.CallputTaskVariableAsync(String id, String varName, VariableValueDto variableValueDto, ApiCallback<Void> _callback)Update Task Variable (asynchronously) Updates a process variable that is visible from the Task scope.okhttp3.CallputTaskVariableCall(String id, String varName, VariableValueDto variableValueDto, ApiCallback _callback)Build call for putTaskVariableApiResponse<Void>putTaskVariableWithHttpInfo(String id, String varName, VariableValueDto variableValueDto)Update Task Variable Updates a process variable that is visible from the Task scope.voidsetApiClient(ApiClient apiClient)voidsetBinaryTaskVariable(String id, String varName, File data, String valueType)Update Task Variable (Binary) Sets the serialized value for a binary variable or the binary value for a file variable visible from the task.okhttp3.CallsetBinaryTaskVariableAsync(String id, String varName, File data, String valueType, ApiCallback<Void> _callback)Update Task Variable (Binary) (asynchronously) Sets the serialized value for a binary variable or the binary value for a file variable visible from the task.okhttp3.CallsetBinaryTaskVariableCall(String id, String varName, File data, String valueType, ApiCallback _callback)Build call for setBinaryTaskVariableApiResponse<Void>setBinaryTaskVariableWithHttpInfo(String id, String varName, File data, String valueType)Update Task Variable (Binary) Sets the serialized value for a binary variable or the binary value for a file variable visible from the task.
-
-
-
Constructor Detail
-
TaskVariableApi
public TaskVariableApi()
-
TaskVariableApi
public TaskVariableApi(ApiClient apiClient)
-
-
Method Detail
-
getApiClient
public ApiClient getApiClient()
-
setApiClient
public void setApiClient(ApiClient apiClient)
-
deleteTaskVariableCall
public okhttp3.Call deleteTaskVariableCall(String id, String varName, ApiCallback _callback) throws ApiException
Build call for deleteTaskVariable- Parameters:
id- The id of the task to delete the variable from. (required)varName- The name of the variable to be removed. (required)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
deleteTaskVariable
public void deleteTaskVariable(String id, String varName) throws ApiException
Delete Task Variable Removes a variable that is visible to a task. A variable is visible to a task if it is a local task variable or declared in a parent scope of the task. See documentation on [visiblity of variables](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables/).- Parameters:
id- The id of the task to delete the variable from. (required)varName- The name of the variable to be removed. (required)- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
deleteTaskVariableWithHttpInfo
public ApiResponse<Void> deleteTaskVariableWithHttpInfo(String id, String varName) throws ApiException
Delete Task Variable Removes a variable that is visible to a task. A variable is visible to a task if it is a local task variable or declared in a parent scope of the task. See documentation on [visiblity of variables](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables/).- Parameters:
id- The id of the task to delete the variable from. (required)varName- The name of the variable to be removed. (required)- Returns:
- ApiResponse<Void>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
deleteTaskVariableAsync
public okhttp3.Call deleteTaskVariableAsync(String id, String varName, ApiCallback<Void> _callback) throws ApiException
Delete Task Variable (asynchronously) Removes a variable that is visible to a task. A variable is visible to a task if it is a local task variable or declared in a parent scope of the task. See documentation on [visiblity of variables](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables/).- Parameters:
id- The id of the task to delete the variable from. (required)varName- The name of the variable to be removed. (required)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object
-
getTaskVariableCall
public okhttp3.Call getTaskVariableCall(String id, String varName, Boolean deserializeValue, ApiCallback _callback) throws ApiException
Build call for getTaskVariable- Parameters:
id- The id of the task to retrieve the variable from. (required)varName- The name of the variable to get. (required)deserializeValue- Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on the server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. Note: While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine. (optional, default to true)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
getTaskVariable
public VariableValueDto getTaskVariable(String id, String varName, Boolean deserializeValue) throws ApiException
Get Task Variable Retrieves a variable from the context of a given task. The variable must be visible from the task. It is visible from the task if it is a local task variable or declared in a parent scope of the task. See documentation on [visiblity of variables](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables/).- Parameters:
id- The id of the task to retrieve the variable from. (required)varName- The name of the variable to get. (required)deserializeValue- Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on the server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. Note: While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine. (optional, default to true)- Returns:
- VariableValueDto
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getTaskVariableWithHttpInfo
public ApiResponse<VariableValueDto> getTaskVariableWithHttpInfo(String id, String varName, Boolean deserializeValue) throws ApiException
Get Task Variable Retrieves a variable from the context of a given task. The variable must be visible from the task. It is visible from the task if it is a local task variable or declared in a parent scope of the task. See documentation on [visiblity of variables](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables/).- Parameters:
id- The id of the task to retrieve the variable from. (required)varName- The name of the variable to get. (required)deserializeValue- Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on the server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. Note: While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine. (optional, default to true)- Returns:
- ApiResponse<VariableValueDto>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getTaskVariableAsync
public okhttp3.Call getTaskVariableAsync(String id, String varName, Boolean deserializeValue, ApiCallback<VariableValueDto> _callback) throws ApiException
Get Task Variable (asynchronously) Retrieves a variable from the context of a given task. The variable must be visible from the task. It is visible from the task if it is a local task variable or declared in a parent scope of the task. See documentation on [visiblity of variables](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables/).- Parameters:
id- The id of the task to retrieve the variable from. (required)varName- The name of the variable to get. (required)deserializeValue- Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on the server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. Note: While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine. (optional, default to true)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object
-
getTaskVariableBinaryCall
public okhttp3.Call getTaskVariableBinaryCall(String id, String varName, ApiCallback _callback) throws ApiException
Build call for getTaskVariableBinary- Parameters:
id- The id of the task to retrieve the variable for. (required)varName- The name of the variable to retrieve. (required)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
getTaskVariableBinary
public File getTaskVariableBinary(String id, String varName) throws ApiException
Get Task Variable (Binary) Retrieves a binary variable from the context of a given task. Applicable for byte array and file variables. The variable must be visible from the task. It is visible from the task if it is a local task variable or declared in a parent scope of the task. See documentation on [visiblity of variables](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables/).- Parameters:
id- The id of the task to retrieve the variable for. (required)varName- The name of the variable to retrieve. (required)- Returns:
- File
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getTaskVariableBinaryWithHttpInfo
public ApiResponse<File> getTaskVariableBinaryWithHttpInfo(String id, String varName) throws ApiException
Get Task Variable (Binary) Retrieves a binary variable from the context of a given task. Applicable for byte array and file variables. The variable must be visible from the task. It is visible from the task if it is a local task variable or declared in a parent scope of the task. See documentation on [visiblity of variables](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables/).- Parameters:
id- The id of the task to retrieve the variable for. (required)varName- The name of the variable to retrieve. (required)- Returns:
- ApiResponse<File>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getTaskVariableBinaryAsync
public okhttp3.Call getTaskVariableBinaryAsync(String id, String varName, ApiCallback<File> _callback) throws ApiException
Get Task Variable (Binary) (asynchronously) Retrieves a binary variable from the context of a given task. Applicable for byte array and file variables. The variable must be visible from the task. It is visible from the task if it is a local task variable or declared in a parent scope of the task. See documentation on [visiblity of variables](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables/).- Parameters:
id- The id of the task to retrieve the variable for. (required)varName- The name of the variable to retrieve. (required)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object
-
getTaskVariablesCall
public okhttp3.Call getTaskVariablesCall(String id, Boolean deserializeValues, ApiCallback _callback) throws ApiException
Build call for getTaskVariables- Parameters:
id- The id of the task to retrieve the variables from. (required)deserializeValues- Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on the server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. Note: While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine. (optional, default to true)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
getTaskVariables
public Map<String,VariableValueDto> getTaskVariables(String id, Boolean deserializeValues) throws ApiException
Get Task Variables Retrieves all variables visible from the task. A variable is visible from the task if it is a local task variable or declared in a parent scope of the task. See documentation on [visiblity of variables](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables/).- Parameters:
id- The id of the task to retrieve the variables from. (required)deserializeValues- Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on the server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. Note: While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine. (optional, default to true)- Returns:
- Map<String, VariableValueDto>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getTaskVariablesWithHttpInfo
public ApiResponse<Map<String,VariableValueDto>> getTaskVariablesWithHttpInfo(String id, Boolean deserializeValues) throws ApiException
Get Task Variables Retrieves all variables visible from the task. A variable is visible from the task if it is a local task variable or declared in a parent scope of the task. See documentation on [visiblity of variables](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables/).- Parameters:
id- The id of the task to retrieve the variables from. (required)deserializeValues- Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on the server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. Note: While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine. (optional, default to true)- Returns:
- ApiResponse<Map<String, VariableValueDto>>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getTaskVariablesAsync
public okhttp3.Call getTaskVariablesAsync(String id, Boolean deserializeValues, ApiCallback<Map<String,VariableValueDto>> _callback) throws ApiException
Get Task Variables (asynchronously) Retrieves all variables visible from the task. A variable is visible from the task if it is a local task variable or declared in a parent scope of the task. See documentation on [visiblity of variables](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables/).- Parameters:
id- The id of the task to retrieve the variables from. (required)deserializeValues- Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on the server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. Note: While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine. (optional, default to true)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object
-
modifyTaskVariablesCall
public okhttp3.Call modifyTaskVariablesCall(String id, PatchVariablesDto patchVariablesDto, ApiCallback _callback) throws ApiException
Build call for modifyTaskVariables- Parameters:
id- The id of the task to set variables for. (required)patchVariablesDto- (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
modifyTaskVariables
public void modifyTaskVariables(String id, PatchVariablesDto patchVariablesDto) throws ApiException
Update/Delete Task Variables Updates or deletes the variables visible from the task. Updates precede deletions. So, if a variable is updated AND deleted, the deletion overrides the update. A variable is visible from the task if it is a local task variable or declared in a parent scope of the task. See documentation on [visiblity of variables](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables/).- Parameters:
id- The id of the task to set variables for. (required)patchVariablesDto- (optional)- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
modifyTaskVariablesWithHttpInfo
public ApiResponse<Void> modifyTaskVariablesWithHttpInfo(String id, PatchVariablesDto patchVariablesDto) throws ApiException
Update/Delete Task Variables Updates or deletes the variables visible from the task. Updates precede deletions. So, if a variable is updated AND deleted, the deletion overrides the update. A variable is visible from the task if it is a local task variable or declared in a parent scope of the task. See documentation on [visiblity of variables](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables/).- Parameters:
id- The id of the task to set variables for. (required)patchVariablesDto- (optional)- Returns:
- ApiResponse<Void>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
modifyTaskVariablesAsync
public okhttp3.Call modifyTaskVariablesAsync(String id, PatchVariablesDto patchVariablesDto, ApiCallback<Void> _callback) throws ApiException
Update/Delete Task Variables (asynchronously) Updates or deletes the variables visible from the task. Updates precede deletions. So, if a variable is updated AND deleted, the deletion overrides the update. A variable is visible from the task if it is a local task variable or declared in a parent scope of the task. See documentation on [visiblity of variables](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables/).- Parameters:
id- The id of the task to set variables for. (required)patchVariablesDto- (optional)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object
-
putTaskVariableCall
public okhttp3.Call putTaskVariableCall(String id, String varName, VariableValueDto variableValueDto, ApiCallback _callback) throws ApiException
Build call for putTaskVariable- Parameters:
id- The id of the task to set the variable for. (required)varName- The name of the variable to set. (required)variableValueDto- (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
putTaskVariable
public void putTaskVariable(String id, String varName, VariableValueDto variableValueDto) throws ApiException
Update Task Variable Updates a process variable that is visible from the Task scope. A variable is visible from the task if it is a local task variable, or declared in a parent scope of the task. See the documentation on [variable scopes and visibility](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables#variable-scopes-and-variable-visibility). **Note**: If a variable doesn't exist, the variable is created in the top-most scope visible from the task.- Parameters:
id- The id of the task to set the variable for. (required)varName- The name of the variable to set. (required)variableValueDto- (optional)- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
putTaskVariableWithHttpInfo
public ApiResponse<Void> putTaskVariableWithHttpInfo(String id, String varName, VariableValueDto variableValueDto) throws ApiException
Update Task Variable Updates a process variable that is visible from the Task scope. A variable is visible from the task if it is a local task variable, or declared in a parent scope of the task. See the documentation on [variable scopes and visibility](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables#variable-scopes-and-variable-visibility). **Note**: If a variable doesn't exist, the variable is created in the top-most scope visible from the task.- Parameters:
id- The id of the task to set the variable for. (required)varName- The name of the variable to set. (required)variableValueDto- (optional)- Returns:
- ApiResponse<Void>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
putTaskVariableAsync
public okhttp3.Call putTaskVariableAsync(String id, String varName, VariableValueDto variableValueDto, ApiCallback<Void> _callback) throws ApiException
Update Task Variable (asynchronously) Updates a process variable that is visible from the Task scope. A variable is visible from the task if it is a local task variable, or declared in a parent scope of the task. See the documentation on [variable scopes and visibility](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables#variable-scopes-and-variable-visibility). **Note**: If a variable doesn't exist, the variable is created in the top-most scope visible from the task.- Parameters:
id- The id of the task to set the variable for. (required)varName- The name of the variable to set. (required)variableValueDto- (optional)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object
-
setBinaryTaskVariableCall
public okhttp3.Call setBinaryTaskVariableCall(String id, String varName, File data, String valueType, ApiCallback _callback) throws ApiException
Build call for setBinaryTaskVariable- Parameters:
id- The id of the task to retrieve the variable for. (required)varName- The name of the variable to retrieve. (required)data- 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. (optional)valueType- The name of the variable type. Either Bytes for a byte array variable or File for a file variable. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
setBinaryTaskVariable
public void setBinaryTaskVariable(String id, String varName, File data, String valueType) throws ApiException
Update Task Variable (Binary) Sets the serialized value for a binary variable or the binary value for a file variable visible from the task. A variable is visible from the task if it is a local task variable or declared in a parent scope of the task. See documentation on [visiblity of variables](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables/).- Parameters:
id- The id of the task to retrieve the variable for. (required)varName- The name of the variable to retrieve. (required)data- 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. (optional)valueType- The name of the variable type. Either Bytes for a byte array variable or File for a file variable. (optional)- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
setBinaryTaskVariableWithHttpInfo
public ApiResponse<Void> setBinaryTaskVariableWithHttpInfo(String id, String varName, File data, String valueType) throws ApiException
Update Task Variable (Binary) Sets the serialized value for a binary variable or the binary value for a file variable visible from the task. A variable is visible from the task if it is a local task variable or declared in a parent scope of the task. See documentation on [visiblity of variables](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables/).- Parameters:
id- The id of the task to retrieve the variable for. (required)varName- The name of the variable to retrieve. (required)data- 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. (optional)valueType- The name of the variable type. Either Bytes for a byte array variable or File for a file variable. (optional)- Returns:
- ApiResponse<Void>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
setBinaryTaskVariableAsync
public okhttp3.Call setBinaryTaskVariableAsync(String id, String varName, File data, String valueType, ApiCallback<Void> _callback) throws ApiException
Update Task Variable (Binary) (asynchronously) Sets the serialized value for a binary variable or the binary value for a file variable visible from the task. A variable is visible from the task if it is a local task variable or declared in a parent scope of the task. See documentation on [visiblity of variables](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables/).- Parameters:
id- The id of the task to retrieve the variable for. (required)varName- The name of the variable to retrieve. (required)data- 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. (optional)valueType- The name of the variable type. Either Bytes for a byte array variable or File for a file variable. (optional)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object
-
-