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

Class HistoricIdentityLinkLogApi

java.lang.Object

org.camunda.community.rest.client.api.HistoricIdentityLinkLogApi

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

Constructor Summary

Constructors

Constructor	Description
HistoricIdentityLinkLogApi()
HistoricIdentityLinkLogApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
List<HistoricIdentityLinkLogDto>	getHistoricIdentityLinks(String type, String userId, String groupId, OffsetDateTime dateBefore, OffsetDateTime dateAfter, String taskId, String processDefinitionId, String processDefinitionKey, String operationType, String assignerId, String tenantIdIn, Boolean withoutTenantId, String sortBy, String sortOrder, Integer firstResult, Integer maxResults)	Get Identity Link Logs Queries for historic identity link logs that fulfill given parameters.
List<HistoricIdentityLinkLogDto>	getHistoricIdentityLinks(String type, String userId, String groupId, OffsetDateTime dateBefore, OffsetDateTime dateAfter, String taskId, String processDefinitionId, String processDefinitionKey, String operationType, String assignerId, String tenantIdIn, Boolean withoutTenantId, String sortBy, String sortOrder, Integer firstResult, Integer maxResults, Map<String,String> additionalHeaders)	Get Identity Link Logs Queries for historic identity link logs that fulfill given parameters.
CountResultDto	getHistoricIdentityLinksCount(String type, String userId, String groupId, OffsetDateTime dateBefore, OffsetDateTime dateAfter, String taskId, String processDefinitionId, String processDefinitionKey, String operationType, String assignerId, String tenantIdIn, Boolean withoutTenantId)	Get Identity Link Log Count Queries for the number of historic identity link logs that fulfill the given parameters.
CountResultDto	getHistoricIdentityLinksCount(String type, String userId, String groupId, OffsetDateTime dateBefore, OffsetDateTime dateAfter, String taskId, String processDefinitionId, String processDefinitionKey, String operationType, String assignerId, String tenantIdIn, Boolean withoutTenantId, Map<String,String> additionalHeaders)	Get Identity Link Log Count Queries for the number of historic identity link logs that fulfill the given parameters.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Details

HistoricIdentityLinkLogApi

public HistoricIdentityLinkLogApi()

HistoricIdentityLinkLogApi

public HistoricIdentityLinkLogApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHistoricIdentityLinks

public List<HistoricIdentityLinkLogDto> getHistoricIdentityLinks(String type,
 String userId,
 String groupId,
 OffsetDateTime dateBefore,
 OffsetDateTime dateAfter,
 String taskId,
 String processDefinitionId,
 String processDefinitionKey,
 String operationType,
 String assignerId,
 String tenantIdIn,
 Boolean withoutTenantId,
 String sortBy,
 String sortOrder,
 Integer firstResult,
 Integer maxResults)
                                                          throws ApiException

Get Identity Link Logs Queries for historic identity link logs that fulfill given parameters. The size of the result set can be retrieved by using the [Get Identity-Link-Log Count](https://docs.camunda.org/manual/7.21/reference/rest/history/identity-links/get-identity-link-query-count/) method.

Parameters:

type - Restricts to identity links that have the given type (candidate/assignee/owner). (optional)

userId - Restricts to identity links that have the given user id. (optional)

groupId - Restricts to identity links that have the given group id. (optional)

dateBefore - Restricts to identity links that have the time before the given time. (optional)

dateAfter - Restricts to identity links that have the time after the given time. (optional)

taskId - Restricts to identity links that have the given task id. (optional)

processDefinitionId - Restricts to identity links that have the given process definition id. (optional)

processDefinitionKey - Restricts to identity links that have the given process definition key. (optional)

operationType - Restricts to identity links that have the given operationType (add/delete). (optional)

assignerId - Restricts to identity links that have the given assigner id. (optional)

tenantIdIn - Filter by a comma-separated list of tenant ids. (optional)

withoutTenantId - Only include historic identity links that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)

sortBy - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)

sortOrder - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (optional)

firstResult - Pagination of results. Specifies the index of the first result to return. (optional)

maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)

Returns:

List<HistoricIdentityLinkLogDto>

Throws:

ApiException - if fails to make API call

getHistoricIdentityLinks

public List<HistoricIdentityLinkLogDto> getHistoricIdentityLinks(String type,
 String userId,
 String groupId,
 OffsetDateTime dateBefore,
 OffsetDateTime dateAfter,
 String taskId,
 String processDefinitionId,
 String processDefinitionKey,
 String operationType,
 String assignerId,
 String tenantIdIn,
 Boolean withoutTenantId,
 String sortBy,
 String sortOrder,
 Integer firstResult,
 Integer maxResults,
 Map<String,String> additionalHeaders)
                                                          throws ApiException

