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

Class TaskIdentityLinkApi

java.lang.Object

org.camunda.community.rest.client.api.TaskIdentityLinkApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-06-04T13:43:01.451833574Z[Etc/UTC]")
public class TaskIdentityLinkApi
extends Object

Constructor Summary

Constructors

Constructor	Description
TaskIdentityLinkApi()
TaskIdentityLinkApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
void	addIdentityLink(String id, IdentityLinkDto identityLinkDto)	Add Adds an identity link to a task by id.
void	addIdentityLink(String id, IdentityLinkDto identityLinkDto, Map<String,String> additionalHeaders)	Add Adds an identity link to a task by id.
void	deleteIdentityLink(String id, IdentityLinkDto identityLinkDto)	Delete Removes an identity link from a task by id
void	deleteIdentityLink(String id, IdentityLinkDto identityLinkDto, Map<String,String> additionalHeaders)	Delete Removes an identity link from a task by id
ApiClient	getApiClient()
List<IdentityLinkDto>	getIdentityLinks(String id, String type)	Get List Gets the identity links for a task by id, which are the users and groups that are in *some* relation to it (including assignee and owner).
List<IdentityLinkDto>	getIdentityLinks(String id, String type, Map<String,String> additionalHeaders)	Get List Gets the identity links for a task by id, which are the users and groups that are in *some* relation to it (including assignee and owner).
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Details

TaskIdentityLinkApi

public TaskIdentityLinkApi()

TaskIdentityLinkApi

public TaskIdentityLinkApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

addIdentityLink

public void addIdentityLink(String id,
 IdentityLinkDto identityLinkDto)
                     throws ApiException

Add Adds an identity link to a task by id. Can be used to link any user or group to a task and specify a relation.

Parameters:

id - The id of the task to add a link to. (required)

identityLinkDto - (optional)

Throws:

ApiException - if fails to make API call

addIdentityLink

public void addIdentityLink(String id,
 IdentityLinkDto identityLinkDto,
 Map<String,String> additionalHeaders)
                     throws ApiException

Add Adds an identity link to a task by id. Can be used to link any user or group to a task and specify a relation.

Parameters:

id - The id of the task to add a link to. (required)

identityLinkDto - (optional)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

deleteIdentityLink

public void deleteIdentityLink(String id,
 IdentityLinkDto identityLinkDto)
                        throws ApiException

Delete Removes an identity link from a task by id

Parameters:

id - The id of the task to remove a link from. (required)

identityLinkDto - (optional)

Throws:

ApiException - if fails to make API call

deleteIdentityLink

public void deleteIdentityLink(String id,
 IdentityLinkDto identityLinkDto,
 Map<String,String> additionalHeaders)
                        throws ApiException

Delete Removes an identity link from a task by id

Parameters:

id - The id of the task to remove a link from. (required)

identityLinkDto - (optional)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getIdentityLinks

public List<IdentityLinkDto> getIdentityLinks(String id,
 String type)
                                       throws ApiException

Get List Gets the identity links for a task by id, which are the users and groups that are in *some* relation to it (including assignee and owner).

Parameters:

id - The id of the task to retrieve the identity links for. (required)

type - Filter by the type of links to include. (optional)

Returns:

List<IdentityLinkDto>

Throws:

ApiException - if fails to make API call

getIdentityLinks

public List<IdentityLinkDto> getIdentityLinks(String id,
 String type,
 Map<String,String> additionalHeaders)
                                       throws ApiException

Get List Gets the identity links for a task by id, which are the users and groups that are in *some* relation to it (including assignee and owner).

Parameters:

id - The id of the task to retrieve the identity links for. (required)

type - Filter by the type of links to include. (optional)

additionalHeaders - additionalHeaders for this call

Returns:

List<IdentityLinkDto>

Throws:

ApiException - if fails to make API call