Package org.openapitools.client.api

Class DeploymentApi

  • public class DeploymentApi
extends Object

    • Constructor Detail

      • DeploymentApi

        public DeploymentApi()

      • DeploymentApi

        public DeploymentApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • createDeploymentCall

        public okhttp3.Call createDeploymentCall​(String tenantId,
                                         String deploymentSource,
                                         Boolean deployChangedOnly,
                                         Boolean enableDuplicateFiltering,
                                         String deploymentName,
                                         Date deploymentActivationTime,
                                         File data,
                                         ApiCallback _callback)
                                  throws ApiException
        Build call for createDeployment
        Parameters:
        tenantId - The tenant id for the deployment to be created. (optional)
        deploymentSource - The source for the deployment to be created. (optional)
        deployChangedOnly - A flag indicating whether the process engine should perform duplicate checking on a per-resource basis. If set to true, only those resources that have actually changed are deployed. Checks are made against resources included previous deployments of the same name and only against the latest versions of those resources. If set to true, the option enable-duplicate-filtering is overridden and set to true. (optional, default to false)
        enableDuplicateFiltering - A flag indicating whether the process engine should perform duplicate checking for the deployment or not. This allows you to check if a deployment with the same name and the same resouces already exists and if true, not create a new deployment but instead return the existing deployment. The default value is false. (optional, default to false)
        deploymentName - The name for the deployment to be created. (optional)
        deploymentActivationTime - Sets the date on which the process definitions contained in this deployment will be activated. This means that all process definitions will be deployed as usual, but they will be suspended from the start until the given activation 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)
        data - The binary data to create the deployment resource. It is possible to have more than one form part with different form part names for the binary data to create a deployment. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • createDeployment

        public DeploymentWithDefinitionsDto createDeployment​(String tenantId,
                                                     String deploymentSource,
                                                     Boolean deployChangedOnly,
                                                     Boolean enableDuplicateFiltering,
                                                     String deploymentName,
                                                     Date deploymentActivationTime,
                                                     File data)
                                              throws ApiException
        Create Creates a deployment. **Security Consideration** Deployments can contain custom code in form of scripts or EL expressions to customize process behavior. This may be abused for remote execution of arbitrary code.
        Parameters:
        tenantId - The tenant id for the deployment to be created. (optional)
        deploymentSource - The source for the deployment to be created. (optional)
        deployChangedOnly - A flag indicating whether the process engine should perform duplicate checking on a per-resource basis. If set to true, only those resources that have actually changed are deployed. Checks are made against resources included previous deployments of the same name and only against the latest versions of those resources. If set to true, the option enable-duplicate-filtering is overridden and set to true. (optional, default to false)
        enableDuplicateFiltering - A flag indicating whether the process engine should perform duplicate checking for the deployment or not. This allows you to check if a deployment with the same name and the same resouces already exists and if true, not create a new deployment but instead return the existing deployment. The default value is false. (optional, default to false)
        deploymentName - The name for the deployment to be created. (optional)
        deploymentActivationTime - Sets the date on which the process definitions contained in this deployment will be activated. This means that all process definitions will be deployed as usual, but they will be suspended from the start until the given activation 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)
        data - The binary data to create the deployment resource. It is possible to have more than one form part with different form part names for the binary data to create a deployment. (optional)
        Returns:
        DeploymentWithDefinitionsDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • createDeploymentWithHttpInfo

        public ApiResponse<DeploymentWithDefinitionsDto> createDeploymentWithHttpInfo​(String tenantId,
                                                                              String deploymentSource,
                                                                              Boolean deployChangedOnly,
                                                                              Boolean enableDuplicateFiltering,
                                                                              String deploymentName,
                                                                              Date deploymentActivationTime,
                                                                              File data)
                                                                       throws ApiException
        Create Creates a deployment. **Security Consideration** Deployments can contain custom code in form of scripts or EL expressions to customize process behavior. This may be abused for remote execution of arbitrary code.
        Parameters:
        tenantId - The tenant id for the deployment to be created. (optional)
        deploymentSource - The source for the deployment to be created. (optional)
        deployChangedOnly - A flag indicating whether the process engine should perform duplicate checking on a per-resource basis. If set to true, only those resources that have actually changed are deployed. Checks are made against resources included previous deployments of the same name and only against the latest versions of those resources. If set to true, the option enable-duplicate-filtering is overridden and set to true. (optional, default to false)
        enableDuplicateFiltering - A flag indicating whether the process engine should perform duplicate checking for the deployment or not. This allows you to check if a deployment with the same name and the same resouces already exists and if true, not create a new deployment but instead return the existing deployment. The default value is false. (optional, default to false)
        deploymentName - The name for the deployment to be created. (optional)
        deploymentActivationTime - Sets the date on which the process definitions contained in this deployment will be activated. This means that all process definitions will be deployed as usual, but they will be suspended from the start until the given activation 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)
        data - The binary data to create the deployment resource. It is possible to have more than one form part with different form part names for the binary data to create a deployment. (optional)
        Returns:
        ApiResponse<DeploymentWithDefinitionsDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • createDeploymentAsync

        public okhttp3.Call createDeploymentAsync​(String tenantId,
                                          String deploymentSource,
                                          Boolean deployChangedOnly,
                                          Boolean enableDuplicateFiltering,
                                          String deploymentName,
                                          Date deploymentActivationTime,
                                          File data,
                                          ApiCallback<DeploymentWithDefinitionsDto> _callback)
                                   throws ApiException
        Create (asynchronously) Creates a deployment. **Security Consideration** Deployments can contain custom code in form of scripts or EL expressions to customize process behavior. This may be abused for remote execution of arbitrary code.
        Parameters:
        tenantId - The tenant id for the deployment to be created. (optional)
        deploymentSource - The source for the deployment to be created. (optional)
        deployChangedOnly - A flag indicating whether the process engine should perform duplicate checking on a per-resource basis. If set to true, only those resources that have actually changed are deployed. Checks are made against resources included previous deployments of the same name and only against the latest versions of those resources. If set to true, the option enable-duplicate-filtering is overridden and set to true. (optional, default to false)
        enableDuplicateFiltering - A flag indicating whether the process engine should perform duplicate checking for the deployment or not. This allows you to check if a deployment with the same name and the same resouces already exists and if true, not create a new deployment but instead return the existing deployment. The default value is false. (optional, default to false)
        deploymentName - The name for the deployment to be created. (optional)
        deploymentActivationTime - Sets the date on which the process definitions contained in this deployment will be activated. This means that all process definitions will be deployed as usual, but they will be suspended from the start until the given activation 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)
        data - The binary data to create the deployment resource. It is possible to have more than one form part with different form part names for the binary data to create a deployment. (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

      • deleteDeploymentCall

        public okhttp3.Call deleteDeploymentCall​(String id,
                                         Boolean cascade,
                                         Boolean skipCustomListeners,
                                         Boolean skipIoMappings,
                                         ApiCallback _callback)
                                  throws ApiException
        Build call for deleteDeployment
        Parameters:
        id - The id of the deployment to be deleted. (required)
        cascade - `true`, if all process instances, historic process instances and jobs for this deployment should be deleted. (optional, default to false)
        skipCustomListeners - `true`, if only the built-in ExecutionListeners should be notified with the end event. (optional, default to false)
        skipIoMappings - `true`, if all input/output mappings should not be invoked. (optional, default to false)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • deleteDeployment

        public void deleteDeployment​(String id,
                             Boolean cascade,
                             Boolean skipCustomListeners,
                             Boolean skipIoMappings)
                      throws ApiException
        Delete Deletes a deployment by id.
        Parameters:
        id - The id of the deployment to be deleted. (required)
        cascade - `true`, if all process instances, historic process instances and jobs for this deployment should be deleted. (optional, default to false)
        skipCustomListeners - `true`, if only the built-in ExecutionListeners should be notified with the end event. (optional, default to false)
        skipIoMappings - `true`, if all input/output mappings should not be invoked. (optional, default to false)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteDeploymentWithHttpInfo

        public ApiResponse<Void> deleteDeploymentWithHttpInfo​(String id,
                                                      Boolean cascade,
                                                      Boolean skipCustomListeners,
                                                      Boolean skipIoMappings)
                                               throws ApiException
        Delete Deletes a deployment by id.
        Parameters:
        id - The id of the deployment to be deleted. (required)
        cascade - `true`, if all process instances, historic process instances and jobs for this deployment should be deleted. (optional, default to false)
        skipCustomListeners - `true`, if only the built-in ExecutionListeners should be notified with the end event. (optional, default to false)
        skipIoMappings - `true`, if all input/output mappings should not be invoked. (optional, default to false)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteDeploymentAsync

        public okhttp3.Call deleteDeploymentAsync​(String id,
                                          Boolean cascade,
                                          Boolean skipCustomListeners,
                                          Boolean skipIoMappings,
                                          ApiCallback<Void> _callback)
                                   throws ApiException
        Delete (asynchronously) Deletes a deployment by id.
        Parameters:
        id - The id of the deployment to be deleted. (required)
        cascade - `true`, if all process instances, historic process instances and jobs for this deployment should be deleted. (optional, default to false)
        skipCustomListeners - `true`, if only the built-in ExecutionListeners should be notified with the end event. (optional, default to false)
        skipIoMappings - `true`, if all input/output mappings should not be invoked. (optional, default to false)
        _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

      • getDeploymentCall

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

      • getDeployment

        public DeploymentDto getDeployment​(String id)
                            throws ApiException
        Get Retrieves a deployment by id, according to the `Deployment` interface of the engine.
        Parameters:
        id - The id of the deployment. (required)
        Returns:
        DeploymentDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getDeploymentWithHttpInfo

        public ApiResponse<DeploymentDto> getDeploymentWithHttpInfo​(String id)
                                                     throws ApiException
        Get Retrieves a deployment by id, according to the `Deployment` interface of the engine.
        Parameters:
        id - The id of the deployment. (required)
        Returns:
        ApiResponse<DeploymentDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getDeploymentAsync

        public okhttp3.Call getDeploymentAsync​(String id,
                                       ApiCallback<DeploymentDto> _callback)
                                throws ApiException
        Get (asynchronously) Retrieves a deployment by id, according to the `Deployment` interface of the engine.
        Parameters:
        id - The id of the deployment. (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

      • getDeploymentResourceCall

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

      • getDeploymentResource

        public DeploymentResourceDto getDeploymentResource​(String id,
                                                   String resourceId)
                                            throws ApiException
        Get Resource Retrieves a deployment resource by resource id for the given deployment.
        Parameters:
        id - The id of the deployment (required)
        resourceId - The id of the deployment resource (required)
        Returns:
        DeploymentResourceDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getDeploymentResourceWithHttpInfo

        public ApiResponse<DeploymentResourceDto> getDeploymentResourceWithHttpInfo​(String id,
                                                                            String resourceId)
                                                                     throws ApiException
        Get Resource Retrieves a deployment resource by resource id for the given deployment.
        Parameters:
        id - The id of the deployment (required)
        resourceId - The id of the deployment resource (required)
        Returns:
        ApiResponse<DeploymentResourceDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getDeploymentResourceAsync

        public okhttp3.Call getDeploymentResourceAsync​(String id,
                                               String resourceId,
                                               ApiCallback<DeploymentResourceDto> _callback)
                                        throws ApiException
        Get Resource (asynchronously) Retrieves a deployment resource by resource id for the given deployment.
        Parameters:
        id - The id of the deployment (required)
        resourceId - The id of the deployment resource (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

      • getDeploymentResourceDataCall

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

      • getDeploymentResourceData

        public File getDeploymentResourceData​(String id,
                                      String resourceId)
                               throws ApiException
        Get Resource (Binary) Retrieves the binary content of a deployment resource for the given deployment by id.
        Parameters:
        id - The id of the deployment. (required)
        resourceId - The id of the deployment resource. (required)
        Returns:
        File
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getDeploymentResourceDataWithHttpInfo

        public ApiResponse<File> getDeploymentResourceDataWithHttpInfo​(String id,
                                                               String resourceId)
                                                        throws ApiException
        Get Resource (Binary) Retrieves the binary content of a deployment resource for the given deployment by id.
        Parameters:
        id - The id of the deployment. (required)
        resourceId - The id of the deployment resource. (required)
        Returns:
        ApiResponse<File>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getDeploymentResourceDataAsync

        public okhttp3.Call getDeploymentResourceDataAsync​(String id,
                                                   String resourceId,
                                                   ApiCallback<File> _callback)
                                            throws ApiException
        Get Resource (Binary) (asynchronously) Retrieves the binary content of a deployment resource for the given deployment by id.
        Parameters:
        id - The id of the deployment. (required)
        resourceId - The id of the deployment resource. (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

      • getDeploymentResourcesCall

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

      • getDeploymentResources

        public List<DeploymentResourceDto> getDeploymentResources​(String id)
                                                   throws ApiException
        Get Resources Retrieves all deployment resources of a given deployment.
        Parameters:
        id - The id of the deployment to retrieve the deployment resources for. (required)
        Returns:
        List<DeploymentResourceDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getDeploymentResourcesWithHttpInfo

        public ApiResponse<List<DeploymentResourceDto>> getDeploymentResourcesWithHttpInfo​(String id)
                                                                            throws ApiException
        Get Resources Retrieves all deployment resources of a given deployment.
        Parameters:
        id - The id of the deployment to retrieve the deployment resources for. (required)
        Returns:
        ApiResponse<List<DeploymentResourceDto>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getDeploymentResourcesAsync

        public okhttp3.Call getDeploymentResourcesAsync​(String id,
                                                ApiCallback<List<DeploymentResourceDto>> _callback)
                                         throws ApiException
        Get Resources (asynchronously) Retrieves all deployment resources of a given deployment.
        Parameters:
        id - The id of the deployment to retrieve the deployment resources for. (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

      • getDeploymentsCall

        public okhttp3.Call getDeploymentsCall​(String id,
                                       String name,
                                       String nameLike,
                                       String source,
                                       Boolean withoutSource,
                                       String tenantIdIn,
                                       Boolean withoutTenantId,
                                       Boolean includeDeploymentsWithoutTenantId,
                                       Date after,
                                       Date before,
                                       String sortBy,
                                       String sortOrder,
                                       Integer firstResult,
                                       Integer maxResults,
                                       ApiCallback _callback)
                                throws ApiException
        Build call for getDeployments
        Parameters:
        id - Filter by deployment id (optional)
        name - Filter by the deployment name. Exact match. (optional)
        nameLike - Filter by the deployment name that the parameter is a substring of. The parameter can include the wildcard `%` to express like-strategy such as: starts with (`%`name), ends with (name`%`) or contains (`%`name`%`). (optional)
        source - Filter by the deployment source. (optional)
        withoutSource - Filter by the deployment source whereby source is equal to `null`. (optional, default to false)
        tenantIdIn - Filter by a comma-separated list of tenant ids. A deployment must have one of the given tenant ids. (optional)
        withoutTenantId - Only include deployments which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
        includeDeploymentsWithoutTenantId - Include deployments which belong to no tenant. Can be used in combination with `tenantIdIn`. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
        after - Restricts to all deployments after the 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)
        before - Restricts to all deployments before the 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)
        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

      • getDeployments

        public List<DeploymentDto> getDeployments​(String id,
                                          String name,
                                          String nameLike,
                                          String source,
                                          Boolean withoutSource,
                                          String tenantIdIn,
                                          Boolean withoutTenantId,
                                          Boolean includeDeploymentsWithoutTenantId,
                                          Date after,
                                          Date before,
                                          String sortBy,
                                          String sortOrder,
                                          Integer firstResult,
                                          Integer maxResults)
                                   throws ApiException
        Get List Queries for deployments that fulfill given parameters. Parameters may be the properties of deployments, such as the id or name or a range of the deployment time. The size of the result set can be retrieved by using the [Get Deployment count](https://docs.camunda.org/manual/7.18/reference/rest/deployment/get-query-count/) method.
        Parameters:
        id - Filter by deployment id (optional)
        name - Filter by the deployment name. Exact match. (optional)
        nameLike - Filter by the deployment name that the parameter is a substring of. The parameter can include the wildcard `%` to express like-strategy such as: starts with (`%`name), ends with (name`%`) or contains (`%`name`%`). (optional)
        source - Filter by the deployment source. (optional)
        withoutSource - Filter by the deployment source whereby source is equal to `null`. (optional, default to false)
        tenantIdIn - Filter by a comma-separated list of tenant ids. A deployment must have one of the given tenant ids. (optional)
        withoutTenantId - Only include deployments which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
        includeDeploymentsWithoutTenantId - Include deployments which belong to no tenant. Can be used in combination with `tenantIdIn`. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
        after - Restricts to all deployments after the 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)
        before - Restricts to all deployments before the 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)
        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<DeploymentDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getDeploymentsWithHttpInfo

        public ApiResponse<List<DeploymentDto>> getDeploymentsWithHttpInfo​(String id,
                                                                   String name,
                                                                   String nameLike,
                                                                   String source,
                                                                   Boolean withoutSource,
                                                                   String tenantIdIn,
                                                                   Boolean withoutTenantId,
                                                                   Boolean includeDeploymentsWithoutTenantId,
                                                                   Date after,
                                                                   Date before,
                                                                   String sortBy,
                                                                   String sortOrder,
                                                                   Integer firstResult,
                                                                   Integer maxResults)
                                                            throws ApiException
        Get List Queries for deployments that fulfill given parameters. Parameters may be the properties of deployments, such as the id or name or a range of the deployment time. The size of the result set can be retrieved by using the [Get Deployment count](https://docs.camunda.org/manual/7.18/reference/rest/deployment/get-query-count/) method.
        Parameters:
        id - Filter by deployment id (optional)
        name - Filter by the deployment name. Exact match. (optional)
        nameLike - Filter by the deployment name that the parameter is a substring of. The parameter can include the wildcard `%` to express like-strategy such as: starts with (`%`name), ends with (name`%`) or contains (`%`name`%`). (optional)
        source - Filter by the deployment source. (optional)
        withoutSource - Filter by the deployment source whereby source is equal to `null`. (optional, default to false)
        tenantIdIn - Filter by a comma-separated list of tenant ids. A deployment must have one of the given tenant ids. (optional)
        withoutTenantId - Only include deployments which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
        includeDeploymentsWithoutTenantId - Include deployments which belong to no tenant. Can be used in combination with `tenantIdIn`. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
        after - Restricts to all deployments after the 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)
        before - Restricts to all deployments before the 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)
        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<DeploymentDto>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getDeploymentsAsync

        public okhttp3.Call getDeploymentsAsync​(String id,
                                        String name,
                                        String nameLike,
                                        String source,
                                        Boolean withoutSource,
                                        String tenantIdIn,
                                        Boolean withoutTenantId,
                                        Boolean includeDeploymentsWithoutTenantId,
                                        Date after,
                                        Date before,
                                        String sortBy,
                                        String sortOrder,
                                        Integer firstResult,
                                        Integer maxResults,
                                        ApiCallback<List<DeploymentDto>> _callback)
                                 throws ApiException
        Get List (asynchronously) Queries for deployments that fulfill given parameters. Parameters may be the properties of deployments, such as the id or name or a range of the deployment time. The size of the result set can be retrieved by using the [Get Deployment count](https://docs.camunda.org/manual/7.18/reference/rest/deployment/get-query-count/) method.
        Parameters:
        id - Filter by deployment id (optional)
        name - Filter by the deployment name. Exact match. (optional)
        nameLike - Filter by the deployment name that the parameter is a substring of. The parameter can include the wildcard `%` to express like-strategy such as: starts with (`%`name), ends with (name`%`) or contains (`%`name`%`). (optional)
        source - Filter by the deployment source. (optional)
        withoutSource - Filter by the deployment source whereby source is equal to `null`. (optional, default to false)
        tenantIdIn - Filter by a comma-separated list of tenant ids. A deployment must have one of the given tenant ids. (optional)
        withoutTenantId - Only include deployments which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
        includeDeploymentsWithoutTenantId - Include deployments which belong to no tenant. Can be used in combination with `tenantIdIn`. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
        after - Restricts to all deployments after the 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)
        before - Restricts to all deployments before the 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)
        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

      • getDeploymentsCountCall

        public okhttp3.Call getDeploymentsCountCall​(String id,
                                            String name,
                                            String nameLike,
                                            String source,
                                            Boolean withoutSource,
                                            String tenantIdIn,
                                            Boolean withoutTenantId,
                                            Boolean includeDeploymentsWithoutTenantId,
                                            Date after,
                                            Date before,
                                            ApiCallback _callback)
                                     throws ApiException
        Build call for getDeploymentsCount
        Parameters:
        id - Filter by deployment id (optional)
        name - Filter by the deployment name. Exact match. (optional)
        nameLike - Filter by the deployment name that the parameter is a substring of. The parameter can include the wildcard `%` to express like-strategy such as: starts with (`%`name), ends with (name`%`) or contains (`%`name`%`). (optional)
        source - Filter by the deployment source. (optional)
        withoutSource - Filter by the deployment source whereby source is equal to `null`. (optional, default to false)
        tenantIdIn - Filter by a comma-separated list of tenant ids. A deployment must have one of the given tenant ids. (optional)
        withoutTenantId - Only include deployments which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
        includeDeploymentsWithoutTenantId - Include deployments which belong to no tenant. Can be used in combination with `tenantIdIn`. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
        after - Restricts to all deployments after the 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)
        before - Restricts to all deployments before the 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)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getDeploymentsCount

        public CountResultDto getDeploymentsCount​(String id,
                                          String name,
                                          String nameLike,
                                          String source,
                                          Boolean withoutSource,
                                          String tenantIdIn,
                                          Boolean withoutTenantId,
                                          Boolean includeDeploymentsWithoutTenantId,
                                          Date after,
                                          Date before)
                                   throws ApiException
        Get List Count Queries for the number of deployments that fulfill given parameters. Takes the same parameters as the [Get Deployments](https://docs.camunda.org/manual/7.18/reference/rest/deployment/get-query/) method.
        Parameters:
        id - Filter by deployment id (optional)
        name - Filter by the deployment name. Exact match. (optional)
        nameLike - Filter by the deployment name that the parameter is a substring of. The parameter can include the wildcard `%` to express like-strategy such as: starts with (`%`name), ends with (name`%`) or contains (`%`name`%`). (optional)
        source - Filter by the deployment source. (optional)
        withoutSource - Filter by the deployment source whereby source is equal to `null`. (optional, default to false)
        tenantIdIn - Filter by a comma-separated list of tenant ids. A deployment must have one of the given tenant ids. (optional)
        withoutTenantId - Only include deployments which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
        includeDeploymentsWithoutTenantId - Include deployments which belong to no tenant. Can be used in combination with `tenantIdIn`. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
        after - Restricts to all deployments after the 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)
        before - Restricts to all deployments before the 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)
        Returns:
        CountResultDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getDeploymentsCountWithHttpInfo

        public ApiResponse<CountResultDto> getDeploymentsCountWithHttpInfo​(String id,
                                                                   String name,
                                                                   String nameLike,
                                                                   String source,
                                                                   Boolean withoutSource,
                                                                   String tenantIdIn,
                                                                   Boolean withoutTenantId,
                                                                   Boolean includeDeploymentsWithoutTenantId,
                                                                   Date after,
                                                                   Date before)
                                                            throws ApiException
        Get List Count Queries for the number of deployments that fulfill given parameters. Takes the same parameters as the [Get Deployments](https://docs.camunda.org/manual/7.18/reference/rest/deployment/get-query/) method.
        Parameters:
        id - Filter by deployment id (optional)
        name - Filter by the deployment name. Exact match. (optional)
        nameLike - Filter by the deployment name that the parameter is a substring of. The parameter can include the wildcard `%` to express like-strategy such as: starts with (`%`name), ends with (name`%`) or contains (`%`name`%`). (optional)
        source - Filter by the deployment source. (optional)
        withoutSource - Filter by the deployment source whereby source is equal to `null`. (optional, default to false)
        tenantIdIn - Filter by a comma-separated list of tenant ids. A deployment must have one of the given tenant ids. (optional)
        withoutTenantId - Only include deployments which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
        includeDeploymentsWithoutTenantId - Include deployments which belong to no tenant. Can be used in combination with `tenantIdIn`. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
        after - Restricts to all deployments after the 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)
        before - Restricts to all deployments before the 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)
        Returns:
        ApiResponse<CountResultDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getDeploymentsCountAsync

        public okhttp3.Call getDeploymentsCountAsync​(String id,
                                             String name,
                                             String nameLike,
                                             String source,
                                             Boolean withoutSource,
                                             String tenantIdIn,
                                             Boolean withoutTenantId,
                                             Boolean includeDeploymentsWithoutTenantId,
                                             Date after,
                                             Date before,
                                             ApiCallback<CountResultDto> _callback)
                                      throws ApiException
        Get List Count (asynchronously) Queries for the number of deployments that fulfill given parameters. Takes the same parameters as the [Get Deployments](https://docs.camunda.org/manual/7.18/reference/rest/deployment/get-query/) method.
        Parameters:
        id - Filter by deployment id (optional)
        name - Filter by the deployment name. Exact match. (optional)
        nameLike - Filter by the deployment name that the parameter is a substring of. The parameter can include the wildcard `%` to express like-strategy such as: starts with (`%`name), ends with (name`%`) or contains (`%`name`%`). (optional)
        source - Filter by the deployment source. (optional)
        withoutSource - Filter by the deployment source whereby source is equal to `null`. (optional, default to false)
        tenantIdIn - Filter by a comma-separated list of tenant ids. A deployment must have one of the given tenant ids. (optional)
        withoutTenantId - Only include deployments which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
        includeDeploymentsWithoutTenantId - Include deployments which belong to no tenant. Can be used in combination with `tenantIdIn`. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
        after - Restricts to all deployments after the 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)
        before - Restricts to all deployments before the 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)
        _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

      • getRegisteredDeploymentsCall

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

      • getRegisteredDeployments

        public List<String> getRegisteredDeployments()
                                      throws ApiException
        Get Registered Deployments Queries the registered deployment IDs for the current application.
        Returns:
        List<String>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getRegisteredDeploymentsWithHttpInfo

        public ApiResponse<List<String>> getRegisteredDeploymentsWithHttpInfo()
                                                               throws ApiException
        Get Registered Deployments Queries the registered deployment IDs for the current application.
        Returns:
        ApiResponse<List<String>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getRegisteredDeploymentsAsync

        public okhttp3.Call getRegisteredDeploymentsAsync​(ApiCallback<List<String>> _callback)
                                           throws ApiException
        Get Registered Deployments (asynchronously) Queries the registered deployment IDs for the current application.
        Parameters:
        _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

      • redeployCall

        public okhttp3.Call redeployCall​(String id,
                                 RedeploymentDto redeploymentDto,
                                 ApiCallback _callback)
                          throws ApiException
        Build call for redeploy
        Parameters:
        id - The id of the deployment to re-deploy. (required)
        redeploymentDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • redeploy

        public DeploymentWithDefinitionsDto redeploy​(String id,
                                             RedeploymentDto redeploymentDto)
                                      throws ApiException
        Redeploy Re-deploys an existing deployment. The deployment resources to re-deploy can be restricted by using the properties `resourceIds` or `resourceNames`. If no deployment resources to re-deploy are passed then all existing resources of the given deployment are re-deployed. **Warning**: Deployments can contain custom code in form of scripts or EL expressions to customize process behavior. This may be abused for remote execution of arbitrary code. See the section on [security considerations for custom code](https://docs.camunda.org/manual/7.18/user-guide/process-engine/securing-custom-code/) in the user guide for details.
        Parameters:
        id - The id of the deployment to re-deploy. (required)
        redeploymentDto - (optional)
        Returns:
        DeploymentWithDefinitionsDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • redeployWithHttpInfo

        public ApiResponse<DeploymentWithDefinitionsDto> redeployWithHttpInfo​(String id,
                                                                      RedeploymentDto redeploymentDto)
                                                               throws ApiException
        Redeploy Re-deploys an existing deployment. The deployment resources to re-deploy can be restricted by using the properties `resourceIds` or `resourceNames`. If no deployment resources to re-deploy are passed then all existing resources of the given deployment are re-deployed. **Warning**: Deployments can contain custom code in form of scripts or EL expressions to customize process behavior. This may be abused for remote execution of arbitrary code. See the section on [security considerations for custom code](https://docs.camunda.org/manual/7.18/user-guide/process-engine/securing-custom-code/) in the user guide for details.
        Parameters:
        id - The id of the deployment to re-deploy. (required)
        redeploymentDto - (optional)
        Returns:
        ApiResponse<DeploymentWithDefinitionsDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • redeployAsync

        public okhttp3.Call redeployAsync​(String id,
                                  RedeploymentDto redeploymentDto,
                                  ApiCallback<DeploymentWithDefinitionsDto> _callback)
                           throws ApiException
        Redeploy (asynchronously) Re-deploys an existing deployment. The deployment resources to re-deploy can be restricted by using the properties `resourceIds` or `resourceNames`. If no deployment resources to re-deploy are passed then all existing resources of the given deployment are re-deployed. **Warning**: Deployments can contain custom code in form of scripts or EL expressions to customize process behavior. This may be abused for remote execution of arbitrary code. See the section on [security considerations for custom code](https://docs.camunda.org/manual/7.18/user-guide/process-engine/securing-custom-code/) in the user guide for details.
        Parameters:
        id - The id of the deployment to re-deploy. (required)
        redeploymentDto - (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