Get Identity Link Logs Queries for historic identity link logs that fulfill given parameters. The size of the result set can be retrieved by using the [Get Identity-Link-Log Count](https://docs.camunda.org/manual/7.21/reference/rest/history/identity-links/get-identity-link-query-count/) method.

Parameters:

type - Restricts to identity links that have the given type (candidate/assignee/owner). (optional)

userId - Restricts to identity links that have the given user id. (optional)

groupId - Restricts to identity links that have the given group id. (optional)

dateBefore - Restricts to identity links that have the time before the given time. (optional)

dateAfter - Restricts to identity links that have the time after the given time. (optional)

taskId - Restricts to identity links that have the given task id. (optional)

processDefinitionId - Restricts to identity links that have the given process definition id. (optional)

processDefinitionKey - Restricts to identity links that have the given process definition key. (optional)

operationType - Restricts to identity links that have the given operationType (add/delete). (optional)

assignerId - Restricts to identity links that have the given assigner id. (optional)

tenantIdIn - Filter by a comma-separated list of tenant ids. (optional)

withoutTenantId - Only include historic identity links that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)

sortBy - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)

sortOrder - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (optional)

firstResult - Pagination of results. Specifies the index of the first result to return. (optional)

maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)

additionalHeaders - additionalHeaders for this call

Returns:

List<HistoricIdentityLinkLogDto>

Throws:

ApiException - if fails to make API call

getHistoricIdentityLinksCount

public CountResultDto getHistoricIdentityLinksCount(String type,
 String userId,
 String groupId,
 OffsetDateTime dateBefore,
 OffsetDateTime dateAfter,
 String taskId,
 String processDefinitionId,
 String processDefinitionKey,
 String operationType,
 String assignerId,
 String tenantIdIn,
 Boolean withoutTenantId)
                                             throws ApiException

Get Identity Link Log Count Queries for the number of historic identity link logs that fulfill the given parameters. Takes the same parameters as the [Get Identity-Link-Logs](https://docs.camunda.org/manual/7.21/reference/rest/history/identity-links/get-identity-link-query/) method.

Parameters:

type - Restricts to identity links that have the given type (candidate/assignee/owner). (optional)

userId - Restricts to identity links that have the given user id. (optional)

groupId - Restricts to identity links that have the given group id. (optional)

dateBefore - Restricts to identity links that have the time before the given time. (optional)

dateAfter - Restricts to identity links that have the time after the given time. (optional)

taskId - Restricts to identity links that have the given task id. (optional)

processDefinitionId - Restricts to identity links that have the given process definition id. (optional)

processDefinitionKey - Restricts to identity links that have the given process definition key. (optional)

operationType - Restricts to identity links that have the given operationType (add/delete). (optional)

assignerId - Restricts to identity links that have the given assigner id. (optional)

tenantIdIn - Filter by a comma-separated list of tenant ids. (optional)

withoutTenantId - Only include historic identity links that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)

Returns:

CountResultDto

Throws:

ApiException - if fails to make API call

getHistoricIdentityLinksCount

public CountResultDto getHistoricIdentityLinksCount(String type,
 String userId,
 String groupId,
 OffsetDateTime dateBefore,
 OffsetDateTime dateAfter,
 String taskId,
 String processDefinitionId,
 String processDefinitionKey,
 String operationType,
 String assignerId,
 String tenantIdIn,
 Boolean withoutTenantId,
 Map<String,String> additionalHeaders)
                                             throws ApiException

Get Identity Link Log Count Queries for the number of historic identity link logs that fulfill the given parameters. Takes the same parameters as the [Get Identity-Link-Logs](https://docs.camunda.org/manual/7.21/reference/rest/history/identity-links/get-identity-link-query/) method.

Parameters:

type - Restricts to identity links that have the given type (candidate/assignee/owner). (optional)

userId - Restricts to identity links that have the given user id. (optional)

groupId - Restricts to identity links that have the given group id. (optional)

dateBefore - Restricts to identity links that have the time before the given time. (optional)

dateAfter - Restricts to identity links that have the time after the given time. (optional)

taskId - Restricts to identity links that have the given task id. (optional)

processDefinitionId - Restricts to identity links that have the given process definition id. (optional)

processDefinitionKey - Restricts to identity links that have the given process definition key. (optional)

operationType - Restricts to identity links that have the given operationType (add/delete). (optional)

assignerId - Restricts to identity links that have the given assigner id. (optional)

tenantIdIn - Filter by a comma-separated list of tenant ids. (optional)

withoutTenantId - Only include historic identity links that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)

additionalHeaders - additionalHeaders for this call

Returns:

CountResultDto

Throws:

ApiException - if fails to make API call