Package org.openapitools.client.api

Class ExternalTaskApi

  • public class ExternalTaskApi
extends Object

    • Constructor Detail

      • ExternalTaskApi

        public ExternalTaskApi()

      • ExternalTaskApi

        public ExternalTaskApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • completeExternalTaskResourceCall

        public okhttp3.Call completeExternalTaskResourceCall​(String id,
                                                     CompleteExternalTaskDto completeExternalTaskDto,
                                                     ApiCallback _callback)
                                              throws ApiException
        Build call for completeExternalTaskResource
        Parameters:
        id - The id of the task to complete. (required)
        completeExternalTaskDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • completeExternalTaskResource

        public void completeExternalTaskResource​(String id,
                                         CompleteExternalTaskDto completeExternalTaskDto)
                                  throws ApiException
        Complete Completes an external task by id and updates process variables.
        Parameters:
        id - The id of the task to complete. (required)
        completeExternalTaskDto - (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • completeExternalTaskResourceWithHttpInfo

        public ApiResponse<Void> completeExternalTaskResourceWithHttpInfo​(String id,
                                                                  CompleteExternalTaskDto completeExternalTaskDto)
                                                           throws ApiException
        Complete Completes an external task by id and updates process variables.
        Parameters:
        id - The id of the task to complete. (required)
        completeExternalTaskDto - (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • completeExternalTaskResourceAsync

        public okhttp3.Call completeExternalTaskResourceAsync​(String id,
                                                      CompleteExternalTaskDto completeExternalTaskDto,
                                                      ApiCallback<Void> _callback)
                                               throws ApiException
        Complete (asynchronously) Completes an external task by id and updates process variables.
        Parameters:
        id - The id of the task to complete. (required)
        completeExternalTaskDto - (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

      • extendLockCall

        public okhttp3.Call extendLockCall​(String id,
                                   ExtendLockOnExternalTaskDto extendLockOnExternalTaskDto,
                                   ApiCallback _callback)
                            throws ApiException
        Build call for extendLock
        Parameters:
        id - The id of the external task. (required)
        extendLockOnExternalTaskDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • extendLock

        public void extendLock​(String id,
                       ExtendLockOnExternalTaskDto extendLockOnExternalTaskDto)
                throws ApiException
        Extend Lock Extends the timeout of the lock by a given amount of time.
        Parameters:
        id - The id of the external task. (required)
        extendLockOnExternalTaskDto - (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • extendLockWithHttpInfo

        public ApiResponse<Void> extendLockWithHttpInfo​(String id,
                                                ExtendLockOnExternalTaskDto extendLockOnExternalTaskDto)
                                         throws ApiException
        Extend Lock Extends the timeout of the lock by a given amount of time.
        Parameters:
        id - The id of the external task. (required)
        extendLockOnExternalTaskDto - (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • extendLockAsync

        public okhttp3.Call extendLockAsync​(String id,
                                    ExtendLockOnExternalTaskDto extendLockOnExternalTaskDto,
                                    ApiCallback<Void> _callback)
                             throws ApiException
        Extend Lock (asynchronously) Extends the timeout of the lock by a given amount of time.
        Parameters:
        id - The id of the external task. (required)
        extendLockOnExternalTaskDto - (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

      • fetchAndLockCall

        public okhttp3.Call fetchAndLockCall​(FetchExternalTasksDto fetchExternalTasksDto,
                                     ApiCallback _callback)
                              throws ApiException
        Build call for fetchAndLock
        Parameters:
        fetchExternalTasksDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • fetchAndLock

        public List<LockedExternalTaskDto> fetchAndLock​(FetchExternalTasksDto fetchExternalTasksDto)
                                         throws ApiException
        Fetch and Lock Fetches and locks a specific number of external tasks for execution by a worker. Query can be restricted to specific task topics and for each task topic an individual lock time can be provided.
        Parameters:
        fetchExternalTasksDto - (optional)
        Returns:
        List<LockedExternalTaskDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • fetchAndLockWithHttpInfo

        public ApiResponse<List<LockedExternalTaskDto>> fetchAndLockWithHttpInfo​(FetchExternalTasksDto fetchExternalTasksDto)
                                                                  throws ApiException
        Fetch and Lock Fetches and locks a specific number of external tasks for execution by a worker. Query can be restricted to specific task topics and for each task topic an individual lock time can be provided.
        Parameters:
        fetchExternalTasksDto - (optional)
        Returns:
        ApiResponse<List<LockedExternalTaskDto>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • fetchAndLockAsync

        public okhttp3.Call fetchAndLockAsync​(FetchExternalTasksDto fetchExternalTasksDto,
                                      ApiCallback<List<LockedExternalTaskDto>> _callback)
                               throws ApiException
        Fetch and Lock (asynchronously) Fetches and locks a specific number of external tasks for execution by a worker. Query can be restricted to specific task topics and for each task topic an individual lock time can be provided.
        Parameters:
        fetchExternalTasksDto - (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

      • getExternalTaskCall

        public okhttp3.Call getExternalTaskCall​(String id,
                                        ApiCallback _callback)
                                 throws ApiException
        Build call for getExternalTask
        Parameters:
        id - The id of the external task to be retrieved. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getExternalTask

        public ExternalTaskDto getExternalTask​(String id)
                                throws ApiException
        Get Retrieves an external task by id, corresponding to the `ExternalTask` interface in the engine.
        Parameters:
        id - The id of the external task to be retrieved. (required)
        Returns:
        ExternalTaskDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getExternalTaskWithHttpInfo

        public ApiResponse<ExternalTaskDto> getExternalTaskWithHttpInfo​(String id)
                                                         throws ApiException
        Get Retrieves an external task by id, corresponding to the `ExternalTask` interface in the engine.
        Parameters:
        id - The id of the external task to be retrieved. (required)
        Returns:
        ApiResponse<ExternalTaskDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getExternalTaskAsync

        public okhttp3.Call getExternalTaskAsync​(String id,
                                         ApiCallback<ExternalTaskDto> _callback)
                                  throws ApiException
        Get (asynchronously) Retrieves an external task by id, corresponding to the `ExternalTask` interface in the engine.
        Parameters:
        id - The id of the external task 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

      • getExternalTaskErrorDetailsCall

        public okhttp3.Call getExternalTaskErrorDetailsCall​(String id,
                                                    ApiCallback _callback)
                                             throws ApiException
        Build call for getExternalTaskErrorDetails
        Parameters:
        id - The id of the external task for which the error details should be retrieved. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getExternalTaskErrorDetails

        public String getExternalTaskErrorDetails​(String id)
                                   throws ApiException
        Get Error Details Retrieves the error details in the context of a running external task by id.
        Parameters:
        id - The id of the external task for which the error details should be retrieved. (required)
        Returns:
        String
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getExternalTaskErrorDetailsWithHttpInfo

        public ApiResponse<String> getExternalTaskErrorDetailsWithHttpInfo​(String id)
                                                            throws ApiException
        Get Error Details Retrieves the error details in the context of a running external task by id.
        Parameters:
        id - The id of the external task for which the error details should be retrieved. (required)
        Returns:
        ApiResponse<String>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getExternalTaskErrorDetailsAsync

        public okhttp3.Call getExternalTaskErrorDetailsAsync​(String id,
                                                     ApiCallback<String> _callback)
                                              throws ApiException
        Get Error Details (asynchronously) Retrieves the error details in the context of a running external task by id.
        Parameters:
        id - The id of the external task for which the error details should 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

      • getExternalTasksCall

        public okhttp3.Call getExternalTasksCall​(String externalTaskId,
                                         String externalTaskIdIn,
                                         String topicName,
                                         String workerId,
                                         Boolean locked,
                                         Boolean notLocked,
                                         Boolean withRetriesLeft,
                                         Boolean noRetriesLeft,
                                         Date lockExpirationAfter,
                                         Date lockExpirationBefore,
                                         String activityId,
                                         String activityIdIn,
                                         String executionId,
                                         String processInstanceId,
                                         String processInstanceIdIn,
                                         String processDefinitionId,
                                         String tenantIdIn,
                                         Boolean active,
                                         Boolean suspended,
                                         Long priorityHigherThanOrEquals,
                                         Long priorityLowerThanOrEquals,
                                         String sortBy,
                                         String sortOrder,
                                         Integer firstResult,
                                         Integer maxResults,
                                         ApiCallback _callback)
                                  throws ApiException
        Build call for getExternalTasks
        Parameters:
        externalTaskId - Filter by an external task's id. (optional)
        externalTaskIdIn - Filter by the comma-separated list of external task ids. (optional)
        topicName - Filter by an external task topic. (optional)
        workerId - Filter by the id of the worker that the task was most recently locked by. (optional)
        locked - Only include external tasks that are currently locked (i.e., they have a lock time and it has not expired). Value may only be `true`, as `false` matches any external task. (optional)
        notLocked - Only include external tasks that are currently not locked (i.e., they have no lock or it has expired). Value may only be `true`, as `false` matches any external task. (optional)
        withRetriesLeft - Only include external tasks that have a positive (&gt; 0) number of retries (or `null`). Value may only be `true`, as `false` matches any external task. (optional)
        noRetriesLeft - Only include external tasks that have 0 retries. Value may only be `true`, as `false` matches any external task. (optional)
        lockExpirationAfter - Restrict to external tasks that have a lock that expires after a 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)
        lockExpirationBefore - Restrict to external tasks that have a lock that expires before a 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 - Filter by the id of the activity that an external task is created for. (optional)
        activityIdIn - Filter by the comma-separated list of ids of the activities that an external task is created for. (optional)
        executionId - Filter by the id of the execution that an external task belongs to. (optional)
        processInstanceId - Filter by the id of the process instance that an external task belongs to. (optional)
        processInstanceIdIn - Filter by a comma-separated list of process instance ids that an external task may belong to. (optional)
        processDefinitionId - Filter by the id of the process definition that an external task belongs to. (optional)
        tenantIdIn - Filter by a comma-separated list of tenant ids. An external task must have one of the given tenant ids. (optional)
        active - Only include active tasks. Value may only be `true`, as `false` matches any external task. (optional)
        suspended - Only include suspended tasks. Value may only be `true`, as `false` matches any external task. (optional)
        priorityHigherThanOrEquals - Only include jobs with a priority higher than or equal to the given value. Value must be a valid `long` value. (optional)
        priorityLowerThanOrEquals - Only include jobs with a priority lower than or equal to the given value. Value must be a valid `long` value. (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)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getExternalTasks

        public List<ExternalTaskDto> getExternalTasks​(String externalTaskId,
                                              String externalTaskIdIn,
                                              String topicName,
                                              String workerId,
                                              Boolean locked,
                                              Boolean notLocked,
                                              Boolean withRetriesLeft,
                                              Boolean noRetriesLeft,
                                              Date lockExpirationAfter,
                                              Date lockExpirationBefore,
                                              String activityId,
                                              String activityIdIn,
                                              String executionId,
                                              String processInstanceId,
                                              String processInstanceIdIn,
                                              String processDefinitionId,
                                              String tenantIdIn,
                                              Boolean active,
                                              Boolean suspended,
                                              Long priorityHigherThanOrEquals,
                                              Long priorityLowerThanOrEquals,
                                              String sortBy,
                                              String sortOrder,
                                              Integer firstResult,
                                              Integer maxResults)
                                       throws ApiException
        Get List Queries for the external tasks that fulfill given parameters. Parameters may be static as well as dynamic runtime properties of executions. The size of the result set can be retrieved by using the [Get External Task Count](https://docs.camunda.org/manual/7.18/reference/rest/external-task/get-query-count/) method.
        Parameters:
        externalTaskId - Filter by an external task's id. (optional)
        externalTaskIdIn - Filter by the comma-separated list of external task ids. (optional)
        topicName - Filter by an external task topic. (optional)
        workerId - Filter by the id of the worker that the task was most recently locked by. (optional)
        locked - Only include external tasks that are currently locked (i.e., they have a lock time and it has not expired). Value may only be `true`, as `false` matches any external task. (optional)
        notLocked - Only include external tasks that are currently not locked (i.e., they have no lock or it has expired). Value may only be `true`, as `false` matches any external task. (optional)
        withRetriesLeft - Only include external tasks that have a positive (&gt; 0) number of retries (or `null`). Value may only be `true`, as `false` matches any external task. (optional)
        noRetriesLeft - Only include external tasks that have 0 retries. Value may only be `true`, as `false` matches any external task. (optional)
        lockExpirationAfter - Restrict to external tasks that have a lock that expires after a 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)
        lockExpirationBefore - Restrict to external tasks that have a lock that expires before a 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 - Filter by the id of the activity that an external task is created for. (optional)
        activityIdIn - Filter by the comma-separated list of ids of the activities that an external task is created for. (optional)
        executionId - Filter by the id of the execution that an external task belongs to. (optional)
        processInstanceId - Filter by the id of the process instance that an external task belongs to. (optional)
        processInstanceIdIn - Filter by a comma-separated list of process instance ids that an external task may belong to. (optional)
        processDefinitionId - Filter by the id of the process definition that an external task belongs to. (optional)
        tenantIdIn - Filter by a comma-separated list of tenant ids. An external task must have one of the given tenant ids. (optional)
        active - Only include active tasks. Value may only be `true`, as `false` matches any external task. (optional)
        suspended - Only include suspended tasks. Value may only be `true`, as `false` matches any external task. (optional)
        priorityHigherThanOrEquals - Only include jobs with a priority higher than or equal to the given value. Value must be a valid `long` value. (optional)
        priorityLowerThanOrEquals - Only include jobs with a priority lower than or equal to the given value. Value must be a valid `long` value. (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<ExternalTaskDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getExternalTasksWithHttpInfo

        public ApiResponse<List<ExternalTaskDto>> getExternalTasksWithHttpInfo​(String externalTaskId,
                                                                       String externalTaskIdIn,
                                                                       String topicName,
                                                                       String workerId,
                                                                       Boolean locked,
                                                                       Boolean notLocked,
                                                                       Boolean withRetriesLeft,
                                                                       Boolean noRetriesLeft,
                                                                       Date lockExpirationAfter,
                                                                       Date lockExpirationBefore,
                                                                       String activityId,
                                                                       String activityIdIn,
                                                                       String executionId,
                                                                       String processInstanceId,
                                                                       String processInstanceIdIn,
                                                                       String processDefinitionId,
                                                                       String tenantIdIn,
                                                                       Boolean active,
                                                                       Boolean suspended,
                                                                       Long priorityHigherThanOrEquals,
                                                                       Long priorityLowerThanOrEquals,
                                                                       String sortBy,
                                                                       String sortOrder,
                                                                       Integer firstResult,
                                                                       Integer maxResults)
                                                                throws ApiException
        Get List Queries for the external tasks that fulfill given parameters. Parameters may be static as well as dynamic runtime properties of executions. The size of the result set can be retrieved by using the [Get External Task Count](https://docs.camunda.org/manual/7.18/reference/rest/external-task/get-query-count/) method.
        Parameters:
        externalTaskId - Filter by an external task's id. (optional)
        externalTaskIdIn - Filter by the comma-separated list of external task ids. (optional)
        topicName - Filter by an external task topic. (optional)
        workerId - Filter by the id of the worker that the task was most recently locked by. (optional)
        locked - Only include external tasks that are currently locked (i.e., they have a lock time and it has not expired). Value may only be `true`, as `false` matches any external task. (optional)
        notLocked - Only include external tasks that are currently not locked (i.e., they have no lock or it has expired). Value may only be `true`, as `false` matches any external task. (optional)
        withRetriesLeft - Only include external tasks that have a positive (&gt; 0) number of retries (or `null`). Value may only be `true`, as `false` matches any external task. (optional)
        noRetriesLeft - Only include external tasks that have 0 retries. Value may only be `true`, as `false` matches any external task. (optional)
        lockExpirationAfter - Restrict to external tasks that have a lock that expires after a 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)
        lockExpirationBefore - Restrict to external tasks that have a lock that expires before a 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 - Filter by the id of the activity that an external task is created for. (optional)
        activityIdIn - Filter by the comma-separated list of ids of the activities that an external task is created for. (optional)
        executionId - Filter by the id of the execution that an external task belongs to. (optional)
        processInstanceId - Filter by the id of the process instance that an external task belongs to. (optional)
        processInstanceIdIn - Filter by a comma-separated list of process instance ids that an external task may belong to. (optional)
        processDefinitionId - Filter by the id of the process definition that an external task belongs to. (optional)
        tenantIdIn - Filter by a comma-separated list of tenant ids. An external task must have one of the given tenant ids. (optional)
        active - Only include active tasks. Value may only be `true`, as `false` matches any external task. (optional)
        suspended - Only include suspended tasks. Value may only be `true`, as `false` matches any external task. (optional)
        priorityHigherThanOrEquals - Only include jobs with a priority higher than or equal to the given value. Value must be a valid `long` value. (optional)
        priorityLowerThanOrEquals - Only include jobs with a priority lower than or equal to the given value. Value must be a valid `long` value. (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:
        ApiResponse<List<ExternalTaskDto>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getExternalTasksAsync

        public okhttp3.Call getExternalTasksAsync​(String externalTaskId,
                                          String externalTaskIdIn,
                                          String topicName,
                                          String workerId,
                                          Boolean locked,
                                          Boolean notLocked,
                                          Boolean withRetriesLeft,
                                          Boolean noRetriesLeft,
                                          Date lockExpirationAfter,
                                          Date lockExpirationBefore,
                                          String activityId,
                                          String activityIdIn,
                                          String executionId,
                                          String processInstanceId,
                                          String processInstanceIdIn,
                                          String processDefinitionId,
                                          String tenantIdIn,
                                          Boolean active,
                                          Boolean suspended,
                                          Long priorityHigherThanOrEquals,
                                          Long priorityLowerThanOrEquals,
                                          String sortBy,
                                          String sortOrder,
                                          Integer firstResult,
                                          Integer maxResults,
                                          ApiCallback<List<ExternalTaskDto>> _callback)
                                   throws ApiException
        Get List (asynchronously) Queries for the external tasks that fulfill given parameters. Parameters may be static as well as dynamic runtime properties of executions. The size of the result set can be retrieved by using the [Get External Task Count](https://docs.camunda.org/manual/7.18/reference/rest/external-task/get-query-count/) method.
        Parameters:
        externalTaskId - Filter by an external task's id. (optional)
        externalTaskIdIn - Filter by the comma-separated list of external task ids. (optional)
        topicName - Filter by an external task topic. (optional)
        workerId - Filter by the id of the worker that the task was most recently locked by. (optional)
        locked - Only include external tasks that are currently locked (i.e., they have a lock time and it has not expired). Value may only be `true`, as `false` matches any external task. (optional)
        notLocked - Only include external tasks that are currently not locked (i.e., they have no lock or it has expired). Value may only be `true`, as `false` matches any external task. (optional)
        withRetriesLeft - Only include external tasks that have a positive (&gt; 0) number of retries (or `null`). Value may only be `true`, as `false` matches any external task. (optional)
        noRetriesLeft - Only include external tasks that have 0 retries. Value may only be `true`, as `false` matches any external task. (optional)
        lockExpirationAfter - Restrict to external tasks that have a lock that expires after a 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)
        lockExpirationBefore - Restrict to external tasks that have a lock that expires before a 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 - Filter by the id of the activity that an external task is created for. (optional)
        activityIdIn - Filter by the comma-separated list of ids of the activities that an external task is created for. (optional)
        executionId - Filter by the id of the execution that an external task belongs to. (optional)
        processInstanceId - Filter by the id of the process instance that an external task belongs to. (optional)
        processInstanceIdIn - Filter by a comma-separated list of process instance ids that an external task may belong to. (optional)
        processDefinitionId - Filter by the id of the process definition that an external task belongs to. (optional)
        tenantIdIn - Filter by a comma-separated list of tenant ids. An external task must have one of the given tenant ids. (optional)
        active - Only include active tasks. Value may only be `true`, as `false` matches any external task. (optional)
        suspended - Only include suspended tasks. Value may only be `true`, as `false` matches any external task. (optional)
        priorityHigherThanOrEquals - Only include jobs with a priority higher than or equal to the given value. Value must be a valid `long` value. (optional)
        priorityLowerThanOrEquals - Only include jobs with a priority lower than or equal to the given value. Value must be a valid `long` value. (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)
        _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

      • getExternalTasksCountCall

        public okhttp3.Call getExternalTasksCountCall​(String externalTaskId,
                                              String externalTaskIdIn,
                                              String topicName,
                                              String workerId,
                                              Boolean locked,
                                              Boolean notLocked,
                                              Boolean withRetriesLeft,
                                              Boolean noRetriesLeft,
                                              Date lockExpirationAfter,
                                              Date lockExpirationBefore,
                                              String activityId,
                                              String activityIdIn,
                                              String executionId,
                                              String processInstanceId,
                                              String processInstanceIdIn,
                                              String processDefinitionId,
                                              String tenantIdIn,
                                              Boolean active,
                                              Boolean suspended,
                                              Long priorityHigherThanOrEquals,
                                              Long priorityLowerThanOrEquals,
                                              ApiCallback _callback)
                                       throws ApiException
        Build call for getExternalTasksCount
        Parameters:
        externalTaskId - Filter by an external task's id. (optional)
        externalTaskIdIn - Filter by the comma-separated list of external task ids. (optional)
        topicName - Filter by an external task topic. (optional)
        workerId - Filter by the id of the worker that the task was most recently locked by. (optional)
        locked - Only include external tasks that are currently locked (i.e., they have a lock time and it has not expired). Value may only be `true`, as `false` matches any external task. (optional)
        notLocked - Only include external tasks that are currently not locked (i.e., they have no lock or it has expired). Value may only be `true`, as `false` matches any external task. (optional)
        withRetriesLeft - Only include external tasks that have a positive (&gt; 0) number of retries (or `null`). Value may only be `true`, as `false` matches any external task. (optional)
        noRetriesLeft - Only include external tasks that have 0 retries. Value may only be `true`, as `false` matches any external task. (optional)
        lockExpirationAfter - Restrict to external tasks that have a lock that expires after a 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)
        lockExpirationBefore - Restrict to external tasks that have a lock that expires before a 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 - Filter by the id of the activity that an external task is created for. (optional)
        activityIdIn - Filter by the comma-separated list of ids of the activities that an external task is created for. (optional)
        executionId - Filter by the id of the execution that an external task belongs to. (optional)
        processInstanceId - Filter by the id of the process instance that an external task belongs to. (optional)
        processInstanceIdIn - Filter by a comma-separated list of process instance ids that an external task may belong to. (optional)
        processDefinitionId - Filter by the id of the process definition that an external task belongs to. (optional)
        tenantIdIn - Filter by a comma-separated list of tenant ids. An external task must have one of the given tenant ids. (optional)
        active - Only include active tasks. Value may only be `true`, as `false` matches any external task. (optional)
        suspended - Only include suspended tasks. Value may only be `true`, as `false` matches any external task. (optional)
        priorityHigherThanOrEquals - Only include jobs with a priority higher than or equal to the given value. Value must be a valid `long` value. (optional)
        priorityLowerThanOrEquals - Only include jobs with a priority lower than or equal to the given value. Value must be a valid `long` value. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getExternalTasksCount

        public CountResultDto getExternalTasksCount​(String externalTaskId,
                                            String externalTaskIdIn,
                                            String topicName,
                                            String workerId,
                                            Boolean locked,
                                            Boolean notLocked,
                                            Boolean withRetriesLeft,
                                            Boolean noRetriesLeft,
                                            Date lockExpirationAfter,
                                            Date lockExpirationBefore,
                                            String activityId,
                                            String activityIdIn,
                                            String executionId,
                                            String processInstanceId,
                                            String processInstanceIdIn,
                                            String processDefinitionId,
                                            String tenantIdIn,
                                            Boolean active,
                                            Boolean suspended,
                                            Long priorityHigherThanOrEquals,
                                            Long priorityLowerThanOrEquals)
                                     throws ApiException
        Get List Count Queries for the number of external tasks that fulfill given parameters. Takes the same parameters as the [Get External Tasks](https://docs.camunda.org/manual/7.18/reference/rest/external-task/get-query/) method.
        Parameters:
        externalTaskId - Filter by an external task's id. (optional)
        externalTaskIdIn - Filter by the comma-separated list of external task ids. (optional)
        topicName - Filter by an external task topic. (optional)
        workerId - Filter by the id of the worker that the task was most recently locked by. (optional)
        locked - Only include external tasks that are currently locked (i.e., they have a lock time and it has not expired). Value may only be `true`, as `false` matches any external task. (optional)
        notLocked - Only include external tasks that are currently not locked (i.e., they have no lock or it has expired). Value may only be `true`, as `false` matches any external task. (optional)
        withRetriesLeft - Only include external tasks that have a positive (&gt; 0) number of retries (or `null`). Value may only be `true`, as `false` matches any external task. (optional)
        noRetriesLeft - Only include external tasks that have 0 retries. Value may only be `true`, as `false` matches any external task. (optional)
        lockExpirationAfter - Restrict to external tasks that have a lock that expires after a 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)
        lockExpirationBefore - Restrict to external tasks that have a lock that expires before a 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 - Filter by the id of the activity that an external task is created for. (optional)
        activityIdIn - Filter by the comma-separated list of ids of the activities that an external task is created for. (optional)
        executionId - Filter by the id of the execution that an external task belongs to. (optional)
        processInstanceId - Filter by the id of the process instance that an external task belongs to. (optional)
        processInstanceIdIn - Filter by a comma-separated list of process instance ids that an external task may belong to. (optional)
        processDefinitionId - Filter by the id of the process definition that an external task belongs to. (optional)
        tenantIdIn - Filter by a comma-separated list of tenant ids. An external task must have one of the given tenant ids. (optional)
        active - Only include active tasks. Value may only be `true`, as `false` matches any external task. (optional)
        suspended - Only include suspended tasks. Value may only be `true`, as `false` matches any external task. (optional)
        priorityHigherThanOrEquals - Only include jobs with a priority higher than or equal to the given value. Value must be a valid `long` value. (optional)
        priorityLowerThanOrEquals - Only include jobs with a priority lower than or equal to the given value. Value must be a valid `long` value. (optional)
        Returns:
        CountResultDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getExternalTasksCountWithHttpInfo

        public ApiResponse<CountResultDto> getExternalTasksCountWithHttpInfo​(String externalTaskId,
                                                                     String externalTaskIdIn,
                                                                     String topicName,
                                                                     String workerId,
                                                                     Boolean locked,
                                                                     Boolean notLocked,
                                                                     Boolean withRetriesLeft,
                                                                     Boolean noRetriesLeft,
                                                                     Date lockExpirationAfter,
                                                                     Date lockExpirationBefore,
                                                                     String activityId,
                                                                     String activityIdIn,
                                                                     String executionId,
                                                                     String processInstanceId,
                                                                     String processInstanceIdIn,
                                                                     String processDefinitionId,
                                                                     String tenantIdIn,
                                                                     Boolean active,
                                                                     Boolean suspended,
                                                                     Long priorityHigherThanOrEquals,
                                                                     Long priorityLowerThanOrEquals)
                                                              throws ApiException
        Get List Count Queries for the number of external tasks that fulfill given parameters. Takes the same parameters as the [Get External Tasks](https://docs.camunda.org/manual/7.18/reference/rest/external-task/get-query/) method.
        Parameters:
        externalTaskId - Filter by an external task's id. (optional)
        externalTaskIdIn - Filter by the comma-separated list of external task ids. (optional)
        topicName - Filter by an external task topic. (optional)
        workerId - Filter by the id of the worker that the task was most recently locked by. (optional)
        locked - Only include external tasks that are currently locked (i.e., they have a lock time and it has not expired). Value may only be `true`, as `false` matches any external task. (optional)
        notLocked - Only include external tasks that are currently not locked (i.e., they have no lock or it has expired). Value may only be `true`, as `false` matches any external task. (optional)
        withRetriesLeft - Only include external tasks that have a positive (&gt; 0) number of retries (or `null`). Value may only be `true`, as `false` matches any external task. (optional)
        noRetriesLeft - Only include external tasks that have 0 retries. Value may only be `true`, as `false` matches any external task. (optional)
        lockExpirationAfter - Restrict to external tasks that have a lock that expires after a 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)
        lockExpirationBefore - Restrict to external tasks that have a lock that expires before a 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 - Filter by the id of the activity that an external task is created for. (optional)
        activityIdIn - Filter by the comma-separated list of ids of the activities that an external task is created for. (optional)
        executionId - Filter by the id of the execution that an external task belongs to. (optional)
        processInstanceId - Filter by the id of the process instance that an external task belongs to. (optional)
        processInstanceIdIn - Filter by a comma-separated list of process instance ids that an external task may belong to. (optional)
        processDefinitionId - Filter by the id of the process definition that an external task belongs to. (optional)
        tenantIdIn - Filter by a comma-separated list of tenant ids. An external task must have one of the given tenant ids. (optional)
        active - Only include active tasks. Value may only be `true`, as `false` matches any external task. (optional)
        suspended - Only include suspended tasks. Value may only be `true`, as `false` matches any external task. (optional)
        priorityHigherThanOrEquals - Only include jobs with a priority higher than or equal to the given value. Value must be a valid `long` value. (optional)
        priorityLowerThanOrEquals - Only include jobs with a priority lower than or equal to the given value. Value must be a valid `long` value. (optional)
        Returns:
        ApiResponse<CountResultDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getExternalTasksCountAsync

        public okhttp3.Call getExternalTasksCountAsync​(String externalTaskId,
                                               String externalTaskIdIn,
                                               String topicName,
                                               String workerId,
                                               Boolean locked,
                                               Boolean notLocked,
                                               Boolean withRetriesLeft,
                                               Boolean noRetriesLeft,
                                               Date lockExpirationAfter,
                                               Date lockExpirationBefore,
                                               String activityId,
                                               String activityIdIn,
                                               String executionId,
                                               String processInstanceId,
                                               String processInstanceIdIn,
                                               String processDefinitionId,
                                               String tenantIdIn,
                                               Boolean active,
                                               Boolean suspended,
                                               Long priorityHigherThanOrEquals,
                                               Long priorityLowerThanOrEquals,
                                               ApiCallback<CountResultDto> _callback)
                                        throws ApiException
        Get List Count (asynchronously) Queries for the number of external tasks that fulfill given parameters. Takes the same parameters as the [Get External Tasks](https://docs.camunda.org/manual/7.18/reference/rest/external-task/get-query/) method.
        Parameters:
        externalTaskId - Filter by an external task's id. (optional)
        externalTaskIdIn - Filter by the comma-separated list of external task ids. (optional)
        topicName - Filter by an external task topic. (optional)
        workerId - Filter by the id of the worker that the task was most recently locked by. (optional)
        locked - Only include external tasks that are currently locked (i.e., they have a lock time and it has not expired). Value may only be `true`, as `false` matches any external task. (optional)
        notLocked - Only include external tasks that are currently not locked (i.e., they have no lock or it has expired). Value may only be `true`, as `false` matches any external task. (optional)
        withRetriesLeft - Only include external tasks that have a positive (&gt; 0) number of retries (or `null`). Value may only be `true`, as `false` matches any external task. (optional)
        noRetriesLeft - Only include external tasks that have 0 retries. Value may only be `true`, as `false` matches any external task. (optional)
        lockExpirationAfter - Restrict to external tasks that have a lock that expires after a 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)
        lockExpirationBefore - Restrict to external tasks that have a lock that expires before a 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 - Filter by the id of the activity that an external task is created for. (optional)
        activityIdIn - Filter by the comma-separated list of ids of the activities that an external task is created for. (optional)
        executionId - Filter by the id of the execution that an external task belongs to. (optional)
        processInstanceId - Filter by the id of the process instance that an external task belongs to. (optional)
        processInstanceIdIn - Filter by a comma-separated list of process instance ids that an external task may belong to. (optional)
        processDefinitionId - Filter by the id of the process definition that an external task belongs to. (optional)
        tenantIdIn - Filter by a comma-separated list of tenant ids. An external task must have one of the given tenant ids. (optional)
        active - Only include active tasks. Value may only be `true`, as `false` matches any external task. (optional)
        suspended - Only include suspended tasks. Value may only be `true`, as `false` matches any external task. (optional)
        priorityHigherThanOrEquals - Only include jobs with a priority higher than or equal to the given value. Value must be a valid `long` value. (optional)
        priorityLowerThanOrEquals - Only include jobs with a priority lower than or equal to the given value. Value must be a valid `long` value. (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

      • getTopicNamesCall

        public okhttp3.Call getTopicNamesCall​(Boolean withLockedTasks,
                                      Boolean withUnlockedTasks,
                                      Boolean withRetriesLeft,
                                      ApiCallback _callback)
                               throws ApiException
        Build call for getTopicNames
        Parameters:
        withLockedTasks - Only include external tasks that are currently locked (i.e., they have a lock time and it has not expired). Value may only be `true`, as `false` matches any external task. (optional)
        withUnlockedTasks - Only include external tasks that are currently not locked (i.e., they have no lock or it has expired). Value may only be `true`, as `false` matches any external task. (optional)
        withRetriesLeft - Only include external tasks that have a positive (&gt; 0) number of retries (or `null`). Value may only be `true`, as `false` matches any external task. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getTopicNames

        public List<String> getTopicNames​(Boolean withLockedTasks,
                                  Boolean withUnlockedTasks,
                                  Boolean withRetriesLeft)
                           throws ApiException
        Get External Task Topic Names Queries for distinct topic names of external tasks that fulfill given parameters. Query can be restricted to only tasks with retries left, tasks that are locked, or tasks that are unlocked. The parameters withLockedTasks and withUnlockedTasks are exclusive. Setting them both to true will return an empty list. Providing no parameters will return a list of all distinct topic names with external tasks.
        Parameters:
        withLockedTasks - Only include external tasks that are currently locked (i.e., they have a lock time and it has not expired). Value may only be `true`, as `false` matches any external task. (optional)
        withUnlockedTasks - Only include external tasks that are currently not locked (i.e., they have no lock or it has expired). Value may only be `true`, as `false` matches any external task. (optional)
        withRetriesLeft - Only include external tasks that have a positive (&gt; 0) number of retries (or `null`). Value may only be `true`, as `false` matches any external task. (optional)
        Returns:
        List<String>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getTopicNamesWithHttpInfo

        public ApiResponse<List<String>> getTopicNamesWithHttpInfo​(Boolean withLockedTasks,
                                                           Boolean withUnlockedTasks,
                                                           Boolean withRetriesLeft)
                                                    throws ApiException
        Get External Task Topic Names Queries for distinct topic names of external tasks that fulfill given parameters. Query can be restricted to only tasks with retries left, tasks that are locked, or tasks that are unlocked. The parameters withLockedTasks and withUnlockedTasks are exclusive. Setting them both to true will return an empty list. Providing no parameters will return a list of all distinct topic names with external tasks.
        Parameters:
        withLockedTasks - Only include external tasks that are currently locked (i.e., they have a lock time and it has not expired). Value may only be `true`, as `false` matches any external task. (optional)
        withUnlockedTasks - Only include external tasks that are currently not locked (i.e., they have no lock or it has expired). Value may only be `true`, as `false` matches any external task. (optional)
        withRetriesLeft - Only include external tasks that have a positive (&gt; 0) number of retries (or `null`). Value may only be `true`, as `false` matches any external task. (optional)
        Returns:
        ApiResponse<List<String>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getTopicNamesAsync

        public okhttp3.Call getTopicNamesAsync​(Boolean withLockedTasks,
                                       Boolean withUnlockedTasks,
                                       Boolean withRetriesLeft,
                                       ApiCallback<List<String>> _callback)
                                throws ApiException
        Get External Task Topic Names (asynchronously) Queries for distinct topic names of external tasks that fulfill given parameters. Query can be restricted to only tasks with retries left, tasks that are locked, or tasks that are unlocked. The parameters withLockedTasks and withUnlockedTasks are exclusive. Setting them both to true will return an empty list. Providing no parameters will return a list of all distinct topic names with external tasks.
        Parameters:
        withLockedTasks - Only include external tasks that are currently locked (i.e., they have a lock time and it has not expired). Value may only be `true`, as `false` matches any external task. (optional)
        withUnlockedTasks - Only include external tasks that are currently not locked (i.e., they have no lock or it has expired). Value may only be `true`, as `false` matches any external task. (optional)
        withRetriesLeft - Only include external tasks that have a positive (&gt; 0) number of retries (or `null`). Value may only be `true`, as `false` matches any external task. (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

      • handleExternalTaskBpmnErrorCall

        public okhttp3.Call handleExternalTaskBpmnErrorCall​(String id,
                                                    ExternalTaskBpmnError externalTaskBpmnError,
                                                    ApiCallback _callback)
                                             throws ApiException
        Build call for handleExternalTaskBpmnError
        Parameters:
        id - The id of the external task in which context a BPMN error is reported. (required)
        externalTaskBpmnError - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • handleExternalTaskBpmnError

        public void handleExternalTaskBpmnError​(String id,
                                        ExternalTaskBpmnError externalTaskBpmnError)
                                 throws ApiException
        Handle BPMN Error Reports a business error in the context of a running external task by id. The error code must be specified to identify the BPMN error handler.
        Parameters:
        id - The id of the external task in which context a BPMN error is reported. (required)
        externalTaskBpmnError - (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • handleExternalTaskBpmnErrorWithHttpInfo

        public ApiResponse<Void> handleExternalTaskBpmnErrorWithHttpInfo​(String id,
                                                                 ExternalTaskBpmnError externalTaskBpmnError)
                                                          throws ApiException
        Handle BPMN Error Reports a business error in the context of a running external task by id. The error code must be specified to identify the BPMN error handler.
        Parameters:
        id - The id of the external task in which context a BPMN error is reported. (required)
        externalTaskBpmnError - (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • handleExternalTaskBpmnErrorAsync

        public okhttp3.Call handleExternalTaskBpmnErrorAsync​(String id,
                                                     ExternalTaskBpmnError externalTaskBpmnError,
                                                     ApiCallback<Void> _callback)
                                              throws ApiException
        Handle BPMN Error (asynchronously) Reports a business error in the context of a running external task by id. The error code must be specified to identify the BPMN error handler.
        Parameters:
        id - The id of the external task in which context a BPMN error is reported. (required)
        externalTaskBpmnError - (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

      • handleFailureCall

        public okhttp3.Call handleFailureCall​(String id,
                                      ExternalTaskFailureDto externalTaskFailureDto,
                                      ApiCallback _callback)
                               throws ApiException
        Build call for handleFailure
        Parameters:
        id - The id of the external task to report a failure for. (required)
        externalTaskFailureDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • handleFailure

        public void handleFailure​(String id,
                          ExternalTaskFailureDto externalTaskFailureDto)
                   throws ApiException
        Handle Failure Reports a failure to execute an external task by id. A number of retries and a timeout until the task can be retried can be specified. If retries are set to 0, an incident for this task is created.
        Parameters:
        id - The id of the external task to report a failure for. (required)
        externalTaskFailureDto - (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • handleFailureWithHttpInfo

        public ApiResponse<Void> handleFailureWithHttpInfo​(String id,
                                                   ExternalTaskFailureDto externalTaskFailureDto)
                                            throws ApiException
        Handle Failure Reports a failure to execute an external task by id. A number of retries and a timeout until the task can be retried can be specified. If retries are set to 0, an incident for this task is created.
        Parameters:
        id - The id of the external task to report a failure for. (required)
        externalTaskFailureDto - (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • handleFailureAsync

        public okhttp3.Call handleFailureAsync​(String id,
                                       ExternalTaskFailureDto externalTaskFailureDto,
                                       ApiCallback<Void> _callback)
                                throws ApiException
        Handle Failure (asynchronously) Reports a failure to execute an external task by id. A number of retries and a timeout until the task can be retried can be specified. If retries are set to 0, an incident for this task is created.
        Parameters:
        id - The id of the external task to report a failure for. (required)
        externalTaskFailureDto - (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

      • lockCall

        public okhttp3.Call lockCall​(String id,
                             LockExternalTaskDto lockExternalTaskDto,
                             ApiCallback _callback)
                      throws ApiException
        Build call for lock
        Parameters:
        id - The id of the external task. (required)
        lockExternalTaskDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • lock

        public void lock​(String id,
                 LockExternalTaskDto lockExternalTaskDto)
          throws ApiException
        Lock an external task by a given id for a specified worker and amount of time.
        Parameters:
        id - The id of the external task. (required)
        lockExternalTaskDto - (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • lockWithHttpInfo

        public ApiResponse<Void> lockWithHttpInfo​(String id,
                                          LockExternalTaskDto lockExternalTaskDto)
                                   throws ApiException
        Lock an external task by a given id for a specified worker and amount of time.
        Parameters:
        id - The id of the external task. (required)
        lockExternalTaskDto - (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • lockAsync

        public okhttp3.Call lockAsync​(String id,
                              LockExternalTaskDto lockExternalTaskDto,
                              ApiCallback<Void> _callback)
                       throws ApiException
        (asynchronously) Lock an external task by a given id for a specified worker and amount of time.
        Parameters:
        id - The id of the external task. (required)
        lockExternalTaskDto - (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

      • queryExternalTasksCall

        public okhttp3.Call queryExternalTasksCall​(Integer firstResult,
                                           Integer maxResults,
                                           ExternalTaskQueryDto externalTaskQueryDto,
                                           ApiCallback _callback)
                                    throws ApiException
        Build call for queryExternalTasks
        Parameters:
        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)
        externalTaskQueryDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • queryExternalTasks

        public List<ExternalTaskDto> queryExternalTasks​(Integer firstResult,
                                                Integer maxResults,
                                                ExternalTaskQueryDto externalTaskQueryDto)
                                         throws ApiException
        Get List (POST) Queries for external tasks that fulfill given parameters in the form of a JSON object. This method is slightly more powerful than the [Get External Tasks](https://docs.camunda.org/manual/7.18/reference/rest/external-task/get-query/) method because it allows to specify a hierarchical result sorting.
        Parameters:
        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)
        externalTaskQueryDto - (optional)
        Returns:
        List<ExternalTaskDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • queryExternalTasksWithHttpInfo

        public ApiResponse<List<ExternalTaskDto>> queryExternalTasksWithHttpInfo​(Integer firstResult,
                                                                         Integer maxResults,
                                                                         ExternalTaskQueryDto externalTaskQueryDto)
                                                                  throws ApiException
        Get List (POST) Queries for external tasks that fulfill given parameters in the form of a JSON object. This method is slightly more powerful than the [Get External Tasks](https://docs.camunda.org/manual/7.18/reference/rest/external-task/get-query/) method because it allows to specify a hierarchical result sorting.
        Parameters:
        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)
        externalTaskQueryDto - (optional)
        Returns:
        ApiResponse<List<ExternalTaskDto>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • queryExternalTasksAsync

        public okhttp3.Call queryExternalTasksAsync​(Integer firstResult,
                                            Integer maxResults,
                                            ExternalTaskQueryDto externalTaskQueryDto,
                                            ApiCallback<List<ExternalTaskDto>> _callback)
                                     throws ApiException
        Get List (POST) (asynchronously) Queries for external tasks that fulfill given parameters in the form of a JSON object. This method is slightly more powerful than the [Get External Tasks](https://docs.camunda.org/manual/7.18/reference/rest/external-task/get-query/) method because it allows to specify a hierarchical result sorting.
        Parameters:
        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)
        externalTaskQueryDto - (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

      • queryExternalTasksCountCall

        public okhttp3.Call queryExternalTasksCountCall​(ExternalTaskQueryDto externalTaskQueryDto,
                                                ApiCallback _callback)
                                         throws ApiException
        Build call for queryExternalTasksCount
        Parameters:
        externalTaskQueryDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • queryExternalTasksCount

        public CountResultDto queryExternalTasksCount​(ExternalTaskQueryDto externalTaskQueryDto)
                                       throws ApiException
        Get List Count (POST) Queries for the number of external tasks that fulfill given parameters. This method takes the same message body as the [Get External Tasks (POST)](https://docs.camunda.org/manual/7.18/reference/rest/external-task/post-query/) method.
        Parameters:
        externalTaskQueryDto - (optional)
        Returns:
        CountResultDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • queryExternalTasksCountWithHttpInfo

        public ApiResponse<CountResultDto> queryExternalTasksCountWithHttpInfo​(ExternalTaskQueryDto externalTaskQueryDto)
                                                                throws ApiException
        Get List Count (POST) Queries for the number of external tasks that fulfill given parameters. This method takes the same message body as the [Get External Tasks (POST)](https://docs.camunda.org/manual/7.18/reference/rest/external-task/post-query/) method.
        Parameters:
        externalTaskQueryDto - (optional)
        Returns:
        ApiResponse<CountResultDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • queryExternalTasksCountAsync

        public okhttp3.Call queryExternalTasksCountAsync​(ExternalTaskQueryDto externalTaskQueryDto,
                                                 ApiCallback<CountResultDto> _callback)
                                          throws ApiException
        Get List Count (POST) (asynchronously) Queries for the number of external tasks that fulfill given parameters. This method takes the same message body as the [Get External Tasks (POST)](https://docs.camunda.org/manual/7.18/reference/rest/external-task/post-query/) method.
        Parameters:
        externalTaskQueryDto - (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

      • setExternalTaskResourcePriorityCall

        public okhttp3.Call setExternalTaskResourcePriorityCall​(String id,
                                                        PriorityDto priorityDto,
                                                        ApiCallback _callback)
                                                 throws ApiException
        Build call for setExternalTaskResourcePriority
        Parameters:
        id - The id of the external task to set the priority for. (required)
        priorityDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • setExternalTaskResourcePriority

        public void setExternalTaskResourcePriority​(String id,
                                            PriorityDto priorityDto)
                                     throws ApiException
        Set Priority Sets the priority of an existing external task by id. The default value of a priority is 0.
        Parameters:
        id - The id of the external task to set the priority for. (required)
        priorityDto - (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • setExternalTaskResourcePriorityWithHttpInfo

        public ApiResponse<Void> setExternalTaskResourcePriorityWithHttpInfo​(String id,
                                                                     PriorityDto priorityDto)
                                                              throws ApiException
        Set Priority Sets the priority of an existing external task by id. The default value of a priority is 0.
        Parameters:
        id - The id of the external task to set the priority for. (required)
        priorityDto - (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • setExternalTaskResourcePriorityAsync

        public okhttp3.Call setExternalTaskResourcePriorityAsync​(String id,
                                                         PriorityDto priorityDto,
                                                         ApiCallback<Void> _callback)
                                                  throws ApiException
        Set Priority (asynchronously) Sets the priority of an existing external task by id. The default value of a priority is 0.
        Parameters:
        id - The id of the external task to set the priority for. (required)
        priorityDto - (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

      • setExternalTaskResourceRetriesCall

        public okhttp3.Call setExternalTaskResourceRetriesCall​(String id,
                                                       RetriesDto retriesDto,
                                                       ApiCallback _callback)
                                                throws ApiException
        Build call for setExternalTaskResourceRetries
        Parameters:
        id - The id of the external task to set the number of retries for. (required)
        retriesDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • setExternalTaskResourceRetries

        public void setExternalTaskResourceRetries​(String id,
                                           RetriesDto retriesDto)
                                    throws ApiException
        Set Retries Sets the number of retries left to execute an external task by id. If retries are set to 0, an incident is created.
        Parameters:
        id - The id of the external task to set the number of retries for. (required)
        retriesDto - (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • setExternalTaskResourceRetriesWithHttpInfo

        public ApiResponse<Void> setExternalTaskResourceRetriesWithHttpInfo​(String id,
                                                                    RetriesDto retriesDto)
                                                             throws ApiException
        Set Retries Sets the number of retries left to execute an external task by id. If retries are set to 0, an incident is created.
        Parameters:
        id - The id of the external task to set the number of retries for. (required)
        retriesDto - (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • setExternalTaskResourceRetriesAsync

        public okhttp3.Call setExternalTaskResourceRetriesAsync​(String id,
                                                        RetriesDto retriesDto,
                                                        ApiCallback<Void> _callback)
                                                 throws ApiException
        Set Retries (asynchronously) Sets the number of retries left to execute an external task by id. If retries are set to 0, an incident is created.
        Parameters:
        id - The id of the external task to set the number of retries for. (required)
        retriesDto - (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

      • setExternalTaskRetriesCall

        public okhttp3.Call setExternalTaskRetriesCall​(SetRetriesForExternalTasksDto setRetriesForExternalTasksDto,
                                               ApiCallback _callback)
                                        throws ApiException
        Build call for setExternalTaskRetries
        Parameters:
        setRetriesForExternalTasksDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • setExternalTaskRetries

        public void setExternalTaskRetries​(SetRetriesForExternalTasksDto setRetriesForExternalTasksDto)
                            throws ApiException
        Set Retries Sync Sets the number of retries left to execute external tasks by id synchronously. If retries are set to 0, an incident is created.
        Parameters:
        setRetriesForExternalTasksDto - (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • setExternalTaskRetriesWithHttpInfo

        public ApiResponse<Void> setExternalTaskRetriesWithHttpInfo​(SetRetriesForExternalTasksDto setRetriesForExternalTasksDto)
                                                     throws ApiException
        Set Retries Sync Sets the number of retries left to execute external tasks by id synchronously. If retries are set to 0, an incident is created.
        Parameters:
        setRetriesForExternalTasksDto - (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • setExternalTaskRetriesAsync

        public okhttp3.Call setExternalTaskRetriesAsync​(SetRetriesForExternalTasksDto setRetriesForExternalTasksDto,
                                                ApiCallback<Void> _callback)
                                         throws ApiException
        Set Retries Sync (asynchronously) Sets the number of retries left to execute external tasks by id synchronously. If retries are set to 0, an incident is created.
        Parameters:
        setRetriesForExternalTasksDto - (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

      • setExternalTaskRetriesAsyncOperationCall

        public okhttp3.Call setExternalTaskRetriesAsyncOperationCall​(SetRetriesForExternalTasksDto setRetriesForExternalTasksDto,
                                                             ApiCallback _callback)
                                                      throws ApiException
        Build call for setExternalTaskRetriesAsyncOperation
        Parameters:
        setRetriesForExternalTasksDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • setExternalTaskRetriesAsyncOperation

        public BatchDto setExternalTaskRetriesAsyncOperation​(SetRetriesForExternalTasksDto setRetriesForExternalTasksDto)
                                              throws ApiException
        Set Retries Async Sets the number of retries left to execute external tasks by id asynchronously. If retries are set to 0, an incident is created.
        Parameters:
        setRetriesForExternalTasksDto - (optional)
        Returns:
        BatchDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • setExternalTaskRetriesAsyncOperationWithHttpInfo

        public ApiResponse<BatchDto> setExternalTaskRetriesAsyncOperationWithHttpInfo​(SetRetriesForExternalTasksDto setRetriesForExternalTasksDto)
                                                                       throws ApiException
        Set Retries Async Sets the number of retries left to execute external tasks by id asynchronously. If retries are set to 0, an incident is created.
        Parameters:
        setRetriesForExternalTasksDto - (optional)
        Returns:
        ApiResponse<BatchDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • setExternalTaskRetriesAsyncOperationAsync

        public okhttp3.Call setExternalTaskRetriesAsyncOperationAsync​(SetRetriesForExternalTasksDto setRetriesForExternalTasksDto,
                                                              ApiCallback<BatchDto> _callback)
                                                       throws ApiException
        Set Retries Async (asynchronously) Sets the number of retries left to execute external tasks by id asynchronously. If retries are set to 0, an incident is created.
        Parameters:
        setRetriesForExternalTasksDto - (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

      • unlockCall

        public okhttp3.Call unlockCall​(String id,
                               ApiCallback _callback)
                        throws ApiException
        Build call for unlock
        Parameters:
        id - The id of the external task to unlock. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • unlock

        public void unlock​(String id)
            throws ApiException
        Unlock Unlocks an external task by id. Clears the task's lock expiration time and worker id.
        Parameters:
        id - The id of the external task to unlock. (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • unlockWithHttpInfo

        public ApiResponse<Void> unlockWithHttpInfo​(String id)
                                     throws ApiException
        Unlock Unlocks an external task by id. Clears the task's lock expiration time and worker id.
        Parameters:
        id - The id of the external task to unlock. (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • unlockAsync

        public okhttp3.Call unlockAsync​(String id,
                                ApiCallback<Void> _callback)
                         throws ApiException
        Unlock (asynchronously) Unlocks an external task by id. Clears the task's lock expiration time and worker id.
        Parameters:
        id - The id of the external task to unlock. (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