Package org.openapitools.client.api

Class JobDefinitionApi

  • public class JobDefinitionApi
extends Object

    • Constructor Detail

      • JobDefinitionApi

        public JobDefinitionApi()

      • JobDefinitionApi

        public JobDefinitionApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • getJobDefinitionCall

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

      • getJobDefinition

        public JobDefinitionDto getJobDefinition​(String id)
                                  throws ApiException
        Get Job Definition Retrieves a job definition by id, according to the `JobDefinition` interface in the engine.
        Parameters:
        id - The id of the job definition to be retrieved. (required)
        Returns:
        JobDefinitionDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getJobDefinitionWithHttpInfo

        public ApiResponse<JobDefinitionDto> getJobDefinitionWithHttpInfo​(String id)
                                                           throws ApiException
        Get Job Definition Retrieves a job definition by id, according to the `JobDefinition` interface in the engine.
        Parameters:
        id - The id of the job definition to be retrieved. (required)
        Returns:
        ApiResponse<JobDefinitionDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getJobDefinitionAsync

        public okhttp3.Call getJobDefinitionAsync​(String id,
                                          ApiCallback<JobDefinitionDto> _callback)
                                   throws ApiException
        Get Job Definition (asynchronously) Retrieves a job definition by id, according to the `JobDefinition` interface in the engine.
        Parameters:
        id - The id of the job definition 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

      • getJobDefinitionsCall

        public okhttp3.Call getJobDefinitionsCall​(String jobDefinitionId,
                                          String activityIdIn,
                                          String processDefinitionId,
                                          String processDefinitionKey,
                                          String jobType,
                                          String jobConfiguration,
                                          Boolean active,
                                          Boolean suspended,
                                          Boolean withOverridingJobPriority,
                                          String tenantIdIn,
                                          Boolean withoutTenantId,
                                          Boolean includeJobDefinitionsWithoutTenantId,
                                          String sortBy,
                                          String sortOrder,
                                          Integer firstResult,
                                          Integer maxResults,
                                          ApiCallback _callback)
                                   throws ApiException
        Build call for getJobDefinitions
        Parameters:
        jobDefinitionId - Filter by job definition id. (optional)
        activityIdIn - Only include job definitions which belong to one of the passed and comma-separated activity ids. (optional)
        processDefinitionId - Only include job definitions which exist for the given process definition id. (optional)
        processDefinitionKey - Only include job definitions which exist for the given process definition key. (optional)
        jobType - Only include job definitions which exist for the given job type. See the [User Guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/the-job-executor/#job-creation) for more information about job types. (optional)
        jobConfiguration - Only include job definitions which exist for the given job configuration. For example: for timer jobs it is the timer configuration. (optional)
        active - Only include active job definitions. Value may only be `true`, as `false` is the default behavior. (optional)
        suspended - Only include suspended job definitions. Value may only be `true`, as `false` is the default behavior. (optional)
        withOverridingJobPriority - Only include job definitions that have an overriding job priority defined. The only effective value is `true`. If set to `false`, this filter is not applied. (optional)
        tenantIdIn - Only include job definitions which belong to one of the passed and comma-separated tenant ids. (optional)
        withoutTenantId - Only include job definitions which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
        includeJobDefinitionsWithoutTenantId - Include job definitions which belong to no tenant. Can be used in combination with `tenantIdIn`. Value may only be `true`, as `false` is the default behavior. (optional)
        sortBy - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)
        sortOrder - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (optional)
        firstResult - Pagination of results. Specifies the index of the first result to return. (optional)
        maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getJobDefinitions

        public List<JobDefinitionDto> getJobDefinitions​(String jobDefinitionId,
                                                String activityIdIn,
                                                String processDefinitionId,
                                                String processDefinitionKey,
                                                String jobType,
                                                String jobConfiguration,
                                                Boolean active,
                                                Boolean suspended,
                                                Boolean withOverridingJobPriority,
                                                String tenantIdIn,
                                                Boolean withoutTenantId,
                                                Boolean includeJobDefinitionsWithoutTenantId,
                                                String sortBy,
                                                String sortOrder,
                                                Integer firstResult,
                                                Integer maxResults)
                                         throws ApiException
        Get Job Definitions Queries for job definitions that fulfill given parameters. The size of the result set can be retrieved by using the [Get Job Definition Count](https://docs.camunda.org/manual/7.18/reference/rest/job-definition/get-query-count/) method.
        Parameters:
        jobDefinitionId - Filter by job definition id. (optional)
        activityIdIn - Only include job definitions which belong to one of the passed and comma-separated activity ids. (optional)
        processDefinitionId - Only include job definitions which exist for the given process definition id. (optional)
        processDefinitionKey - Only include job definitions which exist for the given process definition key. (optional)
        jobType - Only include job definitions which exist for the given job type. See the [User Guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/the-job-executor/#job-creation) for more information about job types. (optional)
        jobConfiguration - Only include job definitions which exist for the given job configuration. For example: for timer jobs it is the timer configuration. (optional)
        active - Only include active job definitions. Value may only be `true`, as `false` is the default behavior. (optional)
        suspended - Only include suspended job definitions. Value may only be `true`, as `false` is the default behavior. (optional)
        withOverridingJobPriority - Only include job definitions that have an overriding job priority defined. The only effective value is `true`. If set to `false`, this filter is not applied. (optional)
        tenantIdIn - Only include job definitions which belong to one of the passed and comma-separated tenant ids. (optional)
        withoutTenantId - Only include job definitions which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
        includeJobDefinitionsWithoutTenantId - Include job definitions which belong to no tenant. Can be used in combination with `tenantIdIn`. Value may only be `true`, as `false` is the default behavior. (optional)
        sortBy - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)
        sortOrder - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (optional)
        firstResult - Pagination of results. Specifies the index of the first result to return. (optional)
        maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)
        Returns:
        List<JobDefinitionDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getJobDefinitionsWithHttpInfo

        public ApiResponse<List<JobDefinitionDto>> getJobDefinitionsWithHttpInfo​(String jobDefinitionId,
                                                                         String activityIdIn,
                                                                         String processDefinitionId,
                                                                         String processDefinitionKey,
                                                                         String jobType,
                                                                         String jobConfiguration,
                                                                         Boolean active,
                                                                         Boolean suspended,
                                                                         Boolean withOverridingJobPriority,
                                                                         String tenantIdIn,
                                                                         Boolean withoutTenantId,
                                                                         Boolean includeJobDefinitionsWithoutTenantId,
                                                                         String sortBy,
                                                                         String sortOrder,
                                                                         Integer firstResult,
                                                                         Integer maxResults)
                                                                  throws ApiException
        Get Job Definitions Queries for job definitions that fulfill given parameters. The size of the result set can be retrieved by using the [Get Job Definition Count](https://docs.camunda.org/manual/7.18/reference/rest/job-definition/get-query-count/) method.
        Parameters:
        jobDefinitionId - Filter by job definition id. (optional)
        activityIdIn - Only include job definitions which belong to one of the passed and comma-separated activity ids. (optional)
        processDefinitionId - Only include job definitions which exist for the given process definition id. (optional)
        processDefinitionKey - Only include job definitions which exist for the given process definition key. (optional)
        jobType - Only include job definitions which exist for the given job type. See the [User Guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/the-job-executor/#job-creation) for more information about job types. (optional)
        jobConfiguration - Only include job definitions which exist for the given job configuration. For example: for timer jobs it is the timer configuration. (optional)
        active - Only include active job definitions. Value may only be `true`, as `false` is the default behavior. (optional)
        suspended - Only include suspended job definitions. Value may only be `true`, as `false` is the default behavior. (optional)
        withOverridingJobPriority - Only include job definitions that have an overriding job priority defined. The only effective value is `true`. If set to `false`, this filter is not applied. (optional)
        tenantIdIn - Only include job definitions which belong to one of the passed and comma-separated tenant ids. (optional)
        withoutTenantId - Only include job definitions which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
        includeJobDefinitionsWithoutTenantId - Include job definitions which belong to no tenant. Can be used in combination with `tenantIdIn`. Value may only be `true`, as `false` is the default behavior. (optional)
        sortBy - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)
        sortOrder - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (optional)
        firstResult - Pagination of results. Specifies the index of the first result to return. (optional)
        maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)
        Returns:
        ApiResponse<List<JobDefinitionDto>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getJobDefinitionsAsync

        public okhttp3.Call getJobDefinitionsAsync​(String jobDefinitionId,
                                           String activityIdIn,
                                           String processDefinitionId,
                                           String processDefinitionKey,
                                           String jobType,
                                           String jobConfiguration,
                                           Boolean active,
                                           Boolean suspended,
                                           Boolean withOverridingJobPriority,
                                           String tenantIdIn,
                                           Boolean withoutTenantId,
                                           Boolean includeJobDefinitionsWithoutTenantId,
                                           String sortBy,
                                           String sortOrder,
                                           Integer firstResult,
                                           Integer maxResults,
                                           ApiCallback<List<JobDefinitionDto>> _callback)
                                    throws ApiException
        Get Job Definitions (asynchronously) Queries for job definitions that fulfill given parameters. The size of the result set can be retrieved by using the [Get Job Definition Count](https://docs.camunda.org/manual/7.18/reference/rest/job-definition/get-query-count/) method.
        Parameters:
        jobDefinitionId - Filter by job definition id. (optional)
        activityIdIn - Only include job definitions which belong to one of the passed and comma-separated activity ids. (optional)
        processDefinitionId - Only include job definitions which exist for the given process definition id. (optional)
        processDefinitionKey - Only include job definitions which exist for the given process definition key. (optional)
        jobType - Only include job definitions which exist for the given job type. See the [User Guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/the-job-executor/#job-creation) for more information about job types. (optional)
        jobConfiguration - Only include job definitions which exist for the given job configuration. For example: for timer jobs it is the timer configuration. (optional)
        active - Only include active job definitions. Value may only be `true`, as `false` is the default behavior. (optional)
        suspended - Only include suspended job definitions. Value may only be `true`, as `false` is the default behavior. (optional)
        withOverridingJobPriority - Only include job definitions that have an overriding job priority defined. The only effective value is `true`. If set to `false`, this filter is not applied. (optional)
        tenantIdIn - Only include job definitions which belong to one of the passed and comma-separated tenant ids. (optional)
        withoutTenantId - Only include job definitions which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
        includeJobDefinitionsWithoutTenantId - Include job definitions which belong to no tenant. Can be used in combination with `tenantIdIn`. Value may only be `true`, as `false` is the default behavior. (optional)
        sortBy - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)
        sortOrder - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (optional)
        firstResult - Pagination of results. Specifies the index of the first result to return. (optional)
        maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)
        _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

      • getJobDefinitionsCountCall

        public okhttp3.Call getJobDefinitionsCountCall​(String jobDefinitionId,
                                               String activityIdIn,
                                               String processDefinitionId,
                                               String processDefinitionKey,
                                               String jobType,
                                               String jobConfiguration,
                                               Boolean active,
                                               Boolean suspended,
                                               Boolean withOverridingJobPriority,
                                               String tenantIdIn,
                                               Boolean withoutTenantId,
                                               Boolean includeJobDefinitionsWithoutTenantId,
                                               ApiCallback _callback)
                                        throws ApiException
        Build call for getJobDefinitionsCount
        Parameters:
        jobDefinitionId - Filter by job definition id. (optional)
        activityIdIn - Only include job definitions which belong to one of the passed and comma-separated activity ids. (optional)
        processDefinitionId - Only include job definitions which exist for the given process definition id. (optional)
        processDefinitionKey - Only include job definitions which exist for the given process definition key. (optional)
        jobType - Only include job definitions which exist for the given job type. See the [User Guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/the-job-executor/#job-creation) for more information about job types. (optional)
        jobConfiguration - Only include job definitions which exist for the given job configuration. For example: for timer jobs it is the timer configuration. (optional)
        active - Only include active job definitions. Value may only be `true`, as `false` is the default behavior. (optional)
        suspended - Only include suspended job definitions. Value may only be `true`, as `false` is the default behavior. (optional)
        withOverridingJobPriority - Only include job definitions that have an overriding job priority defined. The only effective value is `true`. If set to `false`, this filter is not applied. (optional)
        tenantIdIn - Only include job definitions which belong to one of the passed and comma-separated tenant ids. (optional)
        withoutTenantId - Only include job definitions which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
        includeJobDefinitionsWithoutTenantId - Include job definitions which belong to no tenant. Can be used in combination with `tenantIdIn`. Value may only be `true`, as `false` is the default behavior. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getJobDefinitionsCount

        public CountResultDto getJobDefinitionsCount​(String jobDefinitionId,
                                             String activityIdIn,
                                             String processDefinitionId,
                                             String processDefinitionKey,
                                             String jobType,
                                             String jobConfiguration,
                                             Boolean active,
                                             Boolean suspended,
                                             Boolean withOverridingJobPriority,
                                             String tenantIdIn,
                                             Boolean withoutTenantId,
                                             Boolean includeJobDefinitionsWithoutTenantId)
                                      throws ApiException
        Get Job Definition Count Queries for the number of job definitions that fulfill given parameters. Takes the same parameters as the [Get Job Definitions](https://docs.camunda.org/manual/7.18/reference/rest/job-definition/get-query/) method.
        Parameters:
        jobDefinitionId - Filter by job definition id. (optional)
        activityIdIn - Only include job definitions which belong to one of the passed and comma-separated activity ids. (optional)
        processDefinitionId - Only include job definitions which exist for the given process definition id. (optional)
        processDefinitionKey - Only include job definitions which exist for the given process definition key. (optional)
        jobType - Only include job definitions which exist for the given job type. See the [User Guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/the-job-executor/#job-creation) for more information about job types. (optional)
        jobConfiguration - Only include job definitions which exist for the given job configuration. For example: for timer jobs it is the timer configuration. (optional)
        active - Only include active job definitions. Value may only be `true`, as `false` is the default behavior. (optional)
        suspended - Only include suspended job definitions. Value may only be `true`, as `false` is the default behavior. (optional)
        withOverridingJobPriority - Only include job definitions that have an overriding job priority defined. The only effective value is `true`. If set to `false`, this filter is not applied. (optional)
        tenantIdIn - Only include job definitions which belong to one of the passed and comma-separated tenant ids. (optional)
        withoutTenantId - Only include job definitions which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
        includeJobDefinitionsWithoutTenantId - Include job definitions which belong to no tenant. Can be used in combination with `tenantIdIn`. Value may only be `true`, as `false` is the default behavior. (optional)
        Returns:
        CountResultDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getJobDefinitionsCountWithHttpInfo

        public ApiResponse<CountResultDto> getJobDefinitionsCountWithHttpInfo​(String jobDefinitionId,
                                                                      String activityIdIn,
                                                                      String processDefinitionId,
                                                                      String processDefinitionKey,
                                                                      String jobType,
                                                                      String jobConfiguration,
                                                                      Boolean active,
                                                                      Boolean suspended,
                                                                      Boolean withOverridingJobPriority,
                                                                      String tenantIdIn,
                                                                      Boolean withoutTenantId,
                                                                      Boolean includeJobDefinitionsWithoutTenantId)
                                                               throws ApiException
        Get Job Definition Count Queries for the number of job definitions that fulfill given parameters. Takes the same parameters as the [Get Job Definitions](https://docs.camunda.org/manual/7.18/reference/rest/job-definition/get-query/) method.
        Parameters:
        jobDefinitionId - Filter by job definition id. (optional)
        activityIdIn - Only include job definitions which belong to one of the passed and comma-separated activity ids. (optional)
        processDefinitionId - Only include job definitions which exist for the given process definition id. (optional)
        processDefinitionKey - Only include job definitions which exist for the given process definition key. (optional)
        jobType - Only include job definitions which exist for the given job type. See the [User Guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/the-job-executor/#job-creation) for more information about job types. (optional)
        jobConfiguration - Only include job definitions which exist for the given job configuration. For example: for timer jobs it is the timer configuration. (optional)
        active - Only include active job definitions. Value may only be `true`, as `false` is the default behavior. (optional)
        suspended - Only include suspended job definitions. Value may only be `true`, as `false` is the default behavior. (optional)
        withOverridingJobPriority - Only include job definitions that have an overriding job priority defined. The only effective value is `true`. If set to `false`, this filter is not applied. (optional)
        tenantIdIn - Only include job definitions which belong to one of the passed and comma-separated tenant ids. (optional)
        withoutTenantId - Only include job definitions which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
        includeJobDefinitionsWithoutTenantId - Include job definitions which belong to no tenant. Can be used in combination with `tenantIdIn`. Value may only be `true`, as `false` is the default behavior. (optional)
        Returns:
        ApiResponse<CountResultDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getJobDefinitionsCountAsync

        public okhttp3.Call getJobDefinitionsCountAsync​(String jobDefinitionId,
                                                String activityIdIn,
                                                String processDefinitionId,
                                                String processDefinitionKey,
                                                String jobType,
                                                String jobConfiguration,
                                                Boolean active,
                                                Boolean suspended,
                                                Boolean withOverridingJobPriority,
                                                String tenantIdIn,
                                                Boolean withoutTenantId,
                                                Boolean includeJobDefinitionsWithoutTenantId,
                                                ApiCallback<CountResultDto> _callback)
                                         throws ApiException
        Get Job Definition Count (asynchronously) Queries for the number of job definitions that fulfill given parameters. Takes the same parameters as the [Get Job Definitions](https://docs.camunda.org/manual/7.18/reference/rest/job-definition/get-query/) method.
        Parameters:
        jobDefinitionId - Filter by job definition id. (optional)
        activityIdIn - Only include job definitions which belong to one of the passed and comma-separated activity ids. (optional)
        processDefinitionId - Only include job definitions which exist for the given process definition id. (optional)
        processDefinitionKey - Only include job definitions which exist for the given process definition key. (optional)
        jobType - Only include job definitions which exist for the given job type. See the [User Guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/the-job-executor/#job-creation) for more information about job types. (optional)
        jobConfiguration - Only include job definitions which exist for the given job configuration. For example: for timer jobs it is the timer configuration. (optional)
        active - Only include active job definitions. Value may only be `true`, as `false` is the default behavior. (optional)
        suspended - Only include suspended job definitions. Value may only be `true`, as `false` is the default behavior. (optional)
        withOverridingJobPriority - Only include job definitions that have an overriding job priority defined. The only effective value is `true`. If set to `false`, this filter is not applied. (optional)
        tenantIdIn - Only include job definitions which belong to one of the passed and comma-separated tenant ids. (optional)
        withoutTenantId - Only include job definitions which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
        includeJobDefinitionsWithoutTenantId - Include job definitions which belong to no tenant. Can be used in combination with `tenantIdIn`. Value may only be `true`, as `false` is the default behavior. (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

      • queryJobDefinitionsCall

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

      • queryJobDefinitions

        public List<JobDefinitionDto> queryJobDefinitions​(Integer firstResult,
                                                  Integer maxResults,
                                                  JobDefinitionQueryDto jobDefinitionQueryDto)
                                           throws ApiException
        Get Job Definitions (POST) Queries for job definitions that fulfill given parameters. This method is slightly more powerful than the [Get Job Definitions](https://docs.camunda.org/manual/7.18/reference/rest/job-definition/get-query/) method because it allows filtering by multiple job definitions of types `String`, `Number` or `Boolean`.
        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)
        jobDefinitionQueryDto - (optional)
        Returns:
        List<JobDefinitionDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • queryJobDefinitionsWithHttpInfo

        public ApiResponse<List<JobDefinitionDto>> queryJobDefinitionsWithHttpInfo​(Integer firstResult,
                                                                           Integer maxResults,
                                                                           JobDefinitionQueryDto jobDefinitionQueryDto)
                                                                    throws ApiException
        Get Job Definitions (POST) Queries for job definitions that fulfill given parameters. This method is slightly more powerful than the [Get Job Definitions](https://docs.camunda.org/manual/7.18/reference/rest/job-definition/get-query/) method because it allows filtering by multiple job definitions of types `String`, `Number` or `Boolean`.
        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)
        jobDefinitionQueryDto - (optional)
        Returns:
        ApiResponse<List<JobDefinitionDto>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • queryJobDefinitionsAsync

        public okhttp3.Call queryJobDefinitionsAsync​(Integer firstResult,
                                             Integer maxResults,
                                             JobDefinitionQueryDto jobDefinitionQueryDto,
                                             ApiCallback<List<JobDefinitionDto>> _callback)
                                      throws ApiException
        Get Job Definitions (POST) (asynchronously) Queries for job definitions that fulfill given parameters. This method is slightly more powerful than the [Get Job Definitions](https://docs.camunda.org/manual/7.18/reference/rest/job-definition/get-query/) method because it allows filtering by multiple job definitions of types `String`, `Number` or `Boolean`.
        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)
        jobDefinitionQueryDto - (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

      • queryJobDefinitionsCountCall

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

      • queryJobDefinitionsCount

        public CountResultDto queryJobDefinitionsCount​(JobDefinitionQueryDto jobDefinitionQueryDto)
                                        throws ApiException
        Get Job Definition Count (POST) Queries for the number of job definitions that fulfill given parameters. This method takes the same message body as the [Get Job Definitions (POST)](https://docs.camunda.org/manual/7.18/reference/rest/job-definition/post-query/) method and therefore it is slightly more powerful than the [Get Job Definition Count](https://docs.camunda.org/manual/7.18/reference/rest/job-definition/get-query-count/) method.
        Parameters:
        jobDefinitionQueryDto - (optional)
        Returns:
        CountResultDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • queryJobDefinitionsCountWithHttpInfo

        public ApiResponse<CountResultDto> queryJobDefinitionsCountWithHttpInfo​(JobDefinitionQueryDto jobDefinitionQueryDto)
                                                                 throws ApiException
        Get Job Definition Count (POST) Queries for the number of job definitions that fulfill given parameters. This method takes the same message body as the [Get Job Definitions (POST)](https://docs.camunda.org/manual/7.18/reference/rest/job-definition/post-query/) method and therefore it is slightly more powerful than the [Get Job Definition Count](https://docs.camunda.org/manual/7.18/reference/rest/job-definition/get-query-count/) method.
        Parameters:
        jobDefinitionQueryDto - (optional)
        Returns:
        ApiResponse<CountResultDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • queryJobDefinitionsCountAsync

        public okhttp3.Call queryJobDefinitionsCountAsync​(JobDefinitionQueryDto jobDefinitionQueryDto,
                                                  ApiCallback<CountResultDto> _callback)
                                           throws ApiException
        Get Job Definition Count (POST) (asynchronously) Queries for the number of job definitions that fulfill given parameters. This method takes the same message body as the [Get Job Definitions (POST)](https://docs.camunda.org/manual/7.18/reference/rest/job-definition/post-query/) method and therefore it is slightly more powerful than the [Get Job Definition Count](https://docs.camunda.org/manual/7.18/reference/rest/job-definition/get-query-count/) method.
        Parameters:
        jobDefinitionQueryDto - (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

      • setJobPriorityJobDefinitionCall

        public okhttp3.Call setJobPriorityJobDefinitionCall​(String id,
                                                    JobDefinitionPriorityDto jobDefinitionPriorityDto,
                                                    ApiCallback _callback)
                                             throws ApiException
        Build call for setJobPriorityJobDefinition
        Parameters:
        id - The id of the job definition to be updated. (required)
        jobDefinitionPriorityDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • setJobPriorityJobDefinition

        public void setJobPriorityJobDefinition​(String id,
                                        JobDefinitionPriorityDto jobDefinitionPriorityDto)
                                 throws ApiException
        Set Job Definition Priority by Id Sets an overriding execution priority for jobs with the given definition id. Optionally, the priorities of all the definitions' existing jobs are updated accordingly. The priority can be reset by setting it to `null`, meaning that a new job's priority will not be determined based on its definition's priority any longer. See the [user guide on job prioritization](https://docs.camunda.org/manual/7.18/user-guide/process-engine/the-job-executor/#set-job-definition-priorities-via-managementservice-api) for details.
        Parameters:
        id - The id of the job definition to be updated. (required)
        jobDefinitionPriorityDto - (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • setJobPriorityJobDefinitionWithHttpInfo

        public ApiResponse<Void> setJobPriorityJobDefinitionWithHttpInfo​(String id,
                                                                 JobDefinitionPriorityDto jobDefinitionPriorityDto)
                                                          throws ApiException
        Set Job Definition Priority by Id Sets an overriding execution priority for jobs with the given definition id. Optionally, the priorities of all the definitions' existing jobs are updated accordingly. The priority can be reset by setting it to `null`, meaning that a new job's priority will not be determined based on its definition's priority any longer. See the [user guide on job prioritization](https://docs.camunda.org/manual/7.18/user-guide/process-engine/the-job-executor/#set-job-definition-priorities-via-managementservice-api) for details.
        Parameters:
        id - The id of the job definition to be updated. (required)
        jobDefinitionPriorityDto - (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • setJobPriorityJobDefinitionAsync

        public okhttp3.Call setJobPriorityJobDefinitionAsync​(String id,
                                                     JobDefinitionPriorityDto jobDefinitionPriorityDto,
                                                     ApiCallback<Void> _callback)
                                              throws ApiException
        Set Job Definition Priority by Id (asynchronously) Sets an overriding execution priority for jobs with the given definition id. Optionally, the priorities of all the definitions' existing jobs are updated accordingly. The priority can be reset by setting it to `null`, meaning that a new job's priority will not be determined based on its definition's priority any longer. See the [user guide on job prioritization](https://docs.camunda.org/manual/7.18/user-guide/process-engine/the-job-executor/#set-job-definition-priorities-via-managementservice-api) for details.
        Parameters:
        id - The id of the job definition to be updated. (required)
        jobDefinitionPriorityDto - (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

      • setJobRetriesJobDefinitionCall

        public okhttp3.Call setJobRetriesJobDefinitionCall​(String id,
                                                   RetriesDto retriesDto,
                                                   ApiCallback _callback)
                                            throws ApiException
        Build call for setJobRetriesJobDefinition
        Parameters:
        id - The id of the job definition to be updated. (required)
        retriesDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • setJobRetriesJobDefinition

        public void setJobRetriesJobDefinition​(String id,
                                       RetriesDto retriesDto)
                                throws ApiException
        Set Job Retries By Job Definition Id Sets the number of retries of all **failed** jobs associated with the given job definition id.
        Parameters:
        id - The id of the job definition to be updated. (required)
        retriesDto - (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • setJobRetriesJobDefinitionWithHttpInfo

        public ApiResponse<Void> setJobRetriesJobDefinitionWithHttpInfo​(String id,
                                                                RetriesDto retriesDto)
                                                         throws ApiException
        Set Job Retries By Job Definition Id Sets the number of retries of all **failed** jobs associated with the given job definition id.
        Parameters:
        id - The id of the job definition to be updated. (required)
        retriesDto - (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • setJobRetriesJobDefinitionAsync

        public okhttp3.Call setJobRetriesJobDefinitionAsync​(String id,
                                                    RetriesDto retriesDto,
                                                    ApiCallback<Void> _callback)
                                             throws ApiException
        Set Job Retries By Job Definition Id (asynchronously) Sets the number of retries of all **failed** jobs associated with the given job definition id.
        Parameters:
        id - The id of the job definition to be updated. (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

      • updateSuspensionStateJobDefinitionCall

        public okhttp3.Call updateSuspensionStateJobDefinitionCall​(String id,
                                                           JobDefinitionSuspensionStateDto jobDefinitionSuspensionStateDto,
                                                           ApiCallback _callback)
                                                    throws ApiException
        Build call for updateSuspensionStateJobDefinition
        Parameters:
        id - The id of the job definition to activate or suspend. (required)
        jobDefinitionSuspensionStateDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • updateSuspensionStateJobDefinition

        public void updateSuspensionStateJobDefinition​(String id,
                                               JobDefinitionSuspensionStateDto jobDefinitionSuspensionStateDto)
                                        throws ApiException
        Activate/Suspend Job Definition By Id Activates or suspends a given job definition by id.
        Parameters:
        id - The id of the job definition to activate or suspend. (required)
        jobDefinitionSuspensionStateDto - (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updateSuspensionStateJobDefinitionWithHttpInfo

        public ApiResponse<Void> updateSuspensionStateJobDefinitionWithHttpInfo​(String id,
                                                                        JobDefinitionSuspensionStateDto jobDefinitionSuspensionStateDto)
                                                                 throws ApiException
        Activate/Suspend Job Definition By Id Activates or suspends a given job definition by id.
        Parameters:
        id - The id of the job definition to activate or suspend. (required)
        jobDefinitionSuspensionStateDto - (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updateSuspensionStateJobDefinitionAsync

        public okhttp3.Call updateSuspensionStateJobDefinitionAsync​(String id,
                                                            JobDefinitionSuspensionStateDto jobDefinitionSuspensionStateDto,
                                                            ApiCallback<Void> _callback)
                                                     throws ApiException
        Activate/Suspend Job Definition By Id (asynchronously) Activates or suspends a given job definition by id.
        Parameters:
        id - The id of the job definition to activate or suspend. (required)
        jobDefinitionSuspensionStateDto - (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

      • updateSuspensionStateJobDefinitionsCall

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

      • updateSuspensionStateJobDefinitions

        public void updateSuspensionStateJobDefinitions​(JobDefinitionsSuspensionStateDto jobDefinitionsSuspensionStateDto)
                                         throws ApiException
        Activate/Suspend Job Definitions Activates or suspends job definitions with the given process definition id or process definition key.
        Parameters:
        jobDefinitionsSuspensionStateDto - (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updateSuspensionStateJobDefinitionsWithHttpInfo

        public ApiResponse<Void> updateSuspensionStateJobDefinitionsWithHttpInfo​(JobDefinitionsSuspensionStateDto jobDefinitionsSuspensionStateDto)
                                                                  throws ApiException
        Activate/Suspend Job Definitions Activates or suspends job definitions with the given process definition id or process definition key.
        Parameters:
        jobDefinitionsSuspensionStateDto - (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updateSuspensionStateJobDefinitionsAsync

        public okhttp3.Call updateSuspensionStateJobDefinitionsAsync​(JobDefinitionsSuspensionStateDto jobDefinitionsSuspensionStateDto,
                                                             ApiCallback<Void> _callback)
                                                      throws ApiException
        Activate/Suspend Job Definitions (asynchronously) Activates or suspends job definitions with the given process definition id or process definition key.
        Parameters:
        jobDefinitionsSuspensionStateDto - (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