Package org.camunda.community.rest.client.api

Class TaskLocalVariableApi

java.lang.Object
org.camunda.community.rest.client.api.TaskLocalVariableApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-06-04T13:43:01.451833574Z[Etc/UTC]") public class TaskLocalVariableApi extends Object

  • Constructor Details

    • TaskLocalVariableApi

      public TaskLocalVariableApi()

    • TaskLocalVariableApi

      public TaskLocalVariableApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • deleteTaskLocalVariable

      public void deleteTaskLocalVariable(String id, String varName) throws ApiException
      Delete Local Task Variable Removes a local variable from a task by id.
      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 fails to make API call

    • deleteTaskLocalVariable

      public void deleteTaskLocalVariable(String id, String varName, Map<String,String> additionalHeaders) throws ApiException
      Delete Local Task Variable Removes a local variable from a task by id.
      Parameters:
      id - The id of the task to delete the variable from. (required)
      varName - The name of the variable to be removed. (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • getTaskLocalVariable

      public VariableValueDto getTaskLocalVariable(String id, String varName, Boolean deserializeValue) throws ApiException
      Get Local Task Variable Retrieves a variable from the context of a given task by id.
      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 fails to make API call

    • getTaskLocalVariable

      public VariableValueDto getTaskLocalVariable(String id, String varName, Boolean deserializeValue, Map<String,String> additionalHeaders) throws ApiException
      Get Local Task Variable Retrieves a variable from the context of a given task by id.
      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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      VariableValueDto
      Throws:
      ApiException - if fails to make API call

    • getTaskLocalVariableBinary

      public File getTaskLocalVariableBinary(String id, String varName) throws ApiException
      Get Local Task Variable (Binary) Retrieves a binary variable from the context of a given task by id. Applicable for byte array and file 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 fails to make API call

    • getTaskLocalVariableBinary

      public File getTaskLocalVariableBinary(String id, String varName, Map<String,String> additionalHeaders) throws ApiException
      Get Local Task Variable (Binary) Retrieves a binary variable from the context of a given task by id. Applicable for byte array and file variables.
      Parameters:
      id - The id of the task to retrieve the variable for. (required)
      varName - The name of the variable to retrieve. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      File
      Throws:
      ApiException - if fails to make API call

    • getTaskLocalVariables

      public Map<String,VariableValueDto> getTaskLocalVariables(String id, Boolean deserializeValues) throws ApiException
      Get Local Task Variables Retrieves all variables of a given task by id.
      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 fails to make API call

    • getTaskLocalVariables

      public Map<String,VariableValueDto> getTaskLocalVariables(String id, Boolean deserializeValues, Map<String,String> additionalHeaders) throws ApiException
      Get Local Task Variables Retrieves all variables of a given task by id.
      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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      Map<String, VariableValueDto>
      Throws:
      ApiException - if fails to make API call

    • modifyTaskLocalVariables

      public void modifyTaskLocalVariables(String id, PatchVariablesDto patchVariablesDto) throws ApiException
      Update/Delete Local Task Variables Updates or deletes the variables in the context of a task. Updates precede deletions. So, if a variable is updated AND deleted, the deletion overrides the update.
      Parameters:
      id - The id of the task to set variables for. (required)
      patchVariablesDto - (optional)
      Throws:
      ApiException - if fails to make API call

    • modifyTaskLocalVariables

      public void modifyTaskLocalVariables(String id, PatchVariablesDto patchVariablesDto, Map<String,String> additionalHeaders) throws ApiException
      Update/Delete Local Task Variables Updates or deletes the variables in the context of a task. Updates precede deletions. So, if a variable is updated AND deleted, the deletion overrides the update.
      Parameters:
      id - The id of the task to set variables for. (required)
      patchVariablesDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • putTaskLocalVariable

      public void putTaskLocalVariable(String id, String varName, VariableValueDto variableValueDto) throws ApiException
      Update Local Task Variable Sets a variable in the context of a given 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 fails to make API call

    • putTaskLocalVariable

      public void putTaskLocalVariable(String id, String varName, VariableValueDto variableValueDto, Map<String,String> additionalHeaders) throws ApiException
      Update Local Task Variable Sets a variable in the context of a given 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)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • setBinaryTaskLocalVariable

      public void setBinaryTaskLocalVariable(String id, String varName, File data, String valueType) throws ApiException
      Update Local Task Variable (Binary) Sets the serialized value for a binary variable or the binary value for a file variable.
      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 fails to make API call

    • setBinaryTaskLocalVariable

      public void setBinaryTaskLocalVariable(String id, String varName, File data, String valueType, Map<String,String> additionalHeaders) throws ApiException
      Update Local Task Variable (Binary) Sets the serialized value for a binary variable or the binary value for a file variable.
      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)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call