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

Class ProcessDefinitionApi

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

  • Constructor Details

    • ProcessDefinitionApi

      public ProcessDefinitionApi()

    • ProcessDefinitionApi

      public ProcessDefinitionApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • deleteProcessDefinition

      public void deleteProcessDefinition(String id, Boolean cascade, Boolean skipCustomListeners, Boolean skipIoMappings) throws ApiException
      Delete Deletes a running process instance by id.
      Parameters:
      id - The id of the process definition to be deleted. (required)
      cascade - `true`, if all process instances, historic process instances and jobs for this process definition should be deleted. (optional)
      skipCustomListeners - `true`, if only the built-in ExecutionListeners should be notified with the end event. (optional, default to false)
      skipIoMappings - A boolean value to control whether input/output mappings should be executed during deletion. `true`, if input/output mappings should not be invoked. (optional, default to false)
      Throws:
      ApiException - if fails to make API call

    • deleteProcessDefinition

      public void deleteProcessDefinition(String id, Boolean cascade, Boolean skipCustomListeners, Boolean skipIoMappings, Map<String,String> additionalHeaders) throws ApiException
      Delete Deletes a running process instance by id.
      Parameters:
      id - The id of the process definition to be deleted. (required)
      cascade - `true`, if all process instances, historic process instances and jobs for this process definition should be deleted. (optional)
      skipCustomListeners - `true`, if only the built-in ExecutionListeners should be notified with the end event. (optional, default to false)
      skipIoMappings - A boolean value to control whether input/output mappings should be executed during deletion. `true`, if input/output mappings should not be invoked. (optional, default to false)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • deleteProcessDefinitionsByKey

      public void deleteProcessDefinitionsByKey(String key, Boolean cascade, Boolean skipCustomListeners, Boolean skipIoMappings) throws ApiException
      Delete By Key Deletes process definitions by a given key which belong to no tenant id.
      Parameters:
      key - The key of the process definitions to be deleted. (required)
      cascade - `true`, if all process instances, historic process instances and jobs for this process definition should be deleted. (optional)
      skipCustomListeners - `true`, if only the built-in ExecutionListeners should be notified with the end event. (optional, default to false)
      skipIoMappings - A boolean value to control whether input/output mappings should be executed during deletion. `true`, if input/output mappings should not be invoked. (optional, default to false)
      Throws:
      ApiException - if fails to make API call

    • deleteProcessDefinitionsByKey

      public void deleteProcessDefinitionsByKey(String key, Boolean cascade, Boolean skipCustomListeners, Boolean skipIoMappings, Map<String,String> additionalHeaders) throws ApiException
      Delete By Key Deletes process definitions by a given key which belong to no tenant id.
      Parameters:
      key - The key of the process definitions to be deleted. (required)
      cascade - `true`, if all process instances, historic process instances and jobs for this process definition should be deleted. (optional)
      skipCustomListeners - `true`, if only the built-in ExecutionListeners should be notified with the end event. (optional, default to false)
      skipIoMappings - A boolean value to control whether input/output mappings should be executed during deletion. `true`, if input/output mappings should not be invoked. (optional, default to false)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • deleteProcessDefinitionsByKeyAndTenantId

      public void deleteProcessDefinitionsByKeyAndTenantId(String key, String tenantId, Boolean cascade, Boolean skipCustomListeners, Boolean skipIoMappings) throws ApiException
      Delete By Key Deletes process definitions by a given key and which belong to a tenant id.
      Parameters:
      key - The key of the process definitions to be deleted. (required)
      tenantId - The id of the tenant the process definitions belong to. (required)
      cascade - `true`, if all process instances, historic process instances and jobs for this process definition should be deleted. (optional)
      skipCustomListeners - `true`, if only the built-in ExecutionListeners should be notified with the end event. (optional, default to false)
      skipIoMappings - A boolean value to control whether input/output mappings should be executed during deletion. `true`, if input/output mappings should not be invoked. (optional, default to false)
      Throws:
      ApiException - if fails to make API call

    • deleteProcessDefinitionsByKeyAndTenantId

      public void deleteProcessDefinitionsByKeyAndTenantId(String key, String tenantId, Boolean cascade, Boolean skipCustomListeners, Boolean skipIoMappings, Map<String,String> additionalHeaders) throws ApiException
      Delete By Key Deletes process definitions by a given key and which belong to a tenant id.
      Parameters:
      key - The key of the process definitions to be deleted. (required)
      tenantId - The id of the tenant the process definitions belong to. (required)
      cascade - `true`, if all process instances, historic process instances and jobs for this process definition should be deleted. (optional)
      skipCustomListeners - `true`, if only the built-in ExecutionListeners should be notified with the end event. (optional, default to false)
      skipIoMappings - A boolean value to control whether input/output mappings should be executed during deletion. `true`, if input/output mappings should not be invoked. (optional, default to false)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • getActivityStatistics

      public List<ActivityStatisticsResultDto> getActivityStatistics(String id, Boolean failedJobs, Boolean incidents, String incidentsForType) throws ApiException
      Get Activity Instance Statistics Retrieves runtime statistics of a given process definition, grouped by activities. These statistics include the number of running activity instances, optionally the number of failed jobs and also optionally the number of incidents either grouped by incident types or for a specific incident type. **Note**: This does not include historic data.
      Parameters:
      id - The id of the process definition. (required)
      failedJobs - Whether to include the number of failed jobs in the result or not. Valid values are `true` or `false`. (optional)
      incidents - Valid values for this property are `true` or `false`. If this property has been set to `true` the result will include the corresponding number of incidents for each occurred incident type. If it is set to `false`, the incidents will not be included in the result. Cannot be used in combination with `incidentsForType`. (optional)
      incidentsForType - If this property has been set with any incident type (i.e., a string value) the result will only include the number of incidents for the assigned incident type. Cannot be used in combination with `incidents`. See the [User Guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/incidents/#incident-types) for a list of incident types. (optional)
      Returns:
      List<ActivityStatisticsResultDto>
      Throws:
      ApiException - if fails to make API call

    • getActivityStatistics

      public List<ActivityStatisticsResultDto> getActivityStatistics(String id, Boolean failedJobs, Boolean incidents, String incidentsForType, Map<String,String> additionalHeaders) throws ApiException
      Get Activity Instance Statistics Retrieves runtime statistics of a given process definition, grouped by activities. These statistics include the number of running activity instances, optionally the number of failed jobs and also optionally the number of incidents either grouped by incident types or for a specific incident type. **Note**: This does not include historic data.
      Parameters:
      id - The id of the process definition. (required)
      failedJobs - Whether to include the number of failed jobs in the result or not. Valid values are `true` or `false`. (optional)
      incidents - Valid values for this property are `true` or `false`. If this property has been set to `true` the result will include the corresponding number of incidents for each occurred incident type. If it is set to `false`, the incidents will not be included in the result. Cannot be used in combination with `incidentsForType`. (optional)
      incidentsForType - If this property has been set with any incident type (i.e., a string value) the result will only include the number of incidents for the assigned incident type. Cannot be used in combination with `incidents`. See the [User Guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/incidents/#incident-types) for a list of incident types. (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<ActivityStatisticsResultDto>
      Throws:
      ApiException - if fails to make API call

    • getActivityStatisticsByProcessDefinitionKey

      public List<ActivityStatisticsResultDto> getActivityStatisticsByProcessDefinitionKey(String key, Boolean failedJobs, Boolean incidents, String incidentsForType) throws ApiException
      Get Activity Instance Statistics Retrieves runtime statistics of the latest version of the given process definition which belongs to no tenant, grouped by activities. These statistics include the number of running activity instances, optionally the number of failed jobs and also optionally the number of incidents either grouped by incident types or for a specific incident type. **Note**: This does not include historic data.
      Parameters:
      key - The key of the process definition (the latest version thereof) to be retrieved. (required)
      failedJobs - Whether to include the number of failed jobs in the result or not. Valid values are `true` or `false`. (optional)
      incidents - Valid values for this property are `true` or `false`. If this property has been set to `true` the result will include the corresponding number of incidents for each occurred incident type. If it is set to `false`, the incidents will not be included in the result. Cannot be used in combination with `incidentsForType`. (optional)
      incidentsForType - If this property has been set with any incident type (i.e., a string value) the result will only include the number of incidents for the assigned incident type. Cannot be used in combination with `incidents`. See the [User Guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/incidents/#incident-types) for a list of incident types. (optional)
      Returns:
      List<ActivityStatisticsResultDto>
      Throws:
      ApiException - if fails to make API call

    • getActivityStatisticsByProcessDefinitionKey

      public List<ActivityStatisticsResultDto> getActivityStatisticsByProcessDefinitionKey(String key, Boolean failedJobs, Boolean incidents, String incidentsForType, Map<String,String> additionalHeaders) throws ApiException
      Get Activity Instance Statistics Retrieves runtime statistics of the latest version of the given process definition which belongs to no tenant, grouped by activities. These statistics include the number of running activity instances, optionally the number of failed jobs and also optionally the number of incidents either grouped by incident types or for a specific incident type. **Note**: This does not include historic data.
      Parameters:
      key - The key of the process definition (the latest version thereof) to be retrieved. (required)
      failedJobs - Whether to include the number of failed jobs in the result or not. Valid values are `true` or `false`. (optional)
      incidents - Valid values for this property are `true` or `false`. If this property has been set to `true` the result will include the corresponding number of incidents for each occurred incident type. If it is set to `false`, the incidents will not be included in the result. Cannot be used in combination with `incidentsForType`. (optional)
      incidentsForType - If this property has been set with any incident type (i.e., a string value) the result will only include the number of incidents for the assigned incident type. Cannot be used in combination with `incidents`. See the [User Guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/incidents/#incident-types) for a list of incident types. (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<ActivityStatisticsResultDto>
      Throws:
      ApiException - if fails to make API call

    • getActivityStatisticsByProcessDefinitionKeyAndTenantId

      public List<ActivityStatisticsResultDto> getActivityStatisticsByProcessDefinitionKeyAndTenantId(String key, String tenantId, Boolean failedJobs, Boolean incidents, String incidentsForType) throws ApiException
      Get Activity Instance Statistics Retrieves runtime statistics of the latest version of the given process definition for a tenant, grouped by activities. These statistics include the number of running activity instances, optionally the number of failed jobs and also optionally the number of incidents either grouped by incident types or for a specific incident type. **Note**: This does not include historic data.
      Parameters:
      key - The key of the process definition (the latest version thereof) to be retrieved. (required)
      tenantId - The id of the tenant the process definition belongs to. (required)
      failedJobs - Whether to include the number of failed jobs in the result or not. Valid values are `true` or `false`. (optional)
      incidents - Valid values for this property are `true` or `false`. If this property has been set to `true` the result will include the corresponding number of incidents for each occurred incident type. If it is set to `false`, the incidents will not be included in the result. Cannot be used in combination with `incidentsForType`. (optional)
      incidentsForType - If this property has been set with any incident type (i.e., a string value) the result will only include the number of incidents for the assigned incident type. Cannot be used in combination with `incidents`. See the [User Guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/incidents/#incident-types) for a list of incident types. (optional)
      Returns:
      List<ActivityStatisticsResultDto>
      Throws:
      ApiException - if fails to make API call

    • getActivityStatisticsByProcessDefinitionKeyAndTenantId

      public List<ActivityStatisticsResultDto> getActivityStatisticsByProcessDefinitionKeyAndTenantId(String key, String tenantId, Boolean failedJobs, Boolean incidents, String incidentsForType, Map<String,String> additionalHeaders) throws ApiException
      Get Activity Instance Statistics Retrieves runtime statistics of the latest version of the given process definition for a tenant, grouped by activities. These statistics include the number of running activity instances, optionally the number of failed jobs and also optionally the number of incidents either grouped by incident types or for a specific incident type. **Note**: This does not include historic data.
      Parameters:
      key - The key of the process definition (the latest version thereof) to be retrieved. (required)
      tenantId - The id of the tenant the process definition belongs to. (required)
      failedJobs - Whether to include the number of failed jobs in the result or not. Valid values are `true` or `false`. (optional)
      incidents - Valid values for this property are `true` or `false`. If this property has been set to `true` the result will include the corresponding number of incidents for each occurred incident type. If it is set to `false`, the incidents will not be included in the result. Cannot be used in combination with `incidentsForType`. (optional)
      incidentsForType - If this property has been set with any incident type (i.e., a string value) the result will only include the number of incidents for the assigned incident type. Cannot be used in combination with `incidents`. See the [User Guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/incidents/#incident-types) for a list of incident types. (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<ActivityStatisticsResultDto>
      Throws:
      ApiException - if fails to make API call

    • getDeployedStartForm

      public File getDeployedStartForm(String id) throws ApiException
      Get Deployed Start Form Retrieves the deployed form that can be referenced from a start event. For further information please refer to [User Guide](https://docs.camunda.org/manual/7.21/user-guide/task-forms/#embedded-task-forms).
      Parameters:
      id - The id of the process definition to get the deployed start form for. (required)
      Returns:
      File
      Throws:
      ApiException - if fails to make API call

    • getDeployedStartForm

      public File getDeployedStartForm(String id, Map<String,String> additionalHeaders) throws ApiException
      Get Deployed Start Form Retrieves the deployed form that can be referenced from a start event. For further information please refer to [User Guide](https://docs.camunda.org/manual/7.21/user-guide/task-forms/#embedded-task-forms).
      Parameters:
      id - The id of the process definition to get the deployed start form for. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      File
      Throws:
      ApiException - if fails to make API call

    • getDeployedStartFormByKey

      public File getDeployedStartFormByKey(String key) throws ApiException
      Get Deployed Start Form Retrieves the deployed form that can be referenced from a start event. For further information please refer to [User Guide](https://docs.camunda.org/manual/7.21/user-guide/task-forms/#embedded-task-forms).
      Parameters:
      key - The key of the process definition (the latest version thereof) to be retrieved. (required)
      Returns:
      File
      Throws:
      ApiException - if fails to make API call

    • getDeployedStartFormByKey

      public File getDeployedStartFormByKey(String key, Map<String,String> additionalHeaders) throws ApiException
      Get Deployed Start Form Retrieves the deployed form that can be referenced from a start event. For further information please refer to [User Guide](https://docs.camunda.org/manual/7.21/user-guide/task-forms/#embedded-task-forms).
      Parameters:
      key - The key of the process definition (the latest version thereof) to be retrieved. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      File
      Throws:
      ApiException - if fails to make API call

    • getDeployedStartFormByKeyAndTenantId

      public File getDeployedStartFormByKeyAndTenantId(String key, String tenantId) throws ApiException
      Get Deployed Start Form Retrieves the deployed form that can be referenced from a start event. For further information please refer to [User Guide](https://docs.camunda.org/manual/7.21/user-guide/task-forms/#embedded-task-forms).
      Parameters:
      key - The key of the process definition (the latest version thereof) to be retrieved. (required)
      tenantId - The id of the tenant the process definitions belong to. (required)
      Returns:
      File
      Throws:
      ApiException - if fails to make API call

    • getDeployedStartFormByKeyAndTenantId

      public File getDeployedStartFormByKeyAndTenantId(String key, String tenantId, Map<String,String> additionalHeaders) throws ApiException
      Get Deployed Start Form Retrieves the deployed form that can be referenced from a start event. For further information please refer to [User Guide](https://docs.camunda.org/manual/7.21/user-guide/task-forms/#embedded-task-forms).
      Parameters:
      key - The key of the process definition (the latest version thereof) to be retrieved. (required)
      tenantId - The id of the tenant the process definitions belong to. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      File
      Throws:
      ApiException - if fails to make API call

    • getLatestProcessDefinitionByTenantId

      public ProcessDefinitionDto getLatestProcessDefinitionByTenantId(String key, String tenantId) throws ApiException
      Get Retrieves the latest version of the process definition for tenant according to the `ProcessDefinition` interface in the engine.
      Parameters:
      key - The key of the process definition (the latest version thereof) to be retrieved. (required)
      tenantId - The id of the tenant the process definition belongs to. (required)
      Returns:
      ProcessDefinitionDto
      Throws:
      ApiException - if fails to make API call

    • getLatestProcessDefinitionByTenantId

      public ProcessDefinitionDto getLatestProcessDefinitionByTenantId(String key, String tenantId, Map<String,String> additionalHeaders) throws ApiException
      Get Retrieves the latest version of the process definition for tenant according to the `ProcessDefinition` interface in the engine.
      Parameters:
      key - The key of the process definition (the latest version thereof) to be retrieved. (required)
      tenantId - The id of the tenant the process definition belongs to. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      ProcessDefinitionDto
      Throws:
      ApiException - if fails to make API call

    • getProcessDefinition

      public ProcessDefinitionDto getProcessDefinition(String id) throws ApiException
      Get Retrieves a process definition according to the `ProcessDefinition` interface in the engine.
      Parameters:
      id - The id of the process definition to be retrieved. (required)
      Returns:
      ProcessDefinitionDto
      Throws:
      ApiException - if fails to make API call

    • getProcessDefinition

      public ProcessDefinitionDto getProcessDefinition(String id, Map<String,String> additionalHeaders) throws ApiException
      Get Retrieves a process definition according to the `ProcessDefinition` interface in the engine.
      Parameters:
      id - The id of the process definition to be retrieved. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      ProcessDefinitionDto
      Throws:
      ApiException - if fails to make API call

    • getProcessDefinitionBpmn20Xml

      public ProcessDefinitionDiagramDto getProcessDefinitionBpmn20Xml(String id) throws ApiException
      Get XML Retrieves the BPMN 2.0 XML of a process definition.
      Parameters:
      id - The id of the process definition. (required)
      Returns:
      ProcessDefinitionDiagramDto
      Throws:
      ApiException - if fails to make API call

    • getProcessDefinitionBpmn20Xml

      public ProcessDefinitionDiagramDto getProcessDefinitionBpmn20Xml(String id, Map<String,String> additionalHeaders) throws ApiException
      Get XML Retrieves the BPMN 2.0 XML of a process definition.
      Parameters:
      id - The id of the process definition. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      ProcessDefinitionDiagramDto
      Throws:
      ApiException - if fails to make API call

    • getProcessDefinitionBpmn20XmlByKey

      public ProcessDefinitionDiagramDto getProcessDefinitionBpmn20XmlByKey(String key) throws ApiException
      Get XML Retrieves latest version the BPMN 2.0 XML of a process definition.
      Parameters:
      key - The key of the process definition (the latest version thereof) whose XML should be retrieved. (required)
      Returns:
      ProcessDefinitionDiagramDto
      Throws:
      ApiException - if fails to make API call

    • getProcessDefinitionBpmn20XmlByKey

      public ProcessDefinitionDiagramDto getProcessDefinitionBpmn20XmlByKey(String key, Map<String,String> additionalHeaders) throws ApiException
      Get XML Retrieves latest version the BPMN 2.0 XML of a process definition.
      Parameters:
      key - The key of the process definition (the latest version thereof) whose XML should be retrieved. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      ProcessDefinitionDiagramDto
      Throws:
      ApiException - if fails to make API call

    • getProcessDefinitionBpmn20XmlByKeyAndTenantId

      public ProcessDefinitionDiagramDto getProcessDefinitionBpmn20XmlByKeyAndTenantId(String key, String tenantId) throws ApiException
      Get XML Retrieves latest version the BPMN 2.0 XML of a process definition. Returns the XML for the latest version of the process definition for tenant.
      Parameters:
      key - The key of the process definition (the latest version thereof) whose XML should be retrieved. (required)
      tenantId - The id of the tenant the process definition belongs to. (required)
      Returns:
      ProcessDefinitionDiagramDto
      Throws:
      ApiException - if fails to make API call

    • getProcessDefinitionBpmn20XmlByKeyAndTenantId

      public ProcessDefinitionDiagramDto getProcessDefinitionBpmn20XmlByKeyAndTenantId(String key, String tenantId, Map<String,String> additionalHeaders) throws ApiException
      Get XML Retrieves latest version the BPMN 2.0 XML of a process definition. Returns the XML for the latest version of the process definition for tenant.
      Parameters:
      key - The key of the process definition (the latest version thereof) whose XML should be retrieved. (required)
      tenantId - The id of the tenant the process definition belongs to. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      ProcessDefinitionDiagramDto
      Throws:
      ApiException - if fails to make API call

    • getProcessDefinitionByKey

      public ProcessDefinitionDto getProcessDefinitionByKey(String key) throws ApiException
      Get Retrieves the latest version of the process definition which belongs to no tenant according to the `ProcessDefinition` interface in the engine.
      Parameters:
      key - The key of the process definition (the latest version thereof) to be retrieved. (required)
      Returns:
      ProcessDefinitionDto
      Throws:
      ApiException - if fails to make API call

    • getProcessDefinitionByKey

      public ProcessDefinitionDto getProcessDefinitionByKey(String key, Map<String,String> additionalHeaders) throws ApiException
      Get Retrieves the latest version of the process definition which belongs to no tenant according to the `ProcessDefinition` interface in the engine.
      Parameters:
      key - The key of the process definition (the latest version thereof) to be retrieved. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      ProcessDefinitionDto
      Throws:
      ApiException - if fails to make API call

    • getProcessDefinitionDiagram

      public File getProcessDefinitionDiagram(String id) throws ApiException
      Get Diagram Retrieves the diagram of a process definition. If the process definition's deployment contains an image resource with the same file name as the process definition, the deployed image will be returned by the Get Diagram endpoint. Example: `someProcess.bpmn` and `someProcess.png`. Supported file extentions for the image are: `svg`, `png`, `jpg`, and `gif`.
      Parameters:
      id - The id of the process definition. (required)
      Returns:
      File
      Throws:
      ApiException - if fails to make API call

    • getProcessDefinitionDiagram

      public File getProcessDefinitionDiagram(String id, Map<String,String> additionalHeaders) throws ApiException
      Get Diagram Retrieves the diagram of a process definition. If the process definition's deployment contains an image resource with the same file name as the process definition, the deployed image will be returned by the Get Diagram endpoint. Example: `someProcess.bpmn` and `someProcess.png`. Supported file extentions for the image are: `svg`, `png`, `jpg`, and `gif`.
      Parameters:
      id - The id of the process definition. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      File
      Throws:
      ApiException - if fails to make API call

    • getProcessDefinitionDiagramByKey

      public File getProcessDefinitionDiagramByKey(String key) throws ApiException
      Get Diagram Retrieves the diagram for the latest version of the process definition which belongs to no tenant. If the process definition's deployment contains an image resource with the same file name as the process definition, the deployed image will be returned by the Get Diagram endpoint. Example: `someProcess.bpmn` and `someProcess.png`. Supported file extentions for the image are: `svg`, `png`, `jpg`, and `gif`.
      Parameters:
      key - The key of the process definition. (required)
      Returns:
      File
      Throws:
      ApiException - if fails to make API call

    • getProcessDefinitionDiagramByKey

      public File getProcessDefinitionDiagramByKey(String key, Map<String,String> additionalHeaders) throws ApiException
      Get Diagram Retrieves the diagram for the latest version of the process definition which belongs to no tenant. If the process definition's deployment contains an image resource with the same file name as the process definition, the deployed image will be returned by the Get Diagram endpoint. Example: `someProcess.bpmn` and `someProcess.png`. Supported file extentions for the image are: `svg`, `png`, `jpg`, and `gif`.
      Parameters:
      key - The key of the process definition. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      File
      Throws:
      ApiException - if fails to make API call

    • getProcessDefinitionDiagramByKeyAndTenantId

      public File getProcessDefinitionDiagramByKeyAndTenantId(String key, String tenantId) throws ApiException
      Get Diagram Retrieves the diagram for the latest version of the process definition for tenant. If the process definition's deployment contains an image resource with the same file name as the process definition, the deployed image will be returned by the Get Diagram endpoint. Example: `someProcess.bpmn` and `someProcess.png`. Supported file extentions for the image are: `svg`, `png`, `jpg`, and `gif`.
      Parameters:
      key - The key of the process definition. (required)
      tenantId - The id of the tenant the process definition belongs to. (required)
      Returns:
      File
      Throws:
      ApiException - if fails to make API call

    • getProcessDefinitionDiagramByKeyAndTenantId

      public File getProcessDefinitionDiagramByKeyAndTenantId(String key, String tenantId, Map<String,String> additionalHeaders) throws ApiException
      Get Diagram Retrieves the diagram for the latest version of the process definition for tenant. If the process definition's deployment contains an image resource with the same file name as the process definition, the deployed image will be returned by the Get Diagram endpoint. Example: `someProcess.bpmn` and `someProcess.png`. Supported file extentions for the image are: `svg`, `png`, `jpg`, and `gif`.
      Parameters:
      key - The key of the process definition. (required)
      tenantId - The id of the tenant the process definition belongs to. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      File
      Throws:
      ApiException - if fails to make API call

    • getProcessDefinitionStatistics

      public List<ProcessDefinitionStatisticsResultDto> getProcessDefinitionStatistics(Boolean failedJobs, Boolean incidents, String incidentsForType, Boolean rootIncidents) throws ApiException
      Get Process Instance Statistics Retrieves runtime statistics of the process engine, grouped by process definitions. These statistics include the number of running process instances, optionally the number of failed jobs and also optionally the number of incidents either grouped by incident types or for a specific incident type. **Note**: This does not include historic data.
      Parameters:
      failedJobs - Whether to include the number of failed jobs in the result or not. Valid values are `true` or `false`. (optional)
      incidents - Valid values for this property are `true` or `false`. If this property has been set to `true` the result will include the corresponding number of incidents for each occurred incident type. If it is set to `false`, the incidents will not be included in the result. Cannot be used in combination with `incidentsForType`. (optional)
      incidentsForType - If this property has been set with any incident type (i.e., a string value) the result will only include the number of incidents for the assigned incident type. Cannot be used in combination with `incidents`. See the [User Guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/incidents/#incident-types) for a list of incident types. (optional)
      rootIncidents - Valid values for this property are `true` or `false`. If this property has been set to `true` the result will include the corresponding number of root incidents for each occurred incident type. If it is set to `false`, the incidents will not be included in the result. Cannot be used in combination with `incidentsForType` or `incidents`. (optional)
      Returns:
      List<ProcessDefinitionStatisticsResultDto>
      Throws:
      ApiException - if fails to make API call

    • getProcessDefinitionStatistics

      public List<ProcessDefinitionStatisticsResultDto> getProcessDefinitionStatistics(Boolean failedJobs, Boolean incidents, String incidentsForType, Boolean rootIncidents, Map<String,String> additionalHeaders) throws ApiException
      Get Process Instance Statistics Retrieves runtime statistics of the process engine, grouped by process definitions. These statistics include the number of running process instances, optionally the number of failed jobs and also optionally the number of incidents either grouped by incident types or for a specific incident type. **Note**: This does not include historic data.
      Parameters:
      failedJobs - Whether to include the number of failed jobs in the result or not. Valid values are `true` or `false`. (optional)
      incidents - Valid values for this property are `true` or `false`. If this property has been set to `true` the result will include the corresponding number of incidents for each occurred incident type. If it is set to `false`, the incidents will not be included in the result. Cannot be used in combination with `incidentsForType`. (optional)
      incidentsForType - If this property has been set with any incident type (i.e., a string value) the result will only include the number of incidents for the assigned incident type. Cannot be used in combination with `incidents`. See the [User Guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/incidents/#incident-types) for a list of incident types. (optional)
      rootIncidents - Valid values for this property are `true` or `false`. If this property has been set to `true` the result will include the corresponding number of root incidents for each occurred incident type. If it is set to `false`, the incidents will not be included in the result. Cannot be used in combination with `incidentsForType` or `incidents`. (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<ProcessDefinitionStatisticsResultDto>
      Throws:
      ApiException - if fails to make API call

    • getProcessDefinitions

      public List<ProcessDefinitionDto> getProcessDefinitions(String processDefinitionId, String processDefinitionIdIn, String name, String nameLike, String deploymentId, OffsetDateTime deployedAfter, OffsetDateTime deployedAt, String key, String keysIn, String keyLike, String category, String categoryLike, Integer version, Boolean latestVersion, String resourceName, String resourceNameLike, String startableBy, Boolean active, Boolean suspended, String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String tenantIdIn, Boolean withoutTenantId, Boolean includeProcessDefinitionsWithoutTenantId, String versionTag, String versionTagLike, Boolean withoutVersionTag, Boolean startableInTasklist, Boolean notStartableInTasklist, Boolean startablePermissionCheck, String sortBy, String sortOrder, Integer firstResult, Integer maxResults) throws ApiException
      Get List Queries for process definitions that fulfill given parameters. Parameters may be the properties of process definitions, such as the name, key or version. The size of the result set can be retrieved by using the [Get Definition Count](https://docs.camunda.org/manual/7.21/reference/rest/process-definition/get-query-count/) method.
      Parameters:
      processDefinitionId - Filter by process definition id. (optional)
      processDefinitionIdIn - Filter by a comma-separated list of process definition ids. (optional)
      name - Filter by process definition name. (optional)
      nameLike - Filter by process definition names that the parameter is a substring of. (optional)
      deploymentId - Filter by the deployment the id belongs to. (optional)
      deployedAfter - Filter by the deploy time of the deployment the process definition belongs to. Only selects process definitions that have been deployed after (exclusive) a specific time. 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.546+0200`. (optional)
      deployedAt - Filter by the deploy time of the deployment the process definition belongs to. Only selects process definitions that have been deployed at a specific time (exact match). 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.546+0200`. (optional)
      key - Filter by process definition key, i.e., the id in the BPMN 2.0 XML. Exact match. (optional)
      keysIn - Filter by a comma-separated list of process definition keys. (optional)
      keyLike - Filter by process definition keys that the parameter is a substring of. (optional)
      category - Filter by process definition category. Exact match. (optional)
      categoryLike - Filter by process definition categories that the parameter is a substring of. (optional)
      version - Filter by process definition version. (optional)
      latestVersion - Only include those process definitions that are latest versions. Value may only be `true`, as `false` is the default behavior. (optional)
      resourceName - Filter by the name of the process definition resource. Exact match. (optional)
      resourceNameLike - Filter by names of those process definition resources that the parameter is a substring of. (optional)
      startableBy - Filter by a user name who is allowed to start the process. (optional)
      active - Only include active process definitions. Value may only be `true`, as `false` is the default behavior. (optional)
      suspended - Only include suspended process definitions. Value may only be `true`, as `false` is the default behavior. (optional)
      incidentId - Filter by the incident id. (optional)
      incidentType - Filter by the incident type. See the [User Guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/incidents/#incident-types) for a list of incident types. (optional)
      incidentMessage - Filter by the incident message. Exact match. (optional)
      incidentMessageLike - Filter by the incident message that the parameter is a substring of. (optional)
      tenantIdIn - Filter by a comma-separated list of tenant ids. A process definition must have one of the given tenant ids. (optional)
      withoutTenantId - Only include process definitions which belong to no tenant. Value may only be true, as false is the default behavior. (optional)
      includeProcessDefinitionsWithoutTenantId - Include process 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)
      versionTag - Filter by the version tag. (optional)
      versionTagLike - Filter by the version tag that the parameter is a substring of. (optional)
      withoutVersionTag - Only include process definitions without a `versionTag`. (optional)
      startableInTasklist - Filter by process definitions which are startable in Tasklist.. (optional)
      notStartableInTasklist - Filter by process definitions which are not startable in Tasklist. (optional)
      startablePermissionCheck - Filter by process definitions which the user is allowed to start in Tasklist. If the user doesn't have these permissions the result will be empty list. The permissions are: * `CREATE` permission for all Process instances * `CREATE_INSTANCE` and `READ` permission on Process definition level (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<ProcessDefinitionDto>
      Throws:
      ApiException - if fails to make API call

    • getProcessDefinitions

      public List<ProcessDefinitionDto> getProcessDefinitions(String processDefinitionId, String processDefinitionIdIn, String name, String nameLike, String deploymentId, OffsetDateTime deployedAfter, OffsetDateTime deployedAt, String key, String keysIn, String keyLike, String category, String categoryLike, Integer version, Boolean latestVersion, String resourceName, String resourceNameLike, String startableBy, Boolean active, Boolean suspended, String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String tenantIdIn, Boolean withoutTenantId, Boolean includeProcessDefinitionsWithoutTenantId, String versionTag, String versionTagLike, Boolean withoutVersionTag, Boolean startableInTasklist, Boolean notStartableInTasklist, Boolean startablePermissionCheck, String sortBy, String sortOrder, Integer firstResult, Integer maxResults, Map<String,String> additionalHeaders) throws ApiException
      Get List Queries for process definitions that fulfill given parameters. Parameters may be the properties of process definitions, such as the name, key or version. The size of the result set can be retrieved by using the [Get Definition Count](https://docs.camunda.org/manual/7.21/reference/rest/process-definition/get-query-count/) method.
      Parameters:
      processDefinitionId - Filter by process definition id. (optional)
      processDefinitionIdIn - Filter by a comma-separated list of process definition ids. (optional)
      name - Filter by process definition name. (optional)
      nameLike - Filter by process definition names that the parameter is a substring of. (optional)
      deploymentId - Filter by the deployment the id belongs to. (optional)
      deployedAfter - Filter by the deploy time of the deployment the process definition belongs to. Only selects process definitions that have been deployed after (exclusive) a specific time. 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.546+0200`. (optional)
      deployedAt - Filter by the deploy time of the deployment the process definition belongs to. Only selects process definitions that have been deployed at a specific time (exact match). 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.546+0200`. (optional)
      key - Filter by process definition key, i.e., the id in the BPMN 2.0 XML. Exact match. (optional)
      keysIn - Filter by a comma-separated list of process definition keys. (optional)
      keyLike - Filter by process definition keys that the parameter is a substring of. (optional)
      category - Filter by process definition category. Exact match. (optional)
      categoryLike - Filter by process definition categories that the parameter is a substring of. (optional)
      version - Filter by process definition version. (optional)
      latestVersion - Only include those process definitions that are latest versions. Value may only be `true`, as `false` is the default behavior. (optional)
      resourceName - Filter by the name of the process definition resource. Exact match. (optional)
      resourceNameLike - Filter by names of those process definition resources that the parameter is a substring of. (optional)
      startableBy - Filter by a user name who is allowed to start the process. (optional)
      active - Only include active process definitions. Value may only be `true`, as `false` is the default behavior. (optional)
      suspended - Only include suspended process definitions. Value may only be `true`, as `false` is the default behavior. (optional)
      incidentId - Filter by the incident id. (optional)
      incidentType - Filter by the incident type. See the [User Guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/incidents/#incident-types) for a list of incident types. (optional)
      incidentMessage - Filter by the incident message. Exact match. (optional)
      incidentMessageLike - Filter by the incident message that the parameter is a substring of. (optional)
      tenantIdIn - Filter by a comma-separated list of tenant ids. A process definition must have one of the given tenant ids. (optional)
      withoutTenantId - Only include process definitions which belong to no tenant. Value may only be true, as false is the default behavior. (optional)
      includeProcessDefinitionsWithoutTenantId - Include process 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)
      versionTag - Filter by the version tag. (optional)
      versionTagLike - Filter by the version tag that the parameter is a substring of. (optional)
      withoutVersionTag - Only include process definitions without a `versionTag`. (optional)
      startableInTasklist - Filter by process definitions which are startable in Tasklist.. (optional)
      notStartableInTasklist - Filter by process definitions which are not startable in Tasklist. (optional)
      startablePermissionCheck - Filter by process definitions which the user is allowed to start in Tasklist. If the user doesn't have these permissions the result will be empty list. The permissions are: * `CREATE` permission for all Process instances * `CREATE_INSTANCE` and `READ` permission on Process definition level (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<ProcessDefinitionDto>
      Throws:
      ApiException - if fails to make API call

    • getProcessDefinitionsCount

      public CountResultDto getProcessDefinitionsCount(String processDefinitionId, String processDefinitionIdIn, String name, String nameLike, String deploymentId, OffsetDateTime deployedAfter, OffsetDateTime deployedAt, String key, String keysIn, String keyLike, String category, String categoryLike, Integer version, Boolean latestVersion, String resourceName, String resourceNameLike, String startableBy, Boolean active, Boolean suspended, String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String tenantIdIn, Boolean withoutTenantId, Boolean includeProcessDefinitionsWithoutTenantId, String versionTag, String versionTagLike, Boolean withoutVersionTag, Boolean startableInTasklist, Boolean notStartableInTasklist, Boolean startablePermissionCheck) throws ApiException
      Get List Count Requests the number of process definitions that fulfill the query criteria. Takes the same filtering parameters as the [Get Definitions](https://docs.camunda.org/manual/7.21/reference/rest/process-definition/get-query/) method.
      Parameters:
      processDefinitionId - Filter by process definition id. (optional)
      processDefinitionIdIn - Filter by a comma-separated list of process definition ids. (optional)
      name - Filter by process definition name. (optional)
      nameLike - Filter by process definition names that the parameter is a substring of. (optional)
      deploymentId - Filter by the deployment the id belongs to. (optional)
      deployedAfter - Filter by the deploy time of the deployment the process definition belongs to. Only selects process definitions that have been deployed after (exclusive) a specific time. 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.546+0200`. (optional)
      deployedAt - Filter by the deploy time of the deployment the process definition belongs to. Only selects process definitions that have been deployed at a specific time (exact match). 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.546+0200`. (optional)
      key - Filter by process definition key, i.e., the id in the BPMN 2.0 XML. Exact match. (optional)
      keysIn - Filter by a comma-separated list of process definition keys. (optional)
      keyLike - Filter by process definition keys that the parameter is a substring of. (optional)
      category - Filter by process definition category. Exact match. (optional)
      categoryLike - Filter by process definition categories that the parameter is a substring of. (optional)
      version - Filter by process definition version. (optional)
      latestVersion - Only include those process definitions that are latest versions. Value may only be `true`, as `false` is the default behavior. (optional)
      resourceName - Filter by the name of the process definition resource. Exact match. (optional)
      resourceNameLike - Filter by names of those process definition resources that the parameter is a substring of. (optional)
      startableBy - Filter by a user name who is allowed to start the process. (optional)
      active - Only include active process definitions. Value may only be `true`, as `false` is the default behavior. (optional)
      suspended - Only include suspended process definitions. Value may only be `true`, as `false` is the default behavior. (optional)
      incidentId - Filter by the incident id. (optional)
      incidentType - Filter by the incident type. See the [User Guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/incidents/#incident-types) for a list of incident types. (optional)
      incidentMessage - Filter by the incident message. Exact match. (optional)
      incidentMessageLike - Filter by the incident message that the parameter is a substring of. (optional)
      tenantIdIn - Filter by a comma-separated list of tenant ids. A process definition must have one of the given tenant ids. (optional)
      withoutTenantId - Only include process definitions which belong to no tenant. Value may only be true, as false is the default behavior. (optional)
      includeProcessDefinitionsWithoutTenantId - Include process 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)
      versionTag - Filter by the version tag. (optional)
      versionTagLike - Filter by the version tag that the parameter is a substring of. (optional)
      withoutVersionTag - Only include process definitions without a `versionTag`. (optional)
      startableInTasklist - Filter by process definitions which are startable in Tasklist.. (optional)
      notStartableInTasklist - Filter by process definitions which are not startable in Tasklist. (optional)
      startablePermissionCheck - Filter by process definitions which the user is allowed to start in Tasklist. If the user doesn't have these permissions the result will be empty list. The permissions are: * `CREATE` permission for all Process instances * `CREATE_INSTANCE` and `READ` permission on Process definition level (optional)
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • getProcessDefinitionsCount

      public CountResultDto getProcessDefinitionsCount(String processDefinitionId, String processDefinitionIdIn, String name, String nameLike, String deploymentId, OffsetDateTime deployedAfter, OffsetDateTime deployedAt, String key, String keysIn, String keyLike, String category, String categoryLike, Integer version, Boolean latestVersion, String resourceName, String resourceNameLike, String startableBy, Boolean active, Boolean suspended, String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String tenantIdIn, Boolean withoutTenantId, Boolean includeProcessDefinitionsWithoutTenantId, String versionTag, String versionTagLike, Boolean withoutVersionTag, Boolean startableInTasklist, Boolean notStartableInTasklist, Boolean startablePermissionCheck, Map<String,String> additionalHeaders) throws ApiException
      Get List Count Requests the number of process definitions that fulfill the query criteria. Takes the same filtering parameters as the [Get Definitions](https://docs.camunda.org/manual/7.21/reference/rest/process-definition/get-query/) method.
      Parameters:
      processDefinitionId - Filter by process definition id. (optional)
      processDefinitionIdIn - Filter by a comma-separated list of process definition ids. (optional)
      name - Filter by process definition name. (optional)
      nameLike - Filter by process definition names that the parameter is a substring of. (optional)
      deploymentId - Filter by the deployment the id belongs to. (optional)
      deployedAfter - Filter by the deploy time of the deployment the process definition belongs to. Only selects process definitions that have been deployed after (exclusive) a specific time. 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.546+0200`. (optional)
      deployedAt - Filter by the deploy time of the deployment the process definition belongs to. Only selects process definitions that have been deployed at a specific time (exact match). 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.546+0200`. (optional)
      key - Filter by process definition key, i.e., the id in the BPMN 2.0 XML. Exact match. (optional)
      keysIn - Filter by a comma-separated list of process definition keys. (optional)
      keyLike - Filter by process definition keys that the parameter is a substring of. (optional)
      category - Filter by process definition category. Exact match. (optional)
      categoryLike - Filter by process definition categories that the parameter is a substring of. (optional)
      version - Filter by process definition version. (optional)
      latestVersion - Only include those process definitions that are latest versions. Value may only be `true`, as `false` is the default behavior. (optional)
      resourceName - Filter by the name of the process definition resource. Exact match. (optional)
      resourceNameLike - Filter by names of those process definition resources that the parameter is a substring of. (optional)
      startableBy - Filter by a user name who is allowed to start the process. (optional)
      active - Only include active process definitions. Value may only be `true`, as `false` is the default behavior. (optional)
      suspended - Only include suspended process definitions. Value may only be `true`, as `false` is the default behavior. (optional)
      incidentId - Filter by the incident id. (optional)
      incidentType - Filter by the incident type. See the [User Guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/incidents/#incident-types) for a list of incident types. (optional)
      incidentMessage - Filter by the incident message. Exact match. (optional)
      incidentMessageLike - Filter by the incident message that the parameter is a substring of. (optional)
      tenantIdIn - Filter by a comma-separated list of tenant ids. A process definition must have one of the given tenant ids. (optional)
      withoutTenantId - Only include process definitions which belong to no tenant. Value may only be true, as false is the default behavior. (optional)
      includeProcessDefinitionsWithoutTenantId - Include process 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)
      versionTag - Filter by the version tag. (optional)
      versionTagLike - Filter by the version tag that the parameter is a substring of. (optional)
      withoutVersionTag - Only include process definitions without a `versionTag`. (optional)
      startableInTasklist - Filter by process definitions which are startable in Tasklist.. (optional)
      notStartableInTasklist - Filter by process definitions which are not startable in Tasklist. (optional)
      startablePermissionCheck - Filter by process definitions which the user is allowed to start in Tasklist. If the user doesn't have these permissions the result will be empty list. The permissions are: * `CREATE` permission for all Process instances * `CREATE_INSTANCE` and `READ` permission on Process definition level (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • getRenderedStartForm

      public File getRenderedStartForm(String id) throws ApiException
      Get Rendered Start Form Retrieves the rendered form for a process definition. This method can be used to get the HTML rendering of a [Generated Task Form](https://docs.camunda.org/manual/7.21/user-guide/task-forms/#generated-task-forms).
      Parameters:
      id - The id of the process definition to get the rendered start form for. (required)
      Returns:
      File
      Throws:
      ApiException - if fails to make API call

    • getRenderedStartForm

      public File getRenderedStartForm(String id, Map<String,String> additionalHeaders) throws ApiException
      Get Rendered Start Form Retrieves the rendered form for a process definition. This method can be used to get the HTML rendering of a [Generated Task Form](https://docs.camunda.org/manual/7.21/user-guide/task-forms/#generated-task-forms).
      Parameters:
      id - The id of the process definition to get the rendered start form for. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      File
      Throws:
      ApiException - if fails to make API call

    • getRenderedStartFormByKey

      public File getRenderedStartFormByKey(String key) throws ApiException
      Get Rendered Start Form Retrieves the rendered form for the latest version of the process definition which belongs to no tenant. This method can be used to get the HTML rendering of a [Generated Task Form](https://docs.camunda.org/manual/7.21/user-guide/task-forms/#generated-task-forms).
      Parameters:
      key - The key of the process definition (the latest version thereof) to be retrieved. (required)
      Returns:
      File
      Throws:
      ApiException - if fails to make API call

    • getRenderedStartFormByKey

      public File getRenderedStartFormByKey(String key, Map<String,String> additionalHeaders) throws ApiException
      Get Rendered Start Form Retrieves the rendered form for the latest version of the process definition which belongs to no tenant. This method can be used to get the HTML rendering of a [Generated Task Form](https://docs.camunda.org/manual/7.21/user-guide/task-forms/#generated-task-forms).
      Parameters:
      key - The key of the process definition (the latest version thereof) to be retrieved. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      File
      Throws:
      ApiException - if fails to make API call

    • getRenderedStartFormByKeyAndTenantId

      public File getRenderedStartFormByKeyAndTenantId(String key, String tenantId) throws ApiException
      Get Rendered Start Form Retrieves the rendered form for the latest version of the process definition for a tenant. This method can be used to get the HTML rendering of a [Generated Task Form](https://docs.camunda.org/manual/7.21/user-guide/task-forms/#generated-task-forms).
      Parameters:
      key - The key of the process definition (the latest version thereof) to be retrieved. (required)
      tenantId - The id of the tenant the process definition belongs to. (required)
      Returns:
      File
      Throws:
      ApiException - if fails to make API call

    • getRenderedStartFormByKeyAndTenantId

      public File getRenderedStartFormByKeyAndTenantId(String key, String tenantId, Map<String,String> additionalHeaders) throws ApiException
      Get Rendered Start Form Retrieves the rendered form for the latest version of the process definition for a tenant. This method can be used to get the HTML rendering of a [Generated Task Form](https://docs.camunda.org/manual/7.21/user-guide/task-forms/#generated-task-forms).
      Parameters:
      key - The key of the process definition (the latest version thereof) to be retrieved. (required)
      tenantId - The id of the tenant the process definition belongs to. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      File
      Throws:
      ApiException - if fails to make API call

    • getStartForm

      public FormDto getStartForm(String id) throws ApiException
      Get Start Form Key Retrieves the key of the start form for a process definition. The form key corresponds to the `FormData#formKey` property in the engine.
      Parameters:
      id - The id of the process definition to get the start form key for. (required)
      Returns:
      FormDto
      Throws:
      ApiException - if fails to make API call

    • getStartForm

      public FormDto getStartForm(String id, Map<String,String> additionalHeaders) throws ApiException
      Get Start Form Key Retrieves the key of the start form for a process definition. The form key corresponds to the `FormData#formKey` property in the engine.
      Parameters:
      id - The id of the process definition to get the start form key for. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      FormDto
      Throws:
      ApiException - if fails to make API call

    • getStartFormByKey

      public FormDto getStartFormByKey(String key) throws ApiException
      Get Start Form Key Retrieves the key of the start form for the latest version of the process definition which belongs to no tenant. The form key corresponds to the `FormData#formKey` property in the engine.
      Parameters:
      key - The key of the process definition (the latest version thereof) for which the form key is to be retrieved. (required)
      Returns:
      FormDto
      Throws:
      ApiException - if fails to make API call

    • getStartFormByKey

      public FormDto getStartFormByKey(String key, Map<String,String> additionalHeaders) throws ApiException
      Get Start Form Key Retrieves the key of the start form for the latest version of the process definition which belongs to no tenant. The form key corresponds to the `FormData#formKey` property in the engine.
      Parameters:
      key - The key of the process definition (the latest version thereof) for which the form key is to be retrieved. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      FormDto
      Throws:
      ApiException - if fails to make API call

    • getStartFormByKeyAndTenantId

      public FormDto getStartFormByKeyAndTenantId(String key, String tenantId) throws ApiException
      Get Start Form Key Retrieves the key of the start form for the latest version of the process definition for a tenant. The form key corresponds to the `FormData#formKey` property in the engine.
      Parameters:
      key - The key of the process definition (the latest version thereof) for which the form key is to be retrieved. (required)
      tenantId - The id of the tenant the process definition belongs to. (required)
      Returns:
      FormDto
      Throws:
      ApiException - if fails to make API call

    • getStartFormByKeyAndTenantId

      public FormDto getStartFormByKeyAndTenantId(String key, String tenantId, Map<String,String> additionalHeaders) throws ApiException
      Get Start Form Key Retrieves the key of the start form for the latest version of the process definition for a tenant. The form key corresponds to the `FormData#formKey` property in the engine.
      Parameters:
      key - The key of the process definition (the latest version thereof) for which the form key is to be retrieved. (required)
      tenantId - The id of the tenant the process definition belongs to. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      FormDto
      Throws:
      ApiException - if fails to make API call

    • getStartFormVariables

      public Map<String,VariableValueDto> getStartFormVariables(String id, String variableNames, Boolean deserializeValues) throws ApiException
      Get Start Form Variables Retrieves the start form variables for a process definition (only if they are defined via the [Generated Task Form](https://docs.camunda.org/manual/7.21/user-guide/task-forms/#generated-task-forms) approach). The start form variables take form data specified on the start event into account. If form fields are defined, the variable types and default values of the form fields are taken into account.
      Parameters:
      id - The id of the process definition to retrieve the variables for. (required)
      variableNames - A comma-separated list of variable names. Allows restricting the list of requested variables to the variable names in the list. It is best practice to restrict the list of variables to the variables actually required by the form in order to minimize fetching of data. If the query parameter is ommitted all variables are fetched. If the query parameter contains non-existent variable names, the variable names are ignored. (optional)
      deserializeValues - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default true). If set to true, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](http://jackson.codehaus.org/) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. **Note**: While true is the default value for reasons of backward compatibility, we recommend setting this parameter to false when developing web applications that are independent of the Java process applications deployed to the engine. (optional, default to true)
      Returns:
      Map<String, VariableValueDto>
      Throws:
      ApiException - if fails to make API call

    • getStartFormVariables

      public Map<String,VariableValueDto> getStartFormVariables(String id, String variableNames, Boolean deserializeValues, Map<String,String> additionalHeaders) throws ApiException
      Get Start Form Variables Retrieves the start form variables for a process definition (only if they are defined via the [Generated Task Form](https://docs.camunda.org/manual/7.21/user-guide/task-forms/#generated-task-forms) approach). The start form variables take form data specified on the start event into account. If form fields are defined, the variable types and default values of the form fields are taken into account.
      Parameters:
      id - The id of the process definition to retrieve the variables for. (required)
      variableNames - A comma-separated list of variable names. Allows restricting the list of requested variables to the variable names in the list. It is best practice to restrict the list of variables to the variables actually required by the form in order to minimize fetching of data. If the query parameter is ommitted all variables are fetched. If the query parameter contains non-existent variable names, the variable names are ignored. (optional)
      deserializeValues - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default true). If set to true, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](http://jackson.codehaus.org/) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. **Note**: While true is the default value for reasons of backward compatibility, we recommend setting this parameter to false when developing web applications that are independent of the Java process applications deployed to the engine. (optional, default to true)
      additionalHeaders - additionalHeaders for this call
      Returns:
      Map<String, VariableValueDto>
      Throws:
      ApiException - if fails to make API call

    • getStartFormVariablesByKey

      public Map<String,VariableValueDto> getStartFormVariablesByKey(String key, String variableNames, Boolean deserializeValues) throws ApiException
      Get Start Form Variables Retrieves the start form variables for the latest process definition which belongs to no tenant (only if they are defined via the [Generated Task Form](https://docs.camunda.org/manual/7.21/user-guide/task-forms/#generated-task-forms) approach). The start form variables take form data specified on the start event into account. If form fields are defined, the variable types and default values of the form fields are taken into account.
      Parameters:
      key - The key of the process definition (the latest version thereof) to be retrieved. (required)
      variableNames - A comma-separated list of variable names. Allows restricting the list of requested variables to the variable names in the list. It is best practice to restrict the list of variables to the variables actually required by the form in order to minimize fetching of data. If the query parameter is ommitted all variables are fetched. If the query parameter contains non-existent variable names, the variable names are ignored. (optional)
      deserializeValues - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default true). If set to true, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](http://jackson.codehaus.org/) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. **Note**: While true is the default value for reasons of backward compatibility, we recommend setting this parameter to false when developing web applications that are independent of the Java process applications deployed to the engine. (optional, default to true)
      Returns:
      Map<String, VariableValueDto>
      Throws:
      ApiException - if fails to make API call

    • getStartFormVariablesByKey

      public Map<String,VariableValueDto> getStartFormVariablesByKey(String key, String variableNames, Boolean deserializeValues, Map<String,String> additionalHeaders) throws ApiException
      Get Start Form Variables Retrieves the start form variables for the latest process definition which belongs to no tenant (only if they are defined via the [Generated Task Form](https://docs.camunda.org/manual/7.21/user-guide/task-forms/#generated-task-forms) approach). The start form variables take form data specified on the start event into account. If form fields are defined, the variable types and default values of the form fields are taken into account.
      Parameters:
      key - The key of the process definition (the latest version thereof) to be retrieved. (required)
      variableNames - A comma-separated list of variable names. Allows restricting the list of requested variables to the variable names in the list. It is best practice to restrict the list of variables to the variables actually required by the form in order to minimize fetching of data. If the query parameter is ommitted all variables are fetched. If the query parameter contains non-existent variable names, the variable names are ignored. (optional)
      deserializeValues - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default true). If set to true, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](http://jackson.codehaus.org/) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. **Note**: While true is the default value for reasons of backward compatibility, we recommend setting this parameter to false when developing web applications that are independent of the Java process applications deployed to the engine. (optional, default to true)
      additionalHeaders - additionalHeaders for this call
      Returns:
      Map<String, VariableValueDto>
      Throws:
      ApiException - if fails to make API call

    • getStartFormVariablesByKeyAndTenantId

      public Map<String,VariableValueDto> getStartFormVariablesByKeyAndTenantId(String key, String tenantId, String variableNames, Boolean deserializeValues) throws ApiException
      Get Start Form Variables Retrieves the start form variables for the latest process definition for a tenant (only if they are defined via the [Generated Task Form](https://docs.camunda.org/manual/7.21/user-guide/task-forms/#generated-task-forms) approach). The start form variables take form data specified on the start event into account. If form fields are defined, the variable types and default values of the form fields are taken into account.
      Parameters:
      key - The key of the process definition (the latest version thereof) to be retrieved. (required)
      tenantId - The id of the tenant the process definition belongs to. (required)
      variableNames - A comma-separated list of variable names. Allows restricting the list of requested variables to the variable names in the list. It is best practice to restrict the list of variables to the variables actually required by the form in order to minimize fetching of data. If the query parameter is ommitted all variables are fetched. If the query parameter contains non-existent variable names, the variable names are ignored. (optional)
      deserializeValues - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default true). If set to true, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](http://jackson.codehaus.org/) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. **Note**: While true is the default value for reasons of backward compatibility, we recommend setting this parameter to false when developing web applications that are independent of the Java process applications deployed to the engine. (optional, default to true)
      Returns:
      Map<String, VariableValueDto>
      Throws:
      ApiException - if fails to make API call

    • getStartFormVariablesByKeyAndTenantId

      public Map<String,VariableValueDto> getStartFormVariablesByKeyAndTenantId(String key, String tenantId, String variableNames, Boolean deserializeValues, Map<String,String> additionalHeaders) throws ApiException
      Get Start Form Variables Retrieves the start form variables for the latest process definition for a tenant (only if they are defined via the [Generated Task Form](https://docs.camunda.org/manual/7.21/user-guide/task-forms/#generated-task-forms) approach). The start form variables take form data specified on the start event into account. If form fields are defined, the variable types and default values of the form fields are taken into account.
      Parameters:
      key - The key of the process definition (the latest version thereof) to be retrieved. (required)
      tenantId - The id of the tenant the process definition belongs to. (required)
      variableNames - A comma-separated list of variable names. Allows restricting the list of requested variables to the variable names in the list. It is best practice to restrict the list of variables to the variables actually required by the form in order to minimize fetching of data. If the query parameter is ommitted all variables are fetched. If the query parameter contains non-existent variable names, the variable names are ignored. (optional)
      deserializeValues - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default true). If set to true, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](http://jackson.codehaus.org/) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. **Note**: While true is the default value for reasons of backward compatibility, we recommend setting this parameter to false when developing web applications that are independent of the Java process applications deployed to the engine. (optional, default to true)
      additionalHeaders - additionalHeaders for this call
      Returns:
      Map<String, VariableValueDto>
      Throws:
      ApiException - if fails to make API call

    • getStaticCalledProcessDefinitions

      public List<CalledProcessDefinitionDto> getStaticCalledProcessDefinitions(String id) throws ApiException
      Get Static Called Process Definitions For the given process, returns a list of called process definitions corresponding to the `CalledProcessDefinition` interface in the engine. The list contains all process definitions that are referenced statically by call activities in the given process. This endpoint does not resolve process definitions that are referenced with expressions. Each called process definition contains a list of call activity ids, which specifies the call activities that are calling that process. This endpoint does not resolve references to case definitions.
      Parameters:
      id - The id of the process definition. (required)
      Returns:
      List<CalledProcessDefinitionDto>
      Throws:
      ApiException - if fails to make API call

    • getStaticCalledProcessDefinitions

      public List<CalledProcessDefinitionDto> getStaticCalledProcessDefinitions(String id, Map<String,String> additionalHeaders) throws ApiException
      Get Static Called Process Definitions For the given process, returns a list of called process definitions corresponding to the `CalledProcessDefinition` interface in the engine. The list contains all process definitions that are referenced statically by call activities in the given process. This endpoint does not resolve process definitions that are referenced with expressions. Each called process definition contains a list of call activity ids, which specifies the call activities that are calling that process. This endpoint does not resolve references to case definitions.
      Parameters:
      id - The id of the process definition. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<CalledProcessDefinitionDto>
      Throws:
      ApiException - if fails to make API call

    • restartProcessInstance

      public void restartProcessInstance(String id, RestartProcessInstanceDto restartProcessInstanceDto) throws ApiException
      Restart Process Instance Restarts process instances that were canceled or terminated synchronously. Can also restart completed process instances. It will create a new instance using the original instance information. To execute the restart asynchronously, use the [Restart Process Instance Async](https://docs.camunda.org/manual/7.21/reference/rest/process-definition/post-restart-process-instance-async/) method. For more information about the difference between synchronous and asynchronous execution, please refer to the related section of the [User Guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/process-instance-restart/#execution).
      Parameters:
      id - The id of the process definition of the process instances to restart. (required)
      restartProcessInstanceDto - (optional)
      Throws:
      ApiException - if fails to make API call

    • restartProcessInstance

      public void restartProcessInstance(String id, RestartProcessInstanceDto restartProcessInstanceDto, Map<String,String> additionalHeaders) throws ApiException
      Restart Process Instance Restarts process instances that were canceled or terminated synchronously. Can also restart completed process instances. It will create a new instance using the original instance information. To execute the restart asynchronously, use the [Restart Process Instance Async](https://docs.camunda.org/manual/7.21/reference/rest/process-definition/post-restart-process-instance-async/) method. For more information about the difference between synchronous and asynchronous execution, please refer to the related section of the [User Guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/process-instance-restart/#execution).
      Parameters:
      id - The id of the process definition of the process instances to restart. (required)
      restartProcessInstanceDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • restartProcessInstanceAsyncOperation

      public BatchDto restartProcessInstanceAsyncOperation(String id, RestartProcessInstanceDto restartProcessInstanceDto) throws ApiException
      Restart Process Instance Async Restarts process instances that were canceled or terminated asynchronously. Can also restart completed process instances. It will create a new instance using the original instance information. To execute the restart asynchronously, use the [Restart Process Instance](https://docs.camunda.org/manual/7.21/reference/rest/process-definition/post-restart-process-instance-sync/) method. For more information about the difference between synchronous and asynchronous execution, please refer to the related section of the [User Guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/process-instance-restart/#execution).
      Parameters:
      id - The id of the process definition of the process instances to restart. (required)
      restartProcessInstanceDto - (optional)
      Returns:
      BatchDto
      Throws:
      ApiException - if fails to make API call

    • restartProcessInstanceAsyncOperation

      public BatchDto restartProcessInstanceAsyncOperation(String id, RestartProcessInstanceDto restartProcessInstanceDto, Map<String,String> additionalHeaders) throws ApiException
      Restart Process Instance Async Restarts process instances that were canceled or terminated asynchronously. Can also restart completed process instances. It will create a new instance using the original instance information. To execute the restart asynchronously, use the [Restart Process Instance](https://docs.camunda.org/manual/7.21/reference/rest/process-definition/post-restart-process-instance-sync/) method. For more information about the difference between synchronous and asynchronous execution, please refer to the related section of the [User Guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/process-instance-restart/#execution).
      Parameters:
      id - The id of the process definition of the process instances to restart. (required)
      restartProcessInstanceDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      BatchDto
      Throws:
      ApiException - if fails to make API call

    • startProcessInstance

      public ProcessInstanceWithVariablesDto startProcessInstance(String id, StartProcessInstanceDto startProcessInstanceDto) throws ApiException
      Start Instance Instantiates a given process definition. Process variables and business key may be supplied in the request body.
      Parameters:
      id - The id of the process definition to be retrieved. (required)
      startProcessInstanceDto - (optional)
      Returns:
      ProcessInstanceWithVariablesDto
      Throws:
      ApiException - if fails to make API call

    • startProcessInstance

      public ProcessInstanceWithVariablesDto startProcessInstance(String id, StartProcessInstanceDto startProcessInstanceDto, Map<String,String> additionalHeaders) throws ApiException
      Start Instance Instantiates a given process definition. Process variables and business key may be supplied in the request body.
      Parameters:
      id - The id of the process definition to be retrieved. (required)
      startProcessInstanceDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      ProcessInstanceWithVariablesDto
      Throws:
      ApiException - if fails to make API call

    • startProcessInstanceByKey

      public ProcessInstanceWithVariablesDto startProcessInstanceByKey(String key, StartProcessInstanceDto startProcessInstanceDto) throws ApiException
      Start Instance Instantiates a given process definition, starts the latest version of the process definition which belongs to no tenant. Process variables and business key may be supplied in the request body.
      Parameters:
      key - The key of the process definition (the latest version thereof) to be retrieved. (required)
      startProcessInstanceDto - (optional)
      Returns:
      ProcessInstanceWithVariablesDto
      Throws:
      ApiException - if fails to make API call

    • startProcessInstanceByKey

      public ProcessInstanceWithVariablesDto startProcessInstanceByKey(String key, StartProcessInstanceDto startProcessInstanceDto, Map<String,String> additionalHeaders) throws ApiException
      Start Instance Instantiates a given process definition, starts the latest version of the process definition which belongs to no tenant. Process variables and business key may be supplied in the request body.
      Parameters:
      key - The key of the process definition (the latest version thereof) to be retrieved. (required)
      startProcessInstanceDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      ProcessInstanceWithVariablesDto
      Throws:
      ApiException - if fails to make API call

    • startProcessInstanceByKeyAndTenantId

      public ProcessInstanceWithVariablesDto startProcessInstanceByKeyAndTenantId(String key, String tenantId, StartProcessInstanceDto startProcessInstanceDto) throws ApiException
      Start Instance Instantiates a given process definition, starts the latest version of the process definition for tenant. Process variables and business key may be supplied in the request body.
      Parameters:
      key - The key of the process definition (the latest version thereof) to be retrieved. (required)
      tenantId - The id of the tenant the process definition belongs to. (required)
      startProcessInstanceDto - (optional)
      Returns:
      ProcessInstanceWithVariablesDto
      Throws:
      ApiException - if fails to make API call

    • startProcessInstanceByKeyAndTenantId

      public ProcessInstanceWithVariablesDto startProcessInstanceByKeyAndTenantId(String key, String tenantId, StartProcessInstanceDto startProcessInstanceDto, Map<String,String> additionalHeaders) throws ApiException
      Start Instance Instantiates a given process definition, starts the latest version of the process definition for tenant. Process variables and business key may be supplied in the request body.
      Parameters:
      key - The key of the process definition (the latest version thereof) to be retrieved. (required)
      tenantId - The id of the tenant the process definition belongs to. (required)
      startProcessInstanceDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      ProcessInstanceWithVariablesDto
      Throws:
      ApiException - if fails to make API call

    • submitForm

      public ProcessInstanceDto submitForm(String id, StartProcessInstanceFormDto startProcessInstanceFormDto) throws ApiException
      Submit Start Form Starts a process instance using a set of process variables and the business key. If the start event has Form Field Metadata defined, the process engine will perform backend validation for any form fields which have validators defined. See [Documentation on Generated Task Forms](https://docs.camunda.org/manual/7.21/user-guide/task-forms/#generated-task-forms).
      Parameters:
      id - The id of the process definition to submit the form for. (required)
      startProcessInstanceFormDto - (optional)
      Returns:
      ProcessInstanceDto
      Throws:
      ApiException - if fails to make API call

    • submitForm

      public ProcessInstanceDto submitForm(String id, StartProcessInstanceFormDto startProcessInstanceFormDto, Map<String,String> additionalHeaders) throws ApiException
      Submit Start Form Starts a process instance using a set of process variables and the business key. If the start event has Form Field Metadata defined, the process engine will perform backend validation for any form fields which have validators defined. See [Documentation on Generated Task Forms](https://docs.camunda.org/manual/7.21/user-guide/task-forms/#generated-task-forms).
      Parameters:
      id - The id of the process definition to submit the form for. (required)
      startProcessInstanceFormDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      ProcessInstanceDto
      Throws:
      ApiException - if fails to make API call

    • submitFormByKey

      public ProcessInstanceDto submitFormByKey(String key, StartProcessInstanceFormDto startProcessInstanceFormDto) throws ApiException
      Submit Start Form Starts the latest version of the process definition which belongs to no tenant using a set of process variables and the business key. If the start event has Form Field Metadata defined, the process engine will perform backend validation for any form fields which have validators defined. See [Documentation on Generated Task Forms](https://docs.camunda.org/manual/7.21/user-guide/task-forms/#generated-task-forms).
      Parameters:
      key - The key of the process definition to submit the form for. (required)
      startProcessInstanceFormDto - (optional)
      Returns:
      ProcessInstanceDto
      Throws:
      ApiException - if fails to make API call

    • submitFormByKey

      public ProcessInstanceDto submitFormByKey(String key, StartProcessInstanceFormDto startProcessInstanceFormDto, Map<String,String> additionalHeaders) throws ApiException
      Submit Start Form Starts the latest version of the process definition which belongs to no tenant using a set of process variables and the business key. If the start event has Form Field Metadata defined, the process engine will perform backend validation for any form fields which have validators defined. See [Documentation on Generated Task Forms](https://docs.camunda.org/manual/7.21/user-guide/task-forms/#generated-task-forms).
      Parameters:
      key - The key of the process definition to submit the form for. (required)
      startProcessInstanceFormDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      ProcessInstanceDto
      Throws:
      ApiException - if fails to make API call

    • submitFormByKeyAndTenantId

      public ProcessInstanceDto submitFormByKeyAndTenantId(String key, String tenantId, StartProcessInstanceFormDto startProcessInstanceFormDto) throws ApiException
      Submit Start Form Starts the latest version of the process definition for a tenant using a set of process variables and the business key. If the start event has Form Field Metadata defined, the process engine will perform backend validation for any form fields which have validators defined. See [Documentation on Generated Task Forms](https://docs.camunda.org/manual/7.21/user-guide/task-forms/#generated-task-forms).
      Parameters:
      key - The key of the process definition to submit the form for. (required)
      tenantId - The id of the tenant the process definition belongs to. (required)
      startProcessInstanceFormDto - (optional)
      Returns:
      ProcessInstanceDto
      Throws:
      ApiException - if fails to make API call

    • submitFormByKeyAndTenantId

      public ProcessInstanceDto submitFormByKeyAndTenantId(String key, String tenantId, StartProcessInstanceFormDto startProcessInstanceFormDto, Map<String,String> additionalHeaders) throws ApiException
      Submit Start Form Starts the latest version of the process definition for a tenant using a set of process variables and the business key. If the start event has Form Field Metadata defined, the process engine will perform backend validation for any form fields which have validators defined. See [Documentation on Generated Task Forms](https://docs.camunda.org/manual/7.21/user-guide/task-forms/#generated-task-forms).
      Parameters:
      key - The key of the process definition to submit the form for. (required)
      tenantId - The id of the tenant the process definition belongs to. (required)
      startProcessInstanceFormDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      ProcessInstanceDto
      Throws:
      ApiException - if fails to make API call

    • updateHistoryTimeToLiveByProcessDefinitionId

      public void updateHistoryTimeToLiveByProcessDefinitionId(String id, HistoryTimeToLiveDto historyTimeToLiveDto) throws ApiException
      Update History Time to Live Updates history time to live for process definition. The field is used within [History cleanup](https://docs.camunda.org/manual/7.21/user-guide/process-engine/history/#history-cleanup). The value of the update is mandatory by default and does not allow `null` values. To enable them, please set the feature flag `enforceHistoryTimeToLive` to `false`. Read more in [Configuration Properties] (https://docs.camunda.org/manual/7.21/reference/deployment-descriptors/tags/process-engine#configuration-properties)
      Parameters:
      id - The id of the process definition to change history time to live. (required)
      historyTimeToLiveDto - (optional)
      Throws:
      ApiException - if fails to make API call

    • updateHistoryTimeToLiveByProcessDefinitionId

      public void updateHistoryTimeToLiveByProcessDefinitionId(String id, HistoryTimeToLiveDto historyTimeToLiveDto, Map<String,String> additionalHeaders) throws ApiException
      Update History Time to Live Updates history time to live for process definition. The field is used within [History cleanup](https://docs.camunda.org/manual/7.21/user-guide/process-engine/history/#history-cleanup). The value of the update is mandatory by default and does not allow `null` values. To enable them, please set the feature flag `enforceHistoryTimeToLive` to `false`. Read more in [Configuration Properties] (https://docs.camunda.org/manual/7.21/reference/deployment-descriptors/tags/process-engine#configuration-properties)
      Parameters:
      id - The id of the process definition to change history time to live. (required)
      historyTimeToLiveDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • updateHistoryTimeToLiveByProcessDefinitionKey

      public void updateHistoryTimeToLiveByProcessDefinitionKey(String key, HistoryTimeToLiveDto historyTimeToLiveDto) throws ApiException
      Update History Time to Live Updates history time to live for the latest version of the process definition which belongs to no tenant. The field is used within [History cleanup](https://docs.camunda.org/manual/7.21/user-guide/process-engine/history/#history-cleanup). The value of the update is mandatory by default and does not allow `null` values. To enable them, please set the feature flag `enforceHistoryTimeToLive` to `false`. Read more in [Configuration Properties] (https://docs.camunda.org/manual/7.21/reference/deployment-descriptors/tags/process-engine#configuration-properties)
      Parameters:
      key - The key of the process definition to change history time to live. (required)
      historyTimeToLiveDto - (optional)
      Throws:
      ApiException - if fails to make API call

    • updateHistoryTimeToLiveByProcessDefinitionKey

      public void updateHistoryTimeToLiveByProcessDefinitionKey(String key, HistoryTimeToLiveDto historyTimeToLiveDto, Map<String,String> additionalHeaders) throws ApiException
      Update History Time to Live Updates history time to live for the latest version of the process definition which belongs to no tenant. The field is used within [History cleanup](https://docs.camunda.org/manual/7.21/user-guide/process-engine/history/#history-cleanup). The value of the update is mandatory by default and does not allow `null` values. To enable them, please set the feature flag `enforceHistoryTimeToLive` to `false`. Read more in [Configuration Properties] (https://docs.camunda.org/manual/7.21/reference/deployment-descriptors/tags/process-engine#configuration-properties)
      Parameters:
      key - The key of the process definition to change history time to live. (required)
      historyTimeToLiveDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • updateHistoryTimeToLiveByProcessDefinitionKeyAndTenantId

      public void updateHistoryTimeToLiveByProcessDefinitionKeyAndTenantId(String key, String tenantId, HistoryTimeToLiveDto historyTimeToLiveDto) throws ApiException
      Update History Time to Live Updates history time to live for the latest version of the process definition for a tenant. The field is used within [History cleanup](https://docs.camunda.org/manual/7.21/user-guide/process-engine/history/#history-cleanup).
      Parameters:
      key - The key of the process definition to change history time to live. (required)
      tenantId - The id of the tenant the process definition belongs to. (required)
      historyTimeToLiveDto - (optional)
      Throws:
      ApiException - if fails to make API call

    • updateHistoryTimeToLiveByProcessDefinitionKeyAndTenantId

      public void updateHistoryTimeToLiveByProcessDefinitionKeyAndTenantId(String key, String tenantId, HistoryTimeToLiveDto historyTimeToLiveDto, Map<String,String> additionalHeaders) throws ApiException
      Update History Time to Live Updates history time to live for the latest version of the process definition for a tenant. The field is used within [History cleanup](https://docs.camunda.org/manual/7.21/user-guide/process-engine/history/#history-cleanup).
      Parameters:
      key - The key of the process definition to change history time to live. (required)
      tenantId - The id of the tenant the process definition belongs to. (required)
      historyTimeToLiveDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • updateProcessDefinitionSuspensionState

      public void updateProcessDefinitionSuspensionState(ProcessDefinitionSuspensionStateDto processDefinitionSuspensionStateDto) throws ApiException
      Activate/Suspend By Key Activates or suspends process definitions with the given process definition key.
      Parameters:
      processDefinitionSuspensionStateDto - **Note**: Unallowed property is `processDefinitionId`. (optional)
      Throws:
      ApiException - if fails to make API call

    • updateProcessDefinitionSuspensionState

      public void updateProcessDefinitionSuspensionState(ProcessDefinitionSuspensionStateDto processDefinitionSuspensionStateDto, Map<String,String> additionalHeaders) throws ApiException
      Activate/Suspend By Key Activates or suspends process definitions with the given process definition key.
      Parameters:
      processDefinitionSuspensionStateDto - **Note**: Unallowed property is `processDefinitionId`. (optional)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • updateProcessDefinitionSuspensionStateById

      public void updateProcessDefinitionSuspensionStateById(String id, ProcessDefinitionSuspensionStateDto processDefinitionSuspensionStateDto) throws ApiException
      Activate/Suspend By Id Activates or suspends a given process definition by id.
      Parameters:
      id - The id of the process definition to activate or suspend. (required)
      processDefinitionSuspensionStateDto - **Note**: Unallowed properties are `processDefinitionId` and `processDefinitionKey`. (optional)
      Throws:
      ApiException - if fails to make API call

    • updateProcessDefinitionSuspensionStateById

      public void updateProcessDefinitionSuspensionStateById(String id, ProcessDefinitionSuspensionStateDto processDefinitionSuspensionStateDto, Map<String,String> additionalHeaders) throws ApiException
      Activate/Suspend By Id Activates or suspends a given process definition by id.
      Parameters:
      id - The id of the process definition to activate or suspend. (required)
      processDefinitionSuspensionStateDto - **Note**: Unallowed properties are `processDefinitionId` and `processDefinitionKey`. (optional)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • updateProcessDefinitionSuspensionStateByKey

      public void updateProcessDefinitionSuspensionStateByKey(String key, ProcessDefinitionSuspensionStateDto processDefinitionSuspensionStateDto) throws ApiException
      Activate/Suspend by Id Activates or suspends a given process definition by latest version of process definition key which belongs to no tenant.
      Parameters:
      key - The key of the process definition (the latest version thereof) to be activated/suspended. (required)
      processDefinitionSuspensionStateDto - **Note**: Unallowed properties are `processDefinitionId` and `processDefinitionKey`. (optional)
      Throws:
      ApiException - if fails to make API call

    • updateProcessDefinitionSuspensionStateByKey

      public void updateProcessDefinitionSuspensionStateByKey(String key, ProcessDefinitionSuspensionStateDto processDefinitionSuspensionStateDto, Map<String,String> additionalHeaders) throws ApiException
      Activate/Suspend by Id Activates or suspends a given process definition by latest version of process definition key which belongs to no tenant.
      Parameters:
      key - The key of the process definition (the latest version thereof) to be activated/suspended. (required)
      processDefinitionSuspensionStateDto - **Note**: Unallowed properties are `processDefinitionId` and `processDefinitionKey`. (optional)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • updateProcessDefinitionSuspensionStateByKeyAndTenantId

      public void updateProcessDefinitionSuspensionStateByKeyAndTenantId(String key, String tenantId, ProcessDefinitionSuspensionStateDto processDefinitionSuspensionStateDto) throws ApiException
      Activate/Suspend by Id Activates or suspends a given process definition by the latest version of the process definition for tenant.
      Parameters:
      key - The key of the process definition (the latest version thereof) to be activated/suspended. (required)
      tenantId - The id of the tenant the process definition belongs to. (required)
      processDefinitionSuspensionStateDto - **Note**: Unallowed properties are `processDefinitionId` and `processDefinitionKey`. (optional)
      Throws:
      ApiException - if fails to make API call

    • updateProcessDefinitionSuspensionStateByKeyAndTenantId

      public void updateProcessDefinitionSuspensionStateByKeyAndTenantId(String key, String tenantId, ProcessDefinitionSuspensionStateDto processDefinitionSuspensionStateDto, Map<String,String> additionalHeaders) throws ApiException
      Activate/Suspend by Id Activates or suspends a given process definition by the latest version of the process definition for tenant.
      Parameters:
      key - The key of the process definition (the latest version thereof) to be activated/suspended. (required)
      tenantId - The id of the tenant the process definition belongs to. (required)
      processDefinitionSuspensionStateDto - **Note**: Unallowed properties are `processDefinitionId` and `processDefinitionKey`. (optional)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call