Package org.openapitools.client.api
Class HistoricIncidentApi
- java.lang.Object
-
- org.openapitools.client.api.HistoricIncidentApi
-
public class HistoricIncidentApi extends Object
-
-
Constructor Summary
Constructors Constructor Description HistoricIncidentApi()HistoricIncidentApi(ApiClient apiClient)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ApiClientgetApiClient()List<HistoricIncidentDto>getHistoricIncidents(String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String processDefinitionId, String processDefinitionKey, String processDefinitionKeyIn, String processInstanceId, String executionId, Date createTimeBefore, Date createTimeAfter, Date endTimeBefore, Date endTimeAfter, String activityId, String failedActivityId, String causeIncidentId, String rootCauseIncidentId, String _configuration, String historyConfiguration, Boolean open, Boolean resolved, Boolean deleted, String tenantIdIn, Boolean withoutTenantId, String jobDefinitionIdIn, String sortBy, String sortOrder)Get Incidents Queries for historic incidents that fulfill given parameters.okhttp3.CallgetHistoricIncidentsAsync(String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String processDefinitionId, String processDefinitionKey, String processDefinitionKeyIn, String processInstanceId, String executionId, Date createTimeBefore, Date createTimeAfter, Date endTimeBefore, Date endTimeAfter, String activityId, String failedActivityId, String causeIncidentId, String rootCauseIncidentId, String _configuration, String historyConfiguration, Boolean open, Boolean resolved, Boolean deleted, String tenantIdIn, Boolean withoutTenantId, String jobDefinitionIdIn, String sortBy, String sortOrder, ApiCallback<List<HistoricIncidentDto>> _callback)Get Incidents (asynchronously) Queries for historic incidents that fulfill given parameters.okhttp3.CallgetHistoricIncidentsCall(String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String processDefinitionId, String processDefinitionKey, String processDefinitionKeyIn, String processInstanceId, String executionId, Date createTimeBefore, Date createTimeAfter, Date endTimeBefore, Date endTimeAfter, String activityId, String failedActivityId, String causeIncidentId, String rootCauseIncidentId, String _configuration, String historyConfiguration, Boolean open, Boolean resolved, Boolean deleted, String tenantIdIn, Boolean withoutTenantId, String jobDefinitionIdIn, String sortBy, String sortOrder, ApiCallback _callback)Build call for getHistoricIncidentsCountResultDtogetHistoricIncidentsCount(String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String processDefinitionId, String processDefinitionKey, String processDefinitionKeyIn, String processInstanceId, String executionId, Date createTimeBefore, Date createTimeAfter, Date endTimeBefore, Date endTimeAfter, String activityId, String failedActivityId, String causeIncidentId, String rootCauseIncidentId, String _configuration, String historyConfiguration, Boolean open, Boolean resolved, Boolean deleted, String tenantIdIn, Boolean withoutTenantId, String jobDefinitionIdIn, String sortBy, String sortOrder)Get Incident Count Queries for the number of historic incidents that fulfill the given parameters.okhttp3.CallgetHistoricIncidentsCountAsync(String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String processDefinitionId, String processDefinitionKey, String processDefinitionKeyIn, String processInstanceId, String executionId, Date createTimeBefore, Date createTimeAfter, Date endTimeBefore, Date endTimeAfter, String activityId, String failedActivityId, String causeIncidentId, String rootCauseIncidentId, String _configuration, String historyConfiguration, Boolean open, Boolean resolved, Boolean deleted, String tenantIdIn, Boolean withoutTenantId, String jobDefinitionIdIn, String sortBy, String sortOrder, ApiCallback<CountResultDto> _callback)Get Incident Count (asynchronously) Queries for the number of historic incidents that fulfill the given parameters.okhttp3.CallgetHistoricIncidentsCountCall(String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String processDefinitionId, String processDefinitionKey, String processDefinitionKeyIn, String processInstanceId, String executionId, Date createTimeBefore, Date createTimeAfter, Date endTimeBefore, Date endTimeAfter, String activityId, String failedActivityId, String causeIncidentId, String rootCauseIncidentId, String _configuration, String historyConfiguration, Boolean open, Boolean resolved, Boolean deleted, String tenantIdIn, Boolean withoutTenantId, String jobDefinitionIdIn, String sortBy, String sortOrder, ApiCallback _callback)Build call for getHistoricIncidentsCountApiResponse<CountResultDto>getHistoricIncidentsCountWithHttpInfo(String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String processDefinitionId, String processDefinitionKey, String processDefinitionKeyIn, String processInstanceId, String executionId, Date createTimeBefore, Date createTimeAfter, Date endTimeBefore, Date endTimeAfter, String activityId, String failedActivityId, String causeIncidentId, String rootCauseIncidentId, String _configuration, String historyConfiguration, Boolean open, Boolean resolved, Boolean deleted, String tenantIdIn, Boolean withoutTenantId, String jobDefinitionIdIn, String sortBy, String sortOrder)Get Incident Count Queries for the number of historic incidents that fulfill the given parameters.ApiResponse<List<HistoricIncidentDto>>getHistoricIncidentsWithHttpInfo(String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String processDefinitionId, String processDefinitionKey, String processDefinitionKeyIn, String processInstanceId, String executionId, Date createTimeBefore, Date createTimeAfter, Date endTimeBefore, Date endTimeAfter, String activityId, String failedActivityId, String causeIncidentId, String rootCauseIncidentId, String _configuration, String historyConfiguration, Boolean open, Boolean resolved, Boolean deleted, String tenantIdIn, Boolean withoutTenantId, String jobDefinitionIdIn, String sortBy, String sortOrder)Get Incidents Queries for historic incidents that fulfill given parameters.voidsetApiClient(ApiClient apiClient)
-
-
-
Constructor Detail
-
HistoricIncidentApi
public HistoricIncidentApi()
-
HistoricIncidentApi
public HistoricIncidentApi(ApiClient apiClient)
-
-
Method Detail
-
getApiClient
public ApiClient getApiClient()
-
setApiClient
public void setApiClient(ApiClient apiClient)
-
getHistoricIncidentsCall
public okhttp3.Call getHistoricIncidentsCall(String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String processDefinitionId, String processDefinitionKey, String processDefinitionKeyIn, String processInstanceId, String executionId, Date createTimeBefore, Date createTimeAfter, Date endTimeBefore, Date endTimeAfter, String activityId, String failedActivityId, String causeIncidentId, String rootCauseIncidentId, String _configuration, String historyConfiguration, Boolean open, Boolean resolved, Boolean deleted, String tenantIdIn, Boolean withoutTenantId, String jobDefinitionIdIn, String sortBy, String sortOrder, ApiCallback _callback) throws ApiException
Build call for getHistoricIncidents- Parameters:
incidentId- Restricts to incidents that have the given id. (optional)incidentType- Restricts to incidents that belong to the given incident type. See the [User Guide](/manual/develop/user-guide/process-engine/incidents/#incident-types) for a list of incident types. (optional)incidentMessage- Restricts to incidents that have the given incident message. (optional)incidentMessageLike- Restricts to incidents that incidents message is a substring of the given value. The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%). (optional)processDefinitionId- Restricts to incidents that belong to a process definition with the given id. (optional)processDefinitionKey- Restricts to incidents that have the given processDefinitionKey. (optional)processDefinitionKeyIn- Restricts to incidents that have one of the given process definition keys. (optional)processInstanceId- Restricts to incidents that belong to a process instance with the given id. (optional)executionId- Restricts to incidents that belong to an execution with the given id. (optional)createTimeBefore- Restricts to incidents that have a createTime date before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)createTimeAfter- Restricts to incidents that have a createTime date after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)endTimeBefore- Restricts to incidents that have an endTimeBefore date before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)endTimeAfter- Restricts to incidents that have an endTimeAfter date after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)activityId- Restricts to incidents that belong to an activity with the given id. (optional)failedActivityId- Restricts to incidents that were created due to the failure of an activity with the given id. (optional)causeIncidentId- Restricts to incidents that have the given incident id as cause incident. (optional)rootCauseIncidentId- Restricts to incidents that have the given incident id as root cause incident. (optional)_configuration- Restricts to incidents that have the given parameter set as configuration. (optional)historyConfiguration- Restricts to incidents that have the given parameter set as history configuration. (optional)open- Restricts to incidents that are open. (optional)resolved- Restricts to incidents that are resolved. (optional)deleted- Restricts to incidents that are deleted. (optional)tenantIdIn- Restricts to incidents that have one of the given comma-separated tenant ids. (optional)withoutTenantId- Only include historic incidents that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)jobDefinitionIdIn- Restricts to incidents that have one of the given comma-separated job definition ids. (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)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
getHistoricIncidents
public List<HistoricIncidentDto> getHistoricIncidents(String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String processDefinitionId, String processDefinitionKey, String processDefinitionKeyIn, String processInstanceId, String executionId, Date createTimeBefore, Date createTimeAfter, Date endTimeBefore, Date endTimeAfter, String activityId, String failedActivityId, String causeIncidentId, String rootCauseIncidentId, String _configuration, String historyConfiguration, Boolean open, Boolean resolved, Boolean deleted, String tenantIdIn, Boolean withoutTenantId, String jobDefinitionIdIn, String sortBy, String sortOrder) throws ApiException
Get Incidents Queries for historic incidents that fulfill given parameters. The size of the result set can be retrieved by using the [Get Incident Count](https://docs.camunda.org/manual/7.18/reference/rest/history/incident/get-incident-query-count/) method.- Parameters:
incidentId- Restricts to incidents that have the given id. (optional)incidentType- Restricts to incidents that belong to the given incident type. See the [User Guide](/manual/develop/user-guide/process-engine/incidents/#incident-types) for a list of incident types. (optional)incidentMessage- Restricts to incidents that have the given incident message. (optional)incidentMessageLike- Restricts to incidents that incidents message is a substring of the given value. The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%). (optional)processDefinitionId- Restricts to incidents that belong to a process definition with the given id. (optional)processDefinitionKey- Restricts to incidents that have the given processDefinitionKey. (optional)processDefinitionKeyIn- Restricts to incidents that have one of the given process definition keys. (optional)processInstanceId- Restricts to incidents that belong to a process instance with the given id. (optional)executionId- Restricts to incidents that belong to an execution with the given id. (optional)createTimeBefore- Restricts to incidents that have a createTime date before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)createTimeAfter- Restricts to incidents that have a createTime date after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)endTimeBefore- Restricts to incidents that have an endTimeBefore date before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)endTimeAfter- Restricts to incidents that have an endTimeAfter date after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)activityId- Restricts to incidents that belong to an activity with the given id. (optional)failedActivityId- Restricts to incidents that were created due to the failure of an activity with the given id. (optional)causeIncidentId- Restricts to incidents that have the given incident id as cause incident. (optional)rootCauseIncidentId- Restricts to incidents that have the given incident id as root cause incident. (optional)_configuration- Restricts to incidents that have the given parameter set as configuration. (optional)historyConfiguration- Restricts to incidents that have the given parameter set as history configuration. (optional)open- Restricts to incidents that are open. (optional)resolved- Restricts to incidents that are resolved. (optional)deleted- Restricts to incidents that are deleted. (optional)tenantIdIn- Restricts to incidents that have one of the given comma-separated tenant ids. (optional)withoutTenantId- Only include historic incidents that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)jobDefinitionIdIn- Restricts to incidents that have one of the given comma-separated job definition ids. (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)- Returns:
- List<HistoricIncidentDto>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getHistoricIncidentsWithHttpInfo
public ApiResponse<List<HistoricIncidentDto>> getHistoricIncidentsWithHttpInfo(String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String processDefinitionId, String processDefinitionKey, String processDefinitionKeyIn, String processInstanceId, String executionId, Date createTimeBefore, Date createTimeAfter, Date endTimeBefore, Date endTimeAfter, String activityId, String failedActivityId, String causeIncidentId, String rootCauseIncidentId, String _configuration, String historyConfiguration, Boolean open, Boolean resolved, Boolean deleted, String tenantIdIn, Boolean withoutTenantId, String jobDefinitionIdIn, String sortBy, String sortOrder) throws ApiException
Get Incidents Queries for historic incidents that fulfill given parameters. The size of the result set can be retrieved by using the [Get Incident Count](https://docs.camunda.org/manual/7.18/reference/rest/history/incident/get-incident-query-count/) method.- Parameters:
incidentId- Restricts to incidents that have the given id. (optional)incidentType- Restricts to incidents that belong to the given incident type. See the [User Guide](/manual/develop/user-guide/process-engine/incidents/#incident-types) for a list of incident types. (optional)incidentMessage- Restricts to incidents that have the given incident message. (optional)incidentMessageLike- Restricts to incidents that incidents message is a substring of the given value. The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%). (optional)processDefinitionId- Restricts to incidents that belong to a process definition with the given id. (optional)processDefinitionKey- Restricts to incidents that have the given processDefinitionKey. (optional)processDefinitionKeyIn- Restricts to incidents that have one of the given process definition keys. (optional)processInstanceId- Restricts to incidents that belong to a process instance with the given id. (optional)executionId- Restricts to incidents that belong to an execution with the given id. (optional)createTimeBefore- Restricts to incidents that have a createTime date before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)createTimeAfter- Restricts to incidents that have a createTime date after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)endTimeBefore- Restricts to incidents that have an endTimeBefore date before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)endTimeAfter- Restricts to incidents that have an endTimeAfter date after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)activityId- Restricts to incidents that belong to an activity with the given id. (optional)failedActivityId- Restricts to incidents that were created due to the failure of an activity with the given id. (optional)causeIncidentId- Restricts to incidents that have the given incident id as cause incident. (optional)rootCauseIncidentId- Restricts to incidents that have the given incident id as root cause incident. (optional)_configuration- Restricts to incidents that have the given parameter set as configuration. (optional)historyConfiguration- Restricts to incidents that have the given parameter set as history configuration. (optional)open- Restricts to incidents that are open. (optional)resolved- Restricts to incidents that are resolved. (optional)deleted- Restricts to incidents that are deleted. (optional)tenantIdIn- Restricts to incidents that have one of the given comma-separated tenant ids. (optional)withoutTenantId- Only include historic incidents that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)jobDefinitionIdIn- Restricts to incidents that have one of the given comma-separated job definition ids. (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)- Returns:
- ApiResponse<List<HistoricIncidentDto>>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getHistoricIncidentsAsync
public okhttp3.Call getHistoricIncidentsAsync(String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String processDefinitionId, String processDefinitionKey, String processDefinitionKeyIn, String processInstanceId, String executionId, Date createTimeBefore, Date createTimeAfter, Date endTimeBefore, Date endTimeAfter, String activityId, String failedActivityId, String causeIncidentId, String rootCauseIncidentId, String _configuration, String historyConfiguration, Boolean open, Boolean resolved, Boolean deleted, String tenantIdIn, Boolean withoutTenantId, String jobDefinitionIdIn, String sortBy, String sortOrder, ApiCallback<List<HistoricIncidentDto>> _callback) throws ApiException
Get Incidents (asynchronously) Queries for historic incidents that fulfill given parameters. The size of the result set can be retrieved by using the [Get Incident Count](https://docs.camunda.org/manual/7.18/reference/rest/history/incident/get-incident-query-count/) method.- Parameters:
incidentId- Restricts to incidents that have the given id. (optional)incidentType- Restricts to incidents that belong to the given incident type. See the [User Guide](/manual/develop/user-guide/process-engine/incidents/#incident-types) for a list of incident types. (optional)incidentMessage- Restricts to incidents that have the given incident message. (optional)incidentMessageLike- Restricts to incidents that incidents message is a substring of the given value. The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%). (optional)processDefinitionId- Restricts to incidents that belong to a process definition with the given id. (optional)processDefinitionKey- Restricts to incidents that have the given processDefinitionKey. (optional)processDefinitionKeyIn- Restricts to incidents that have one of the given process definition keys. (optional)processInstanceId- Restricts to incidents that belong to a process instance with the given id. (optional)executionId- Restricts to incidents that belong to an execution with the given id. (optional)createTimeBefore- Restricts to incidents that have a createTime date before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)createTimeAfter- Restricts to incidents that have a createTime date after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)endTimeBefore- Restricts to incidents that have an endTimeBefore date before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)endTimeAfter- Restricts to incidents that have an endTimeAfter date after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)activityId- Restricts to incidents that belong to an activity with the given id. (optional)failedActivityId- Restricts to incidents that were created due to the failure of an activity with the given id. (optional)causeIncidentId- Restricts to incidents that have the given incident id as cause incident. (optional)rootCauseIncidentId- Restricts to incidents that have the given incident id as root cause incident. (optional)_configuration- Restricts to incidents that have the given parameter set as configuration. (optional)historyConfiguration- Restricts to incidents that have the given parameter set as history configuration. (optional)open- Restricts to incidents that are open. (optional)resolved- Restricts to incidents that are resolved. (optional)deleted- Restricts to incidents that are deleted. (optional)tenantIdIn- Restricts to incidents that have one of the given comma-separated tenant ids. (optional)withoutTenantId- Only include historic incidents that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)jobDefinitionIdIn- Restricts to incidents that have one of the given comma-separated job definition ids. (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)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object
-
getHistoricIncidentsCountCall
public okhttp3.Call getHistoricIncidentsCountCall(String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String processDefinitionId, String processDefinitionKey, String processDefinitionKeyIn, String processInstanceId, String executionId, Date createTimeBefore, Date createTimeAfter, Date endTimeBefore, Date endTimeAfter, String activityId, String failedActivityId, String causeIncidentId, String rootCauseIncidentId, String _configuration, String historyConfiguration, Boolean open, Boolean resolved, Boolean deleted, String tenantIdIn, Boolean withoutTenantId, String jobDefinitionIdIn, String sortBy, String sortOrder, ApiCallback _callback) throws ApiException
Build call for getHistoricIncidentsCount- Parameters:
incidentId- Restricts to incidents that have the given id. (optional)incidentType- Restricts to incidents that belong to the given incident type. See the [User Guide](/manual/develop/user-guide/process-engine/incidents/#incident-types) for a list of incident types. (optional)incidentMessage- Restricts to incidents that have the given incident message. (optional)incidentMessageLike- Restricts to incidents that incidents message is a substring of the given value. The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%). (optional)processDefinitionId- Restricts to incidents that belong to a process definition with the given id. (optional)processDefinitionKey- Restricts to incidents that have the given processDefinitionKey. (optional)processDefinitionKeyIn- Restricts to incidents that have one of the given process definition keys. (optional)processInstanceId- Restricts to incidents that belong to a process instance with the given id. (optional)executionId- Restricts to incidents that belong to an execution with the given id. (optional)createTimeBefore- Restricts to incidents that have a createTime date before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)createTimeAfter- Restricts to incidents that have a createTime date after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)endTimeBefore- Restricts to incidents that have an endTimeBefore date before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)endTimeAfter- Restricts to incidents that have an endTimeAfter date after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)activityId- Restricts to incidents that belong to an activity with the given id. (optional)failedActivityId- Restricts to incidents that were created due to the failure of an activity with the given id. (optional)causeIncidentId- Restricts to incidents that have the given incident id as cause incident. (optional)rootCauseIncidentId- Restricts to incidents that have the given incident id as root cause incident. (optional)_configuration- Restricts to incidents that have the given parameter set as configuration. (optional)historyConfiguration- Restricts to incidents that have the given parameter set as history configuration. (optional)open- Restricts to incidents that are open. (optional)resolved- Restricts to incidents that are resolved. (optional)deleted- Restricts to incidents that are deleted. (optional)tenantIdIn- Restricts to incidents that have one of the given comma-separated tenant ids. (optional)withoutTenantId- Only include historic incidents that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)jobDefinitionIdIn- Restricts to incidents that have one of the given comma-separated job definition ids. (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)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
getHistoricIncidentsCount
public CountResultDto getHistoricIncidentsCount(String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String processDefinitionId, String processDefinitionKey, String processDefinitionKeyIn, String processInstanceId, String executionId, Date createTimeBefore, Date createTimeAfter, Date endTimeBefore, Date endTimeAfter, String activityId, String failedActivityId, String causeIncidentId, String rootCauseIncidentId, String _configuration, String historyConfiguration, Boolean open, Boolean resolved, Boolean deleted, String tenantIdIn, Boolean withoutTenantId, String jobDefinitionIdIn, String sortBy, String sortOrder) throws ApiException
Get Incident Count Queries for the number of historic incidents that fulfill the given parameters. Takes the same parameters as the [Get Incidents](https://docs.camunda.org/manual/7.18/reference/rest/history/incident/get-incident-query/) method.- Parameters:
incidentId- Restricts to incidents that have the given id. (optional)incidentType- Restricts to incidents that belong to the given incident type. See the [User Guide](/manual/develop/user-guide/process-engine/incidents/#incident-types) for a list of incident types. (optional)incidentMessage- Restricts to incidents that have the given incident message. (optional)incidentMessageLike- Restricts to incidents that incidents message is a substring of the given value. The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%). (optional)processDefinitionId- Restricts to incidents that belong to a process definition with the given id. (optional)processDefinitionKey- Restricts to incidents that have the given processDefinitionKey. (optional)processDefinitionKeyIn- Restricts to incidents that have one of the given process definition keys. (optional)processInstanceId- Restricts to incidents that belong to a process instance with the given id. (optional)executionId- Restricts to incidents that belong to an execution with the given id. (optional)createTimeBefore- Restricts to incidents that have a createTime date before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)createTimeAfter- Restricts to incidents that have a createTime date after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)endTimeBefore- Restricts to incidents that have an endTimeBefore date before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)endTimeAfter- Restricts to incidents that have an endTimeAfter date after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)activityId- Restricts to incidents that belong to an activity with the given id. (optional)failedActivityId- Restricts to incidents that were created due to the failure of an activity with the given id. (optional)causeIncidentId- Restricts to incidents that have the given incident id as cause incident. (optional)rootCauseIncidentId- Restricts to incidents that have the given incident id as root cause incident. (optional)_configuration- Restricts to incidents that have the given parameter set as configuration. (optional)historyConfiguration- Restricts to incidents that have the given parameter set as history configuration. (optional)open- Restricts to incidents that are open. (optional)resolved- Restricts to incidents that are resolved. (optional)deleted- Restricts to incidents that are deleted. (optional)tenantIdIn- Restricts to incidents that have one of the given comma-separated tenant ids. (optional)withoutTenantId- Only include historic incidents that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)jobDefinitionIdIn- Restricts to incidents that have one of the given comma-separated job definition ids. (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)- Returns:
- CountResultDto
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getHistoricIncidentsCountWithHttpInfo
public ApiResponse<CountResultDto> getHistoricIncidentsCountWithHttpInfo(String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String processDefinitionId, String processDefinitionKey, String processDefinitionKeyIn, String processInstanceId, String executionId, Date createTimeBefore, Date createTimeAfter, Date endTimeBefore, Date endTimeAfter, String activityId, String failedActivityId, String causeIncidentId, String rootCauseIncidentId, String _configuration, String historyConfiguration, Boolean open, Boolean resolved, Boolean deleted, String tenantIdIn, Boolean withoutTenantId, String jobDefinitionIdIn, String sortBy, String sortOrder) throws ApiException
Get Incident Count Queries for the number of historic incidents that fulfill the given parameters. Takes the same parameters as the [Get Incidents](https://docs.camunda.org/manual/7.18/reference/rest/history/incident/get-incident-query/) method.- Parameters:
incidentId- Restricts to incidents that have the given id. (optional)incidentType- Restricts to incidents that belong to the given incident type. See the [User Guide](/manual/develop/user-guide/process-engine/incidents/#incident-types) for a list of incident types. (optional)incidentMessage- Restricts to incidents that have the given incident message. (optional)incidentMessageLike- Restricts to incidents that incidents message is a substring of the given value. The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%). (optional)processDefinitionId- Restricts to incidents that belong to a process definition with the given id. (optional)processDefinitionKey- Restricts to incidents that have the given processDefinitionKey. (optional)processDefinitionKeyIn- Restricts to incidents that have one of the given process definition keys. (optional)processInstanceId- Restricts to incidents that belong to a process instance with the given id. (optional)executionId- Restricts to incidents that belong to an execution with the given id. (optional)createTimeBefore- Restricts to incidents that have a createTime date before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)createTimeAfter- Restricts to incidents that have a createTime date after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)endTimeBefore- Restricts to incidents that have an endTimeBefore date before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)endTimeAfter- Restricts to incidents that have an endTimeAfter date after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)activityId- Restricts to incidents that belong to an activity with the given id. (optional)failedActivityId- Restricts to incidents that were created due to the failure of an activity with the given id. (optional)causeIncidentId- Restricts to incidents that have the given incident id as cause incident. (optional)rootCauseIncidentId- Restricts to incidents that have the given incident id as root cause incident. (optional)_configuration- Restricts to incidents that have the given parameter set as configuration. (optional)historyConfiguration- Restricts to incidents that have the given parameter set as history configuration. (optional)open- Restricts to incidents that are open. (optional)resolved- Restricts to incidents that are resolved. (optional)deleted- Restricts to incidents that are deleted. (optional)tenantIdIn- Restricts to incidents that have one of the given comma-separated tenant ids. (optional)withoutTenantId- Only include historic incidents that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)jobDefinitionIdIn- Restricts to incidents that have one of the given comma-separated job definition ids. (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)- Returns:
- ApiResponse<CountResultDto>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getHistoricIncidentsCountAsync
public okhttp3.Call getHistoricIncidentsCountAsync(String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String processDefinitionId, String processDefinitionKey, String processDefinitionKeyIn, String processInstanceId, String executionId, Date createTimeBefore, Date createTimeAfter, Date endTimeBefore, Date endTimeAfter, String activityId, String failedActivityId, String causeIncidentId, String rootCauseIncidentId, String _configuration, String historyConfiguration, Boolean open, Boolean resolved, Boolean deleted, String tenantIdIn, Boolean withoutTenantId, String jobDefinitionIdIn, String sortBy, String sortOrder, ApiCallback<CountResultDto> _callback) throws ApiException
Get Incident Count (asynchronously) Queries for the number of historic incidents that fulfill the given parameters. Takes the same parameters as the [Get Incidents](https://docs.camunda.org/manual/7.18/reference/rest/history/incident/get-incident-query/) method.- Parameters:
incidentId- Restricts to incidents that have the given id. (optional)incidentType- Restricts to incidents that belong to the given incident type. See the [User Guide](/manual/develop/user-guide/process-engine/incidents/#incident-types) for a list of incident types. (optional)incidentMessage- Restricts to incidents that have the given incident message. (optional)incidentMessageLike- Restricts to incidents that incidents message is a substring of the given value. The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%). (optional)processDefinitionId- Restricts to incidents that belong to a process definition with the given id. (optional)processDefinitionKey- Restricts to incidents that have the given processDefinitionKey. (optional)processDefinitionKeyIn- Restricts to incidents that have one of the given process definition keys. (optional)processInstanceId- Restricts to incidents that belong to a process instance with the given id. (optional)executionId- Restricts to incidents that belong to an execution with the given id. (optional)createTimeBefore- Restricts to incidents that have a createTime date before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)createTimeAfter- Restricts to incidents that have a createTime date after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)endTimeBefore- Restricts to incidents that have an endTimeBefore date before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)endTimeAfter- Restricts to incidents that have an endTimeAfter date after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)activityId- Restricts to incidents that belong to an activity with the given id. (optional)failedActivityId- Restricts to incidents that were created due to the failure of an activity with the given id. (optional)causeIncidentId- Restricts to incidents that have the given incident id as cause incident. (optional)rootCauseIncidentId- Restricts to incidents that have the given incident id as root cause incident. (optional)_configuration- Restricts to incidents that have the given parameter set as configuration. (optional)historyConfiguration- Restricts to incidents that have the given parameter set as history configuration. (optional)open- Restricts to incidents that are open. (optional)resolved- Restricts to incidents that are resolved. (optional)deleted- Restricts to incidents that are deleted. (optional)tenantIdIn- Restricts to incidents that have one of the given comma-separated tenant ids. (optional)withoutTenantId- Only include historic incidents that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)jobDefinitionIdIn- Restricts to incidents that have one of the given comma-separated job definition ids. (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)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object
-
-