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

Class IncidentApi

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

  • Constructor Details

    • IncidentApi

      public IncidentApi()

    • IncidentApi

      public IncidentApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • 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 fails to make API call

    • clearIncidentAnnotation

      public void clearIncidentAnnotation(String id, Map<String,String> additionalHeaders) 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)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • 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 fails to make API call

    • getIncident

      public IncidentDto getIncident(String id, Map<String,String> additionalHeaders) throws ApiException
      Get Incident Retrieves an incident by ID.
      Parameters:
      id - The id of the incident to be retrieved. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      IncidentDto
      Throws:
      ApiException - if fails to make API call

    • getIncidents

      public List<IncidentDto> getIncidents(String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String processDefinitionId, String processDefinitionKeyIn, String processInstanceId, String executionId, OffsetDateTime incidentTimestampBefore, OffsetDateTime incidentTimestampAfter, String activityId, String failedActivityId, String causeIncidentId, String rootCauseIncidentId, String _configuration, String tenantIdIn, String jobDefinitionIdIn, String sortBy, String sortOrder, Integer firstResult, Integer maxResults) 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.21/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.21/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](https://docs.camunda.org/manual/7.21/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)
      incidentTimestampAfter - Restricts to incidents that have an incidentTimestamp date after the given date. By [default](https://docs.camunda.org/manual/7.21/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)
      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)
      firstResult - Pagination of results. Specifies the index of the first result to return. (optional)
      maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)
      Returns:
      List<IncidentDto>
      Throws:
      ApiException - if fails to make API call

    • getIncidents

      public List<IncidentDto> getIncidents(String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String processDefinitionId, String processDefinitionKeyIn, String processInstanceId, String executionId, OffsetDateTime incidentTimestampBefore, OffsetDateTime incidentTimestampAfter, String activityId, String failedActivityId, String causeIncidentId, String rootCauseIncidentId, String _configuration, String tenantIdIn, String jobDefinitionIdIn, String sortBy, String sortOrder, Integer firstResult, Integer maxResults, Map<String,String> additionalHeaders) 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.21/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.21/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](https://docs.camunda.org/manual/7.21/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)
      incidentTimestampAfter - Restricts to incidents that have an incidentTimestamp date after the given date. By [default](https://docs.camunda.org/manual/7.21/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)
      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)
      firstResult - Pagination of results. Specifies the index of the first result to return. (optional)
      maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<IncidentDto>
      Throws:
      ApiException - if fails to make API call

    • getIncidentsCount

      public CountResultDto getIncidentsCount(String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String processDefinitionId, String processDefinitionKeyIn, String processInstanceId, String executionId, OffsetDateTime incidentTimestampBefore, OffsetDateTime 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.21/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.21/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](https://docs.camunda.org/manual/7.21/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)
      incidentTimestampAfter - Restricts to incidents that have an incidentTimestamp date after the given date. By [default](https://docs.camunda.org/manual/7.21/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)
      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:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • getIncidentsCount

      public CountResultDto getIncidentsCount(String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String processDefinitionId, String processDefinitionKeyIn, String processInstanceId, String executionId, OffsetDateTime incidentTimestampBefore, OffsetDateTime incidentTimestampAfter, String activityId, String failedActivityId, String causeIncidentId, String rootCauseIncidentId, String _configuration, String tenantIdIn, String jobDefinitionIdIn, Map<String,String> additionalHeaders) 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.21/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.21/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](https://docs.camunda.org/manual/7.21/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)
      incidentTimestampAfter - Restricts to incidents that have an incidentTimestamp date after the given date. By [default](https://docs.camunda.org/manual/7.21/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)
      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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • 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 fails to make API call

    • resolveIncident

      public void resolveIncident(String id, Map<String,String> additionalHeaders) throws ApiException
      Resolve Incident Resolves an incident with given id.
      Parameters:
      id - The id of the incident to be resolved. (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • 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 fails to make API call

    • setIncidentAnnotation

      public void setIncidentAnnotation(String id, AnnotationDto annotationDto, Map<String,String> additionalHeaders) 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)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call