Package io.camunda.tasklist.generated.api

Class FormApi

java.lang.Object

io.camunda.tasklist.generated.invoker.BaseApi

io.camunda.tasklist.generated.api.FormApi

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

Field Summary

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

apiClient

Constructor Summary

Constructors

Constructor	Description
FormApi()
FormApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
FormResponse	getForm(String formId, String processDefinitionKey, Long version)	Get a form Get the form details by `formId` and `processDefinitionKey` required query param.
FormResponse	getForm(String formId, String processDefinitionKey, Long version, Map<String,String> additionalHeaders)	Get a form Get the form details by `formId` and `processDefinitionKey` required query param.
<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

FormApi

public FormApi()

FormApi

public FormApi(ApiClient apiClient)

Method Details

getForm

public FormResponse getForm(String formId,
 String processDefinitionKey,
 Long version)
                     throws ApiException

Get a form Get the form details by `formId` and `processDefinitionKey` required query param. The `version` query param is optional and is used only for deployed forms (if empty, it retrieves the highest version).

Parameters:

formId - The ID of the form. (required)

processDefinitionKey - Reference to the process definition. (required)

version - The version of the form. Valid only for deployed forms. (optional)

Returns:

FormResponse

Throws:

ApiException - if fails to make API call

getForm

public FormResponse getForm(String formId,
 String processDefinitionKey,
 Long version,
 Map<String,String> additionalHeaders)
                     throws ApiException

Get a form Get the form details by `formId` and `processDefinitionKey` required query param. The `version` query param is optional and is used only for deployed forms (if empty, it retrieves the highest version).

Parameters:

formId - The ID of the form. (required)

processDefinitionKey - Reference to the process definition. (required)

version - The version of the form. Valid only for deployed forms. (optional)

additionalHeaders - additionalHeaders for this call

Returns:

FormResponse

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.