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

Class HistoricExternalTaskLogApi

java.lang.Object
org.camunda.community.rest.client.api.HistoricExternalTaskLogApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-06-04T13:43:01.451833574Z[Etc/UTC]") public class HistoricExternalTaskLogApi extends Object

  • Constructor Details

    • HistoricExternalTaskLogApi

      public HistoricExternalTaskLogApi()

    • HistoricExternalTaskLogApi

      public HistoricExternalTaskLogApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • getErrorDetailsHistoricExternalTaskLog

      public Object getErrorDetailsHistoricExternalTaskLog(String id) throws ApiException
      Get External Task Log Error Details Retrieves the corresponding error details of the passed historic external task log by id.
      Parameters:
      id - The id of the historic external task log to get the error details for. (required)
      Returns:
      Object
      Throws:
      ApiException - if fails to make API call

    • getErrorDetailsHistoricExternalTaskLog

      public Object getErrorDetailsHistoricExternalTaskLog(String id, Map<String,String> additionalHeaders) throws ApiException
      Get External Task Log Error Details Retrieves the corresponding error details of the passed historic external task log by id.
      Parameters:
      id - The id of the historic external task log to get the error details for. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      Object
      Throws:
      ApiException - if fails to make API call

    • getHistoricExternalTaskLog

      public HistoricExternalTaskLogDto getHistoricExternalTaskLog(String id) throws ApiException
      Get External Task Log Retrieves a historic external task log by id.
      Parameters:
      id - The id of the log entry. (required)
      Returns:
      HistoricExternalTaskLogDto
      Throws:
      ApiException - if fails to make API call

    • getHistoricExternalTaskLog

      public HistoricExternalTaskLogDto getHistoricExternalTaskLog(String id, Map<String,String> additionalHeaders) throws ApiException
      Get External Task Log Retrieves a historic external task log by id.
      Parameters:
      id - The id of the log entry. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      HistoricExternalTaskLogDto
      Throws:
      ApiException - if fails to make API call

    • getHistoricExternalTaskLogs

      public List<HistoricExternalTaskLogDto> getHistoricExternalTaskLogs(String logId, String externalTaskId, String topicName, String workerId, String errorMessage, String activityIdIn, String activityInstanceIdIn, String executionIdIn, String processInstanceId, String processDefinitionId, String processDefinitionKey, String tenantIdIn, Boolean withoutTenantId, Long priorityLowerThanOrEquals, Long priorityHigherThanOrEquals, Boolean creationLog, Boolean failureLog, Boolean successLog, Boolean deletionLog, String sortBy, String sortOrder, Integer firstResult, Integer maxResults) throws ApiException
      Get External Task Logs Queries for historic external task logs that fulfill the given parameters. The size of the result set can be retrieved by using the [Get External Task Log Count](https://docs.camunda.org/manual/7.21/reference/rest/history/external-task-log/get-external-task-log-query-count/) method.
      Parameters:
      logId - Filter by historic external task log id. (optional)
      externalTaskId - Filter by external task id. (optional)
      topicName - Filter by an external task topic. (optional)
      workerId - Filter by the id of the worker that the task was most recently locked by. (optional)
      errorMessage - Filter by external task exception message. (optional)
      activityIdIn - Only include historic external task logs which belong to one of the passed activity ids. (optional)
      activityInstanceIdIn - Only include historic external task logs which belong to one of the passed activity instance ids. (optional)
      executionIdIn - Only include historic external task logs which belong to one of the passed execution ids. (optional)
      processInstanceId - Filter by process instance id. (optional)
      processDefinitionId - Filter by process definition id. (optional)
      processDefinitionKey - Filter by process definition key. (optional)
      tenantIdIn - Only include historic external task log entries which belong to one of the passed and comma-separated tenant ids. (optional)
      withoutTenantId - Only include historic external task log entries that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
      priorityLowerThanOrEquals - Only include logs for which the associated external task had a priority lower than or equal to the given value. Value must be a valid `long` value. (optional)
      priorityHigherThanOrEquals - Only include logs for which the associated external task had a priority higher than or equal to the given value. Value must be a valid `long` value. (optional)
      creationLog - Only include creation logs. Value may only be `true`, as `false` is the default behavior. (optional)
      failureLog - Only include failure logs. Value may only be `true`, as `false` is the default behavior. (optional)
      successLog - Only include success logs. Value may only be `true`, as `false` is the default behavior. (optional)
      deletionLog - Only include deletion logs. 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<HistoricExternalTaskLogDto>
      Throws:
      ApiException - if fails to make API call

    • getHistoricExternalTaskLogs

      public List<HistoricExternalTaskLogDto> getHistoricExternalTaskLogs(String logId, String externalTaskId, String topicName, String workerId, String errorMessage, String activityIdIn, String activityInstanceIdIn, String executionIdIn, String processInstanceId, String processDefinitionId, String processDefinitionKey, String tenantIdIn, Boolean withoutTenantId, Long priorityLowerThanOrEquals, Long priorityHigherThanOrEquals, Boolean creationLog, Boolean failureLog, Boolean successLog, Boolean deletionLog, String sortBy, String sortOrder, Integer firstResult, Integer maxResults, Map<String,String> additionalHeaders) throws ApiException
      Get External Task Logs Queries for historic external task logs that fulfill the given parameters. The size of the result set can be retrieved by using the [Get External Task Log Count](https://docs.camunda.org/manual/7.21/reference/rest/history/external-task-log/get-external-task-log-query-count/) method.
      Parameters:
      logId - Filter by historic external task log id. (optional)
      externalTaskId - Filter by external task id. (optional)
      topicName - Filter by an external task topic. (optional)
      workerId - Filter by the id of the worker that the task was most recently locked by. (optional)
      errorMessage - Filter by external task exception message. (optional)
      activityIdIn - Only include historic external task logs which belong to one of the passed activity ids. (optional)
      activityInstanceIdIn - Only include historic external task logs which belong to one of the passed activity instance ids. (optional)
      executionIdIn - Only include historic external task logs which belong to one of the passed execution ids. (optional)
      processInstanceId - Filter by process instance id. (optional)
      processDefinitionId - Filter by process definition id. (optional)
      processDefinitionKey - Filter by process definition key. (optional)
      tenantIdIn - Only include historic external task log entries which belong to one of the passed and comma-separated tenant ids. (optional)
      withoutTenantId - Only include historic external task log entries that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
      priorityLowerThanOrEquals - Only include logs for which the associated external task had a priority lower than or equal to the given value. Value must be a valid `long` value. (optional)
      priorityHigherThanOrEquals - Only include logs for which the associated external task had a priority higher than or equal to the given value. Value must be a valid `long` value. (optional)
      creationLog - Only include creation logs. Value may only be `true`, as `false` is the default behavior. (optional)
      failureLog - Only include failure logs. Value may only be `true`, as `false` is the default behavior. (optional)
      successLog - Only include success logs. Value may only be `true`, as `false` is the default behavior. (optional)
      deletionLog - Only include deletion logs. 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<HistoricExternalTaskLogDto>
      Throws:
      ApiException - if fails to make API call

    • getHistoricExternalTaskLogsCount

      public CountResultDto getHistoricExternalTaskLogsCount(String logId, String externalTaskId, String topicName, String workerId, String errorMessage, String activityIdIn, String activityInstanceIdIn, String executionIdIn, String processInstanceId, String processDefinitionId, String processDefinitionKey, String tenantIdIn, Boolean withoutTenantId, Long priorityLowerThanOrEquals, Long priorityHigherThanOrEquals, Boolean creationLog, Boolean failureLog, Boolean successLog, Boolean deletionLog) throws ApiException
      Get External Task Log Count Queries for the number of historic external task logs that fulfill the given parameters. Takes the same parameters as the [Get External Task Logs](https://docs.camunda.org/manual/7.21/reference/rest/history/external-task-log/get-external-task-log-query/) method.
      Parameters:
      logId - Filter by historic external task log id. (optional)
      externalTaskId - Filter by external task id. (optional)
      topicName - Filter by an external task topic. (optional)
      workerId - Filter by the id of the worker that the task was most recently locked by. (optional)
      errorMessage - Filter by external task exception message. (optional)
      activityIdIn - Only include historic external task logs which belong to one of the passed activity ids. (optional)
      activityInstanceIdIn - Only include historic external task logs which belong to one of the passed activity instance ids. (optional)
      executionIdIn - Only include historic external task logs which belong to one of the passed execution ids. (optional)
      processInstanceId - Filter by process instance id. (optional)
      processDefinitionId - Filter by process definition id. (optional)
      processDefinitionKey - Filter by process definition key. (optional)
      tenantIdIn - Only include historic external task log entries which belong to one of the passed and comma-separated tenant ids. (optional)
      withoutTenantId - Only include historic external task log entries that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
      priorityLowerThanOrEquals - Only include logs for which the associated external task had a priority lower than or equal to the given value. Value must be a valid `long` value. (optional)
      priorityHigherThanOrEquals - Only include logs for which the associated external task had a priority higher than or equal to the given value. Value must be a valid `long` value. (optional)
      creationLog - Only include creation logs. Value may only be `true`, as `false` is the default behavior. (optional)
      failureLog - Only include failure logs. Value may only be `true`, as `false` is the default behavior. (optional)
      successLog - Only include success logs. Value may only be `true`, as `false` is the default behavior. (optional)
      deletionLog - Only include deletion logs. Value may only be `true`, as `false` is the default behavior. (optional)
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • getHistoricExternalTaskLogsCount

      public CountResultDto getHistoricExternalTaskLogsCount(String logId, String externalTaskId, String topicName, String workerId, String errorMessage, String activityIdIn, String activityInstanceIdIn, String executionIdIn, String processInstanceId, String processDefinitionId, String processDefinitionKey, String tenantIdIn, Boolean withoutTenantId, Long priorityLowerThanOrEquals, Long priorityHigherThanOrEquals, Boolean creationLog, Boolean failureLog, Boolean successLog, Boolean deletionLog, Map<String,String> additionalHeaders) throws ApiException
      Get External Task Log Count Queries for the number of historic external task logs that fulfill the given parameters. Takes the same parameters as the [Get External Task Logs](https://docs.camunda.org/manual/7.21/reference/rest/history/external-task-log/get-external-task-log-query/) method.
      Parameters:
      logId - Filter by historic external task log id. (optional)
      externalTaskId - Filter by external task id. (optional)
      topicName - Filter by an external task topic. (optional)
      workerId - Filter by the id of the worker that the task was most recently locked by. (optional)
      errorMessage - Filter by external task exception message. (optional)
      activityIdIn - Only include historic external task logs which belong to one of the passed activity ids. (optional)
      activityInstanceIdIn - Only include historic external task logs which belong to one of the passed activity instance ids. (optional)
      executionIdIn - Only include historic external task logs which belong to one of the passed execution ids. (optional)
      processInstanceId - Filter by process instance id. (optional)
      processDefinitionId - Filter by process definition id. (optional)
      processDefinitionKey - Filter by process definition key. (optional)
      tenantIdIn - Only include historic external task log entries which belong to one of the passed and comma-separated tenant ids. (optional)
      withoutTenantId - Only include historic external task log entries that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
      priorityLowerThanOrEquals - Only include logs for which the associated external task had a priority lower than or equal to the given value. Value must be a valid `long` value. (optional)
      priorityHigherThanOrEquals - Only include logs for which the associated external task had a priority higher than or equal to the given value. Value must be a valid `long` value. (optional)
      creationLog - Only include creation logs. Value may only be `true`, as `false` is the default behavior. (optional)
      failureLog - Only include failure logs. Value may only be `true`, as `false` is the default behavior. (optional)
      successLog - Only include success logs. Value may only be `true`, as `false` is the default behavior. (optional)
      deletionLog - Only include deletion logs. 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

    • queryHistoricExternalTaskLogs

      public List<HistoricExternalTaskLogDto> queryHistoricExternalTaskLogs(HistoricExternalTaskLogQueryDto historicExternalTaskLogQueryDto) throws ApiException
      Get External Task Logs (POST) Queries for historic external task logs that fulfill the given parameters. This method is slightly more powerful than the [Get External Task Logs](https://docs.camunda.org/manual/7.21/reference/rest/history/external-task-log/get-external-task-log-query/) method because it allows filtering by historic external task logs values of the different types `String`, `Number` or `Boolean`.
      Parameters:
      historicExternalTaskLogQueryDto - (optional)
      Returns:
      List<HistoricExternalTaskLogDto>
      Throws:
      ApiException - if fails to make API call

    • queryHistoricExternalTaskLogs

      public List<HistoricExternalTaskLogDto> queryHistoricExternalTaskLogs(HistoricExternalTaskLogQueryDto historicExternalTaskLogQueryDto, Map<String,String> additionalHeaders) throws ApiException
      Get External Task Logs (POST) Queries for historic external task logs that fulfill the given parameters. This method is slightly more powerful than the [Get External Task Logs](https://docs.camunda.org/manual/7.21/reference/rest/history/external-task-log/get-external-task-log-query/) method because it allows filtering by historic external task logs values of the different types `String`, `Number` or `Boolean`.
      Parameters:
      historicExternalTaskLogQueryDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<HistoricExternalTaskLogDto>
      Throws:
      ApiException - if fails to make API call

    • queryHistoricExternalTaskLogsCount

      public CountResultDto queryHistoricExternalTaskLogsCount(HistoricExternalTaskLogQueryDto historicExternalTaskLogQueryDto) throws ApiException
      Get External Task Log Count (POST) Queries for the number of historic external task logs that fulfill the given parameters. This method takes the same message body as the [Get External Task Logs (POST)](https://docs.camunda.org/manual/7.21/reference/rest/history/external-task-log/post-external-task-log-query/) method and therefore it is slightly more powerful than the [Get External Task Log Count](https://docs.camunda.org/manual/7.21/reference/rest/history/external-task-log/get-external-task-log-query-count/) method.
      Parameters:
      historicExternalTaskLogQueryDto - (optional)
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • queryHistoricExternalTaskLogsCount

      public CountResultDto queryHistoricExternalTaskLogsCount(HistoricExternalTaskLogQueryDto historicExternalTaskLogQueryDto, Map<String,String> additionalHeaders) throws ApiException
      Get External Task Log Count (POST) Queries for the number of historic external task logs that fulfill the given parameters. This method takes the same message body as the [Get External Task Logs (POST)](https://docs.camunda.org/manual/7.21/reference/rest/history/external-task-log/post-external-task-log-query/) method and therefore it is slightly more powerful than the [Get External Task Log Count](https://docs.camunda.org/manual/7.21/reference/rest/history/external-task-log/get-external-task-log-query-count/) method.
      Parameters:
      historicExternalTaskLogQueryDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call