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

Class EventSubscriptionApi

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

  • Constructor Details

    • EventSubscriptionApi

      public EventSubscriptionApi()

    • EventSubscriptionApi

      public EventSubscriptionApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • getEventSubscriptions

      public List<EventSubscriptionDto> getEventSubscriptions(String eventSubscriptionId, String eventName, String eventType, String executionId, String processInstanceId, String activityId, String tenantIdIn, Boolean withoutTenantId, Boolean includeEventSubscriptionsWithoutTenantId, String sortBy, String sortOrder, Integer firstResult, Integer maxResults) throws ApiException
      Get List Queries for event subscriptions that fulfill given parameters. The size of the result set can be retrieved by using the [Get Event Subscriptions count](https://docs.camunda.org/manual/7.21/reference/rest/event-subscription/get-query-count/) method.
      Parameters:
      eventSubscriptionId - Only select subscription with the given id. (optional)
      eventName - Only select subscriptions for events with the given name. (optional)
      eventType - Only select subscriptions for events with the given type. Valid values: `message`, `signal`, `compensate` and `conditional`. (optional)
      executionId - Only select subscriptions that belong to an execution with the given id. (optional)
      processInstanceId - Only select subscriptions that belong to a process instance with the given id. (optional)
      activityId - Only select subscriptions that belong to an activity with the given id. (optional)
      tenantIdIn - Filter by a comma-separated list of tenant ids. Only select subscriptions that belong to one of the given tenant ids. (optional)
      withoutTenantId - Only select subscriptions which have no tenant id. Value may only be `true`, as `false` is the default behavior. (optional)
      includeEventSubscriptionsWithoutTenantId - Select event subscriptions which have no tenant id. Can be used in combination with tenantIdIn parameter. Value may only be `true`, as `false` is the default behavior. (optional)
      sortBy - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)
      sortOrder - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (optional)
      firstResult - Pagination of results. Specifies the index of the first result to return. (optional)
      maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)
      Returns:
      List<EventSubscriptionDto>
      Throws:
      ApiException - if fails to make API call

    • getEventSubscriptions

      public List<EventSubscriptionDto> getEventSubscriptions(String eventSubscriptionId, String eventName, String eventType, String executionId, String processInstanceId, String activityId, String tenantIdIn, Boolean withoutTenantId, Boolean includeEventSubscriptionsWithoutTenantId, String sortBy, String sortOrder, Integer firstResult, Integer maxResults, Map<String,String> additionalHeaders) throws ApiException
      Get List Queries for event subscriptions that fulfill given parameters. The size of the result set can be retrieved by using the [Get Event Subscriptions count](https://docs.camunda.org/manual/7.21/reference/rest/event-subscription/get-query-count/) method.
      Parameters:
      eventSubscriptionId - Only select subscription with the given id. (optional)
      eventName - Only select subscriptions for events with the given name. (optional)
      eventType - Only select subscriptions for events with the given type. Valid values: `message`, `signal`, `compensate` and `conditional`. (optional)
      executionId - Only select subscriptions that belong to an execution with the given id. (optional)
      processInstanceId - Only select subscriptions that belong to a process instance with the given id. (optional)
      activityId - Only select subscriptions that belong to an activity with the given id. (optional)
      tenantIdIn - Filter by a comma-separated list of tenant ids. Only select subscriptions that belong to one of the given tenant ids. (optional)
      withoutTenantId - Only select subscriptions which have no tenant id. Value may only be `true`, as `false` is the default behavior. (optional)
      includeEventSubscriptionsWithoutTenantId - Select event subscriptions which have no tenant id. Can be used in combination with tenantIdIn parameter. Value may only be `true`, as `false` is the default behavior. (optional)
      sortBy - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)
      sortOrder - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (optional)
      firstResult - Pagination of results. Specifies the index of the first result to return. (optional)
      maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<EventSubscriptionDto>
      Throws:
      ApiException - if fails to make API call

    • getEventSubscriptionsCount

      public CountResultDto getEventSubscriptionsCount(String eventSubscriptionId, String eventName, String eventType, String executionId, String processInstanceId, String activityId, String tenantIdIn, Boolean withoutTenantId, Boolean includeEventSubscriptionsWithoutTenantId) throws ApiException
      Get List Count Queries for the number of event subscriptions that fulfill given parameters. Takes the same parameters as the [Get Event Subscriptions](https://docs.camunda.org/manual/7.21/reference/rest/event-subscription/get-query/) method.
      Parameters:
      eventSubscriptionId - Only select subscription with the given id. (optional)
      eventName - Only select subscriptions for events with the given name. (optional)
      eventType - Only select subscriptions for events with the given type. Valid values: `message`, `signal`, `compensate` and `conditional`. (optional)
      executionId - Only select subscriptions that belong to an execution with the given id. (optional)
      processInstanceId - Only select subscriptions that belong to a process instance with the given id. (optional)
      activityId - Only select subscriptions that belong to an activity with the given id. (optional)
      tenantIdIn - Filter by a comma-separated list of tenant ids. Only select subscriptions that belong to one of the given tenant ids. (optional)
      withoutTenantId - Only select subscriptions which have no tenant id. Value may only be `true`, as `false` is the default behavior. (optional)
      includeEventSubscriptionsWithoutTenantId - Select event subscriptions which have no tenant id. Can be used in combination with tenantIdIn parameter. Value may only be `true`, as `false` is the default behavior. (optional)
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • getEventSubscriptionsCount

      public CountResultDto getEventSubscriptionsCount(String eventSubscriptionId, String eventName, String eventType, String executionId, String processInstanceId, String activityId, String tenantIdIn, Boolean withoutTenantId, Boolean includeEventSubscriptionsWithoutTenantId, Map<String,String> additionalHeaders) throws ApiException
      Get List Count Queries for the number of event subscriptions that fulfill given parameters. Takes the same parameters as the [Get Event Subscriptions](https://docs.camunda.org/manual/7.21/reference/rest/event-subscription/get-query/) method.
      Parameters:
      eventSubscriptionId - Only select subscription with the given id. (optional)
      eventName - Only select subscriptions for events with the given name. (optional)
      eventType - Only select subscriptions for events with the given type. Valid values: `message`, `signal`, `compensate` and `conditional`. (optional)
      executionId - Only select subscriptions that belong to an execution with the given id. (optional)
      processInstanceId - Only select subscriptions that belong to a process instance with the given id. (optional)
      activityId - Only select subscriptions that belong to an activity with the given id. (optional)
      tenantIdIn - Filter by a comma-separated list of tenant ids. Only select subscriptions that belong to one of the given tenant ids. (optional)
      withoutTenantId - Only select subscriptions which have no tenant id. Value may only be `true`, as `false` is the default behavior. (optional)
      includeEventSubscriptionsWithoutTenantId - Select event subscriptions which have no tenant id. Can be used in combination with tenantIdIn parameter. Value may only be `true`, as `false` is the default behavior. (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call