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

Class DeploymentApi

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

  • Constructor Details

    • DeploymentApi

      public DeploymentApi()

    • DeploymentApi

      public DeploymentApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • createDeployment

      public DeploymentWithDefinitionsDto createDeployment(String tenantId, String deploymentSource, Boolean deployChangedOnly, Boolean enableDuplicateFiltering, String deploymentName, OffsetDateTime 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.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
      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 fails to make API call

    • createDeployment

      public DeploymentWithDefinitionsDto createDeployment(String tenantId, String deploymentSource, Boolean deployChangedOnly, Boolean enableDuplicateFiltering, String deploymentName, OffsetDateTime deploymentActivationTime, File data, Map<String,String> additionalHeaders) 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.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
      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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      DeploymentWithDefinitionsDto
      Throws:
      ApiException - if fails to make API call

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

    • deleteDeployment

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

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

    • getDeployment

      public DeploymentDto getDeployment(String id, Map<String,String> additionalHeaders) throws ApiException
      Get Retrieves a deployment by id, according to the `Deployment` interface of the engine.
      Parameters:
      id - The id of the deployment. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      DeploymentDto
      Throws:
      ApiException - if fails to make API call

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

    • getDeploymentResource

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

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

    • getDeploymentResourceData

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

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

    • getDeploymentResources

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

    • getDeployments

      public List<DeploymentDto> getDeployments(String id, String name, String nameLike, String source, Boolean withoutSource, String tenantIdIn, Boolean withoutTenantId, Boolean includeDeploymentsWithoutTenantId, OffsetDateTime after, OffsetDateTime 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.21/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.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
      before - Restricts to all deployments before the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
      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 fails to make API call

    • getDeployments

      public List<DeploymentDto> getDeployments(String id, String name, String nameLike, String source, Boolean withoutSource, String tenantIdIn, Boolean withoutTenantId, Boolean includeDeploymentsWithoutTenantId, OffsetDateTime after, OffsetDateTime before, String sortBy, String sortOrder, Integer firstResult, Integer maxResults, Map<String,String> additionalHeaders) 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.21/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.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
      before - Restricts to all deployments before the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
      sortBy - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)
      sortOrder - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (optional)
      firstResult - Pagination of results. Specifies the index of the first result to return. (optional)
      maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<DeploymentDto>
      Throws:
      ApiException - if fails to make API call

    • getDeploymentsCount

      public CountResultDto getDeploymentsCount(String id, String name, String nameLike, String source, Boolean withoutSource, String tenantIdIn, Boolean withoutTenantId, Boolean includeDeploymentsWithoutTenantId, OffsetDateTime after, OffsetDateTime 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.21/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.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
      before - Restricts to all deployments before the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • getDeploymentsCount

      public CountResultDto getDeploymentsCount(String id, String name, String nameLike, String source, Boolean withoutSource, String tenantIdIn, Boolean withoutTenantId, Boolean includeDeploymentsWithoutTenantId, OffsetDateTime after, OffsetDateTime before, Map<String,String> additionalHeaders) 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.21/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.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
      before - Restricts to all deployments before the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

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

    • getRegisteredDeployments

      public List<String> getRegisteredDeployments(Map<String,String> additionalHeaders) throws ApiException
      Get Registered Deployments Queries the registered deployment IDs for the current application.
      Parameters:
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<String>
      Throws:
      ApiException - if fails to make API call

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

    • redeploy

      public DeploymentWithDefinitionsDto redeploy(String id, RedeploymentDto redeploymentDto, Map<String,String> additionalHeaders) 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.21/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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      DeploymentWithDefinitionsDto
      Throws:
      ApiException - if fails to make API call