org.camunda.community.rest.client.api.TaskLocalVariableApi Maven / Gradle / Ivy
/*
* Camunda Platform REST API
* OpenApi Spec for Camunda Platform REST API.
*
* The version of the OpenAPI document: 7.21.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
package org.camunda.community.rest.client.api;
import com.fasterxml.jackson.core.type.TypeReference;
import org.camunda.community.rest.client.invoker.ApiException;
import org.camunda.community.rest.client.invoker.ApiClient;
import org.camunda.community.rest.client.invoker.Configuration;
import org.camunda.community.rest.client.invoker.Pair;
import org.camunda.community.rest.client.dto.ExceptionDto;
import java.io.File;
import org.camunda.community.rest.client.dto.PatchVariablesDto;
import org.camunda.community.rest.client.dto.VariableValueDto;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.StringJoiner;
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-06-27T13:50:23.655629899Z[Etc/UTC]")
public class TaskLocalVariableApi {
private ApiClient apiClient;
public TaskLocalVariableApi() {
this(Configuration.getDefaultApiClient());
}
public TaskLocalVariableApi(ApiClient apiClient) {
this.apiClient = apiClient;
}
public ApiClient getApiClient() {
return apiClient;
}
public void setApiClient(ApiClient apiClient) {
this.apiClient = apiClient;
}
/**
* Delete Local Task Variable
* Removes a local variable from a task by id.
* @param id The id of the task to delete the variable from. (required)
* @param varName The name of the variable to be removed. (required)
* @throws ApiException if fails to make API call
*/
public void deleteTaskLocalVariable(String id, String varName) throws ApiException {
this.deleteTaskLocalVariable(id, varName, Collections.emptyMap());
}
/**
* Delete Local Task Variable
* Removes a local variable from a task by id.
* @param id The id of the task to delete the variable from. (required)
* @param varName The name of the variable to be removed. (required)
* @param additionalHeaders additionalHeaders for this call
* @throws ApiException if fails to make API call
*/
public void deleteTaskLocalVariable(String id, String varName, Map additionalHeaders) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException(400, "Missing the required parameter 'id' when calling deleteTaskLocalVariable");
}
// verify the required parameter 'varName' is set
if (varName == null) {
throw new ApiException(400, "Missing the required parameter 'varName' when calling deleteTaskLocalVariable");
}
// create path and map variables
String localVarPath = "/task/{id}/localVariables/{varName}"
.replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString()))
.replaceAll("\\{" + "varName" + "\\}", apiClient.escapeString(varName.toString()));
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarHeaderParams.putAll(additionalHeaders);
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
apiClient.invokeAPI(
localVarPath,
"DELETE",
localVarQueryParams,
localVarCollectionQueryParams,
localVarQueryStringJoiner.toString(),
localVarPostBody,
localVarHeaderParams,
localVarCookieParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
null
);
}
/**
* Get Local Task Variable
* Retrieves a variable from the context of a given task by id.
* @param id The id of the task to retrieve the variable from. (required)
* @param varName The name of the variable to get (required)
* @param 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)
* @return VariableValueDto
* @throws ApiException if fails to make API call
*/
public VariableValueDto getTaskLocalVariable(String id, String varName, Boolean deserializeValue) throws ApiException {
return this.getTaskLocalVariable(id, varName, deserializeValue, Collections.emptyMap());
}
/**
* Get Local Task Variable
* Retrieves a variable from the context of a given task by id.
* @param id The id of the task to retrieve the variable from. (required)
* @param varName The name of the variable to get (required)
* @param 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)
* @param additionalHeaders additionalHeaders for this call
* @return VariableValueDto
* @throws ApiException if fails to make API call
*/
public VariableValueDto getTaskLocalVariable(String id, String varName, Boolean deserializeValue, Map additionalHeaders) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException(400, "Missing the required parameter 'id' when calling getTaskLocalVariable");
}
// verify the required parameter 'varName' is set
if (varName == null) {
throw new ApiException(400, "Missing the required parameter 'varName' when calling getTaskLocalVariable");
}
// create path and map variables
String localVarPath = "/task/{id}/localVariables/{varName}"
.replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString()))
.replaceAll("\\{" + "varName" + "\\}", apiClient.escapeString(varName.toString()));
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarQueryParams.addAll(apiClient.parameterToPair("deserializeValue", deserializeValue));
localVarHeaderParams.putAll(additionalHeaders);
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
TypeReference localVarReturnType = new TypeReference() {};
return apiClient.invokeAPI(
localVarPath,
"GET",
localVarQueryParams,
localVarCollectionQueryParams,
localVarQueryStringJoiner.toString(),
localVarPostBody,
localVarHeaderParams,
localVarCookieParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType
);
}
/**
* 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.
* @param id The id of the task to retrieve the variable for. (required)
* @param varName The name of the variable to retrieve. (required)
* @return File
* @throws ApiException if fails to make API call
*/
public File getTaskLocalVariableBinary(String id, String varName) throws ApiException {
return this.getTaskLocalVariableBinary(id, varName, Collections.emptyMap());
}
/**
* 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.
* @param id The id of the task to retrieve the variable for. (required)
* @param varName The name of the variable to retrieve. (required)
* @param additionalHeaders additionalHeaders for this call
* @return File
* @throws ApiException if fails to make API call
*/
public File getTaskLocalVariableBinary(String id, String varName, Map additionalHeaders) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException(400, "Missing the required parameter 'id' when calling getTaskLocalVariableBinary");
}
// verify the required parameter 'varName' is set
if (varName == null) {
throw new ApiException(400, "Missing the required parameter 'varName' when calling getTaskLocalVariableBinary");
}
// create path and map variables
String localVarPath = "/task/{id}/localVariables/{varName}/data"
.replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString()))
.replaceAll("\\{" + "varName" + "\\}", apiClient.escapeString(varName.toString()));
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarHeaderParams.putAll(additionalHeaders);
final String[] localVarAccepts = {
"application/octet-stream", "text/plain", "application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
TypeReference localVarReturnType = new TypeReference() {};
return apiClient.invokeAPI(
localVarPath,
"GET",
localVarQueryParams,
localVarCollectionQueryParams,
localVarQueryStringJoiner.toString(),
localVarPostBody,
localVarHeaderParams,
localVarCookieParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType
);
}
/**
* Get Local Task Variables
* Retrieves all variables of a given task by id.
* @param id The id of the task to retrieve the variables from. (required)
* @param 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)
* @return Map<String, VariableValueDto>
* @throws ApiException if fails to make API call
*/
public Map getTaskLocalVariables(String id, Boolean deserializeValues) throws ApiException {
return this.getTaskLocalVariables(id, deserializeValues, Collections.emptyMap());
}
/**
* Get Local Task Variables
* Retrieves all variables of a given task by id.
* @param id The id of the task to retrieve the variables from. (required)
* @param 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)
* @param additionalHeaders additionalHeaders for this call
* @return Map<String, VariableValueDto>
* @throws ApiException if fails to make API call
*/
public Map getTaskLocalVariables(String id, Boolean deserializeValues, Map additionalHeaders) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException(400, "Missing the required parameter 'id' when calling getTaskLocalVariables");
}
// create path and map variables
String localVarPath = "/task/{id}/localVariables"
.replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString()));
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarQueryParams.addAll(apiClient.parameterToPair("deserializeValues", deserializeValues));
localVarHeaderParams.putAll(additionalHeaders);
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
TypeReference> localVarReturnType = new TypeReference>() {};
return apiClient.invokeAPI(
localVarPath,
"GET",
localVarQueryParams,
localVarCollectionQueryParams,
localVarQueryStringJoiner.toString(),
localVarPostBody,
localVarHeaderParams,
localVarCookieParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType
);
}
/**
* 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.
* @param id The id of the task to set variables for. (required)
* @param patchVariablesDto (optional)
* @throws ApiException if fails to make API call
*/
public void modifyTaskLocalVariables(String id, PatchVariablesDto patchVariablesDto) throws ApiException {
this.modifyTaskLocalVariables(id, patchVariablesDto, Collections.emptyMap());
}
/**
* 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.
* @param id The id of the task to set variables for. (required)
* @param patchVariablesDto (optional)
* @param additionalHeaders additionalHeaders for this call
* @throws ApiException if fails to make API call
*/
public void modifyTaskLocalVariables(String id, PatchVariablesDto patchVariablesDto, Map additionalHeaders) throws ApiException {
Object localVarPostBody = patchVariablesDto;
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException(400, "Missing the required parameter 'id' when calling modifyTaskLocalVariables");
}
// create path and map variables
String localVarPath = "/task/{id}/localVariables"
.replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString()));
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarHeaderParams.putAll(additionalHeaders);
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
apiClient.invokeAPI(
localVarPath,
"POST",
localVarQueryParams,
localVarCollectionQueryParams,
localVarQueryStringJoiner.toString(),
localVarPostBody,
localVarHeaderParams,
localVarCookieParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
null
);
}
/**
* Update Local Task Variable
* Sets a variable in the context of a given task.
* @param id The id of the task to set the variable for. (required)
* @param varName The name of the variable to set. (required)
* @param variableValueDto (optional)
* @throws ApiException if fails to make API call
*/
public void putTaskLocalVariable(String id, String varName, VariableValueDto variableValueDto) throws ApiException {
this.putTaskLocalVariable(id, varName, variableValueDto, Collections.emptyMap());
}
/**
* Update Local Task Variable
* Sets a variable in the context of a given task.
* @param id The id of the task to set the variable for. (required)
* @param varName The name of the variable to set. (required)
* @param variableValueDto (optional)
* @param additionalHeaders additionalHeaders for this call
* @throws ApiException if fails to make API call
*/
public void putTaskLocalVariable(String id, String varName, VariableValueDto variableValueDto, Map additionalHeaders) throws ApiException {
Object localVarPostBody = variableValueDto;
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException(400, "Missing the required parameter 'id' when calling putTaskLocalVariable");
}
// verify the required parameter 'varName' is set
if (varName == null) {
throw new ApiException(400, "Missing the required parameter 'varName' when calling putTaskLocalVariable");
}
// create path and map variables
String localVarPath = "/task/{id}/localVariables/{varName}"
.replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString()))
.replaceAll("\\{" + "varName" + "\\}", apiClient.escapeString(varName.toString()));
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarHeaderParams.putAll(additionalHeaders);
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
apiClient.invokeAPI(
localVarPath,
"PUT",
localVarQueryParams,
localVarCollectionQueryParams,
localVarQueryStringJoiner.toString(),
localVarPostBody,
localVarHeaderParams,
localVarCookieParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
null
);
}
/**
* Update Local Task Variable (Binary)
* Sets the serialized value for a binary variable or the binary value for a file variable.
* @param id The id of the task to retrieve the variable for. (required)
* @param varName The name of the variable to retrieve. (required)
* @param 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)
* @param 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
*/
public void setBinaryTaskLocalVariable(String id, String varName, File data, String valueType) throws ApiException {
this.setBinaryTaskLocalVariable(id, varName, data, valueType, Collections.emptyMap());
}
/**
* Update Local Task Variable (Binary)
* Sets the serialized value for a binary variable or the binary value for a file variable.
* @param id The id of the task to retrieve the variable for. (required)
* @param varName The name of the variable to retrieve. (required)
* @param 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)
* @param valueType The name of the variable type. Either Bytes for a byte array variable or File for a file variable. (optional)
* @param additionalHeaders additionalHeaders for this call
* @throws ApiException if fails to make API call
*/
public void setBinaryTaskLocalVariable(String id, String varName, File data, String valueType, Map additionalHeaders) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException(400, "Missing the required parameter 'id' when calling setBinaryTaskLocalVariable");
}
// verify the required parameter 'varName' is set
if (varName == null) {
throw new ApiException(400, "Missing the required parameter 'varName' when calling setBinaryTaskLocalVariable");
}
// create path and map variables
String localVarPath = "/task/{id}/localVariables/{varName}/data"
.replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString()))
.replaceAll("\\{" + "varName" + "\\}", apiClient.escapeString(varName.toString()));
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarHeaderParams.putAll(additionalHeaders);
if (data != null)
localVarFormParams.put("data", data);
if (valueType != null)
localVarFormParams.put("valueType", valueType);
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"multipart/form-data"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
apiClient.invokeAPI(
localVarPath,
"POST",
localVarQueryParams,
localVarCollectionQueryParams,
localVarQueryStringJoiner.toString(),
localVarPostBody,
localVarHeaderParams,
localVarCookieParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
null
);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy