org.openapitools.client.api

Class IncidentApi

java.lang.Object

org.openapitools.client.api.IncidentApi

public class IncidentApi
extends Object

Constructor Summary

Constructors

Constructor and Description
IncidentApi()
IncidentApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	clearIncidentAnnotation(String id) Clear Incident Annotation Clears the annotation of an incident with given id.
okhttp3.Call	clearIncidentAnnotationAsync(String id, ApiCallback<Void> _callback) Clear Incident Annotation (asynchronously) Clears the annotation of an incident with given id.
okhttp3.Call	clearIncidentAnnotationCall(String id, ApiCallback _callback) Build call for clearIncidentAnnotation
ApiResponse<Void>	clearIncidentAnnotationWithHttpInfo(String id) Clear Incident Annotation Clears the annotation of an incident with given id.
ApiClient	getApiClient()
IncidentDto	getIncident(String id) Get Incident Retrieves an incident by ID.
okhttp3.Call	getIncidentAsync(String id, ApiCallback<IncidentDto> _callback) Get Incident (asynchronously) Retrieves an incident by ID.
okhttp3.Call	getIncidentCall(String id, ApiCallback _callback) Build call for getIncident
List<IncidentDto>	getIncidents(String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String processDefinitionId, String processDefinitionKeyIn, String processInstanceId, String executionId, Date incidentTimestampBefore, Date incidentTimestampAfter, String activityId, String failedActivityId, String causeIncidentId, String rootCauseIncidentId, String _configuration, String tenantIdIn, String jobDefinitionIdIn, String sortBy, String sortOrder) Get List Queries for incidents that fulfill given parameters.
okhttp3.Call	getIncidentsAsync(String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String processDefinitionId, String processDefinitionKeyIn, String processInstanceId, String executionId, Date incidentTimestampBefore, Date incidentTimestampAfter, String activityId, String failedActivityId, String causeIncidentId, String rootCauseIncidentId, String _configuration, String tenantIdIn, String jobDefinitionIdIn, String sortBy, String sortOrder, ApiCallback<List<IncidentDto>> _callback) Get List (asynchronously) Queries for incidents that fulfill given parameters.
okhttp3.Call	getIncidentsCall(String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String processDefinitionId, String processDefinitionKeyIn, String processInstanceId, String executionId, Date incidentTimestampBefore, Date incidentTimestampAfter, String activityId, String failedActivityId, String causeIncidentId, String rootCauseIncidentId, String _configuration, String tenantIdIn, String jobDefinitionIdIn, String sortBy, String sortOrder, ApiCallback _callback) Build call for getIncidents
List<CountResultDto>	getIncidentsCount(String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String processDefinitionId, String processDefinitionKeyIn, String processInstanceId, String executionId, Date incidentTimestampBefore, Date incidentTimestampAfter, String activityId, String failedActivityId, String causeIncidentId, String rootCauseIncidentId, String _configuration, String tenantIdIn, String jobDefinitionIdIn) Get List Count Queries for the number of incidents that fulfill given parameters.
okhttp3.Call	getIncidentsCountAsync(String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String processDefinitionId, String processDefinitionKeyIn, String processInstanceId, String executionId, Date incidentTimestampBefore, Date incidentTimestampAfter, String activityId, String failedActivityId, String causeIncidentId, String rootCauseIncidentId, String _configuration, String tenantIdIn, String jobDefinitionIdIn, ApiCallback<List<CountResultDto>> _callback) Get List Count (asynchronously) Queries for the number of incidents that fulfill given parameters.
okhttp3.Call	getIncidentsCountCall(String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String processDefinitionId, String processDefinitionKeyIn, String processInstanceId, String executionId, Date incidentTimestampBefore, Date incidentTimestampAfter, String activityId, String failedActivityId, String causeIncidentId, String rootCauseIncidentId, String _configuration, String tenantIdIn, String jobDefinitionIdIn, ApiCallback _callback) Build call for getIncidentsCount
ApiResponse<List<CountResultDto>>	getIncidentsCountWithHttpInfo(String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String processDefinitionId, String processDefinitionKeyIn, String processInstanceId, String executionId, Date incidentTimestampBefore, Date incidentTimestampAfter, String activityId, String failedActivityId, String causeIncidentId, String rootCauseIncidentId, String _configuration, String tenantIdIn, String jobDefinitionIdIn) Get List Count Queries for the number of incidents that fulfill given parameters.
ApiResponse<List<IncidentDto>>	getIncidentsWithHttpInfo(String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String processDefinitionId, String processDefinitionKeyIn, String processInstanceId, String executionId, Date incidentTimestampBefore, Date incidentTimestampAfter, String activityId, String failedActivityId, String causeIncidentId, String rootCauseIncidentId, String _configuration, String tenantIdIn, String jobDefinitionIdIn, String sortBy, String sortOrder) Get List Queries for incidents that fulfill given parameters.
ApiResponse<IncidentDto>	getIncidentWithHttpInfo(String id) Get Incident Retrieves an incident by ID.
void	resolveIncident(String id) Resolve Incident Resolves an incident with given id.
okhttp3.Call	resolveIncidentAsync(String id, ApiCallback<Void> _callback) Resolve Incident (asynchronously) Resolves an incident with given id.
okhttp3.Call	resolveIncidentCall(String id, ApiCallback _callback) Build call for resolveIncident
ApiResponse<Void>	resolveIncidentWithHttpInfo(String id) Resolve Incident Resolves an incident with given id.
void	setApiClient(ApiClient apiClient)
void	setIncidentAnnotation(String id, AnnotationDto annotationDto) Set Incident Annotation Sets the annotation of an incident with given id.
okhttp3.Call	setIncidentAnnotationAsync(String id, AnnotationDto annotationDto, ApiCallback<Void> _callback) Set Incident Annotation (asynchronously) Sets the annotation of an incident with given id.
okhttp3.Call	setIncidentAnnotationCall(String id, AnnotationDto annotationDto, ApiCallback _callback) Build call for setIncidentAnnotation
ApiResponse<Void>	setIncidentAnnotationWithHttpInfo(String id, AnnotationDto annotationDto) Set Incident Annotation Sets the annotation of an incident with given id.

Methods inherited from class java.lang.Object

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

Constructor Detail

IncidentApi

public IncidentApi()

IncidentApi

public IncidentApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

clearIncidentAnnotationCall

public okhttp3.Call clearIncidentAnnotationCall(String id,
                                                ApiCallback _callback)
                                         throws ApiException

Build call for clearIncidentAnnotation

Parameters:

id - The id of the incident to clear the annotation at. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

clearIncidentAnnotation

public void clearIncidentAnnotation(String id)
                             throws ApiException

Clear Incident Annotation Clears the annotation of an incident with given id.

Parameters:

id - The id of the incident to clear the annotation at. (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

clearIncidentAnnotationWithHttpInfo

public ApiResponse<Void> clearIncidentAnnotationWithHttpInfo(String id)
                                                      throws ApiException

Clear Incident Annotation Clears the annotation of an incident with given id.

Parameters:

id - The id of the incident to clear the annotation at. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

clearIncidentAnnotationAsync

public okhttp3.Call clearIncidentAnnotationAsync(String id,
                                                 ApiCallback<Void> _callback)
                                          throws ApiException

Clear Incident Annotation (asynchronously) Clears the annotation of an incident with given id.

Parameters:

id - The id of the incident to clear the annotation at. (required)

_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

getIncidentCall

public okhttp3.Call getIncidentCall(String id,
                                    ApiCallback _callback)
                             throws ApiException

Build call for getIncident

Parameters:

id - The id of the incident to be retrieved. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getIncident

public IncidentDto getIncident(String id)
                        throws ApiException

Get Incident Retrieves an incident by ID.

Parameters:

id - The id of the incident to be retrieved. (required)

Returns:

IncidentDto

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getIncidentWithHttpInfo

public ApiResponse<IncidentDto> getIncidentWithHttpInfo(String id)
                                                 throws ApiException

Get Incident Retrieves an incident by ID.

Parameters:

id - The id of the incident to be retrieved. (required)

Returns:

ApiResponse<IncidentDto>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getIncidentAsync

public okhttp3.Call getIncidentAsync(String id,
                                     ApiCallback<IncidentDto> _callback)
                              throws ApiException

Get Incident (asynchronously) Retrieves an incident by ID.

Parameters:

id - The id of the incident to be retrieved. (required)

_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

getIncidentsCall

public okhttp3.Call getIncidentsCall(String incidentId,
                                     String incidentType,
                                     String incidentMessage,
                                     String incidentMessageLike,
                                     String processDefinitionId,
                                     String processDefinitionKeyIn,
                                     String processInstanceId,
                                     String executionId,
                                     Date incidentTimestampBefore,
                                     Date incidentTimestampAfter,
                                     String activityId,
                                     String failedActivityId,
                                     String causeIncidentId,
                                     String rootCauseIncidentId,
                                     String _configuration,
                                     String tenantIdIn,
                                     String jobDefinitionIdIn,
                                     String sortBy,
                                     String sortOrder,
                                     ApiCallback _callback)
                              throws ApiException

Build call for getIncidents

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](https://docs.camunda.org/manual/7.15/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)

processDefinitionKeyIn - Restricts to incidents that belong to a process definition with the given keys. Must be a comma-separated list. (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)

incidentTimestampBefore - Restricts to incidents that have an incidentTimestamp date before the given date. By default, the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)

incidentTimestampAfter - Restricts to incidents that have an incidentTimestamp date after the given date. By default*, 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)

tenantIdIn - Restricts to incidents that have one of the given comma-separated tenant ids. (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

getIncidents

public List<IncidentDto> getIncidents(String incidentId,
                                      String incidentType,
                                      String incidentMessage,
                                      String incidentMessageLike,
                                      String processDefinitionId,
                                      String processDefinitionKeyIn,
                                      String processInstanceId,
                                      String executionId,
                                      Date incidentTimestampBefore,
                                      Date incidentTimestampAfter,
                                      String activityId,
                                      String failedActivityId,
                                      String causeIncidentId,
                                      String rootCauseIncidentId,
                                      String _configuration,
                                      String tenantIdIn,
                                      String jobDefinitionIdIn,
                                      String sortBy,
                                      String sortOrder)
                               throws ApiException

Get List Queries for 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.15/reference/rest/incident/get-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](https://docs.camunda.org/manual/7.15/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)

processDefinitionKeyIn - Restricts to incidents that belong to a process definition with the given keys. Must be a comma-separated list. (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)

incidentTimestampBefore - Restricts to incidents that have an incidentTimestamp date before the given date. By default, the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)

incidentTimestampAfter - Restricts to incidents that have an incidentTimestamp date after the given date. By default*, 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)

tenantIdIn - Restricts to incidents that have one of the given comma-separated tenant ids. (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<IncidentDto>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getIncidentsWithHttpInfo

public ApiResponse<List<IncidentDto>> getIncidentsWithHttpInfo(String incidentId,
                                                               String incidentType,
                                                               String incidentMessage,
                                                               String incidentMessageLike,
                                                               String processDefinitionId,
                                                               String processDefinitionKeyIn,
                                                               String processInstanceId,
                                                               String executionId,
                                                               Date incidentTimestampBefore,
                                                               Date incidentTimestampAfter,
                                                               String activityId,
                                                               String failedActivityId,
                                                               String causeIncidentId,
                                                               String rootCauseIncidentId,
                                                               String _configuration,
                                                               String tenantIdIn,
                                                               String jobDefinitionIdIn,
                                                               String sortBy,
                                                               String sortOrder)
                                                        throws ApiException

Get List Queries for 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.15/reference/rest/incident/get-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](https://docs.camunda.org/manual/7.15/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)

processDefinitionKeyIn - Restricts to incidents that belong to a process definition with the given keys. Must be a comma-separated list. (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)

incidentTimestampBefore - Restricts to incidents that have an incidentTimestamp date before the given date. By default, the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)

incidentTimestampAfter - Restricts to incidents that have an incidentTimestamp date after the given date. By default*, 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)

tenantIdIn - Restricts to incidents that have one of the given comma-separated tenant ids. (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<IncidentDto>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getIncidentsAsync

public okhttp3.Call getIncidentsAsync(String incidentId,
                                      String incidentType,
                                      String incidentMessage,
                                      String incidentMessageLike,
                                      String processDefinitionId,
                                      String processDefinitionKeyIn,
                                      String processInstanceId,
                                      String executionId,
                                      Date incidentTimestampBefore,
                                      Date incidentTimestampAfter,
                                      String activityId,
                                      String failedActivityId,
                                      String causeIncidentId,
                                      String rootCauseIncidentId,
                                      String _configuration,
                                      String tenantIdIn,
                                      String jobDefinitionIdIn,
                                      String sortBy,
                                      String sortOrder,
                                      ApiCallback<List<IncidentDto>> _callback)
                               throws ApiException

Get List (asynchronously) Queries for 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.15/reference/rest/incident/get-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](https://docs.camunda.org/manual/7.15/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)

processDefinitionKeyIn - Restricts to incidents that belong to a process definition with the given keys. Must be a comma-separated list. (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)

incidentTimestampBefore - Restricts to incidents that have an incidentTimestamp date before the given date. By default, the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)

