Package io.camunda.tasklist.generated.api

Class VariablesApi

java.lang.Object

io.camunda.tasklist.generated.invoker.BaseApi

io.camunda.tasklist.generated.api.VariablesApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-10-29T10:52:23.981575172Z[Etc/UTC]",
           comments="Generator version: 7.8.0")
public class VariablesApi
extends BaseApi

Field Summary

Fields inherited from class io.camunda.tasklist.generated.invoker.BaseApi

apiClient

Constructor Summary

Constructors

Constructor	Description
VariablesApi()
VariablesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
VariableResponse	getVariableById(String variableId)	Get a variable Get the variable details by variable id.
VariableResponse	getVariableById(String variableId, Map<String,String> additionalHeaders)	Get a variable Get the variable details by variable id.
<T> T	invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String,String> additionalHeaders)	Directly invoke the API for the given URL.

Methods inherited from class io.camunda.tasklist.generated.invoker.BaseApi

getApiClient, invokeAPI, invokeAPI, invokeAPI, invokeAPI, invokeAPI, invokeAPI, setApiClient

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

VariablesApi

public VariablesApi()

VariablesApi

public VariablesApi(ApiClient apiClient)

Method Details

getVariableById

public VariableResponse getVariableById(String variableId)
                                 throws ApiException

Get a variable Get the variable details by variable id.

Parameters:

variableId - The ID of the variable. (required)

Returns:

VariableResponse

Throws:

ApiException - if fails to make API call

getVariableById

public VariableResponse getVariableById(String variableId,
 Map<String,String> additionalHeaders)
                                 throws ApiException

Get a variable Get the variable details by variable id.

Parameters:

variableId - The ID of the variable. (required)

additionalHeaders - additionalHeaders for this call

Returns:

VariableResponse

Throws:

ApiException - if fails to make API call

invokeAPI

public <T> T invokeAPI(String url,
 String method,
 Object request,
 com.fasterxml.jackson.core.type.TypeReference<T> returnType,
 Map<String,String> additionalHeaders)
                throws ApiException

Description copied from class: BaseApi

Directly invoke the API for the given URL. Useful if the API returns direct links/URLs for subsequent requests.

Specified by:

invokeAPI in class BaseApi

Parameters:

url - The URL for the request, either full URL or only the path.

method - The HTTP method for the request.

request - The request object.

returnType - The return type.

additionalHeaders - Additional headers for the request.

Returns:

The API response in the specified type.

Throws:

ApiException - if fails to make API call.