incidentTimestampAfter - Restricts to incidents that have an incidentTimestamp date after the given date. By default*, 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)

tenantIdIn - Restricts to incidents that have one of the given comma-separated tenant ids. (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

getIncidentsCountCall

public okhttp3.Call getIncidentsCountCall(String incidentId,
                                          String incidentType,
                                          String incidentMessage,
                                          String incidentMessageLike,
                                          String processDefinitionId,
                                          String processDefinitionKeyIn,
                                          String processInstanceId,
                                          String executionId,
                                          Date incidentTimestampBefore,
                                          Date incidentTimestampAfter,
                                          String activityId,
                                          String failedActivityId,
                                          String causeIncidentId,
                                          String rootCauseIncidentId,
                                          String _configuration,
                                          String tenantIdIn,
                                          String jobDefinitionIdIn,
                                          ApiCallback _callback)
                                   throws ApiException

Build call for getIncidentsCount

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](https://docs.camunda.org/manual/7.15/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)

processDefinitionKeyIn - Restricts to incidents that belong to a process definition with the given keys. Must be a comma-separated list. (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)

incidentTimestampBefore - Restricts to incidents that have an incidentTimestamp date before the given date. By default, the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)

incidentTimestampAfter - Restricts to incidents that have an incidentTimestamp date after the given date. By default*, 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)

tenantIdIn - Restricts to incidents that have one of the given comma-separated tenant ids. (optional)

jobDefinitionIdIn - Restricts to incidents that have one of the given comma-separated job definition ids. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getIncidentsCount

public List<CountResultDto> getIncidentsCount(String incidentId,
                                              String incidentType,
                                              String incidentMessage,
                                              String incidentMessageLike,
                                              String processDefinitionId,
                                              String processDefinitionKeyIn,
                                              String processInstanceId,
                                              String executionId,
                                              Date incidentTimestampBefore,
                                              Date incidentTimestampAfter,
                                              String activityId,
                                              String failedActivityId,
                                              String causeIncidentId,
                                              String rootCauseIncidentId,
                                              String _configuration,
                                              String tenantIdIn,
                                              String jobDefinitionIdIn)
                                       throws ApiException

Get List Count Queries for the number of incidents that fulfill given parameters. Takes the same parameters as the [Get Incidents](https://docs.camunda.org/manual/7.15/reference/rest/incident/get-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](https://docs.camunda.org/manual/7.15/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)

processDefinitionKeyIn - Restricts to incidents that belong to a process definition with the given keys. Must be a comma-separated list. (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)

incidentTimestampBefore - Restricts to incidents that have an incidentTimestamp date before the given date. By default, the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)

incidentTimestampAfter - Restricts to incidents that have an incidentTimestamp date after the given date. By default*, 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)

tenantIdIn - Restricts to incidents that have one of the given comma-separated tenant ids. (optional)

jobDefinitionIdIn - Restricts to incidents that have one of the given comma-separated job definition ids. (optional)

Returns:

List<CountResultDto>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getIncidentsCountWithHttpInfo

public ApiResponse<List<CountResultDto>> getIncidentsCountWithHttpInfo(String incidentId,
                                                                       String incidentType,
                                                                       String incidentMessage,
                                                                       String incidentMessageLike,
                                                                       String processDefinitionId,
                                                                       String processDefinitionKeyIn,
                                                                       String processInstanceId,
                                                                       String executionId,
                                                                       Date incidentTimestampBefore,
                                                                       Date incidentTimestampAfter,
                                                                       String activityId,
                                                                       String failedActivityId,
                                                                       String causeIncidentId,
                                                                       String rootCauseIncidentId,
                                                                       String _configuration,
                                                                       String tenantIdIn,
                                                                       String jobDefinitionIdIn)
                                                                throws ApiException

Get List Count Queries for the number of incidents that fulfill given parameters. Takes the same parameters as the [Get Incidents](https://docs.camunda.org/manual/7.15/reference/rest/incident/get-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](https://docs.camunda.org/manual/7.15/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)

processDefinitionKeyIn - Restricts to incidents that belong to a process definition with the given keys. Must be a comma-separated list. (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)

incidentTimestampBefore - Restricts to incidents that have an incidentTimestamp date before the given date. By default, the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)

incidentTimestampAfter - Restricts to incidents that have an incidentTimestamp date after the given date. By default*, 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)

tenantIdIn - Restricts to incidents that have one of the given comma-separated tenant ids. (optional)

jobDefinitionIdIn - Restricts to incidents that have one of the given comma-separated job definition ids. (optional)

Returns:

ApiResponse<List<CountResultDto>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getIncidentsCountAsync

public okhttp3.Call getIncidentsCountAsync(String incidentId,
                                           String incidentType,
                                           String incidentMessage,
                                           String incidentMessageLike,
                                           String processDefinitionId,
                                           String processDefinitionKeyIn,
                                           String processInstanceId,
                                           String executionId,
                                           Date incidentTimestampBefore,
                                           Date incidentTimestampAfter,
                                           String activityId,
                                           String failedActivityId,
                                           String causeIncidentId,
                                           String rootCauseIncidentId,
                                           String _configuration,
                                           String tenantIdIn,
                                           String jobDefinitionIdIn,
                                           ApiCallback<List<CountResultDto>> _callback)
                                    throws ApiException

Get List Count (asynchronously) Queries for the number of incidents that fulfill given parameters. Takes the same parameters as the [Get Incidents](https://docs.camunda.org/manual/7.15/reference/rest/incident/get-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](https://docs.camunda.org/manual/7.15/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)

processDefinitionKeyIn - Restricts to incidents that belong to a process definition with the given keys. Must be a comma-separated list. (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)

incidentTimestampBefore - Restricts to incidents that have an incidentTimestamp date before the given date. By default, the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)

incidentTimestampAfter - Restricts to incidents that have an incidentTimestamp date after the given date. By default*, 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)

tenantIdIn - Restricts to incidents that have one of the given comma-separated tenant ids. (optional)

jobDefinitionIdIn - Restricts to incidents that have one of the given comma-separated job definition ids. (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

resolveIncidentCall

public okhttp3.Call resolveIncidentCall(String id,
                                        ApiCallback _callback)
                                 throws ApiException

Build call for resolveIncident

Parameters:

id - The id of the incident to be resolved. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

resolveIncident

public void resolveIncident(String id)
                     throws ApiException

Resolve Incident Resolves an incident with given id.

Parameters:

id - The id of the incident to be resolved. (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

resolveIncidentWithHttpInfo

public ApiResponse<Void> resolveIncidentWithHttpInfo(String id)
                                              throws ApiException

Resolve Incident Resolves an incident with given id.

Parameters:

id - The id of the incident to be resolved. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

resolveIncidentAsync

public okhttp3.Call resolveIncidentAsync(String id,
                                         ApiCallback<Void> _callback)
                                  throws ApiException

Resolve Incident (asynchronously) Resolves an incident with given id.

Parameters:

id - The id of the incident to be resolved. (required)

_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

setIncidentAnnotationCall

public okhttp3.Call setIncidentAnnotationCall(String id,
                                              AnnotationDto annotationDto,
                                              ApiCallback _callback)
                                       throws ApiException

Build call for setIncidentAnnotation

Parameters:

id - The id of the incident to clear the annotation at. (required)

annotationDto - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

setIncidentAnnotation

public void setIncidentAnnotation(String id,
                                  AnnotationDto annotationDto)
                           throws ApiException

Set Incident Annotation Sets the annotation of an incident with given id.

Parameters:

id - The id of the incident to clear the annotation at. (required)

annotationDto - (optional)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

setIncidentAnnotationWithHttpInfo

public ApiResponse<Void> setIncidentAnnotationWithHttpInfo(String id,
                                                           AnnotationDto annotationDto)
                                                    throws ApiException

Set Incident Annotation Sets the annotation of an incident with given id.

Parameters:

id - The id of the incident to clear the annotation at. (required)

annotationDto - (optional)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

setIncidentAnnotationAsync

public okhttp3.Call setIncidentAnnotationAsync(String id,
                                               AnnotationDto annotationDto,
                                               ApiCallback<Void> _callback)
                                        throws ApiException

Set Incident Annotation (asynchronously) Sets the annotation of an incident with given id.

Parameters:

id - The id of the incident to clear the annotation at. (required)

annotationDto - (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