[−][src]Trait camunda_client::apis::ProcessDefinitionApi

pub trait ProcessDefinitionApi {
    fn delete_process_definition(
        &self, 
        id: &str, 
        cascade: Option<bool>, 
        skip_custom_listeners: Option<bool>, 
        skip_io_mappings: Option<bool>
    ) -> Result<(), Error>;

    fn delete_process_definitions_by_key(
        &self, 
        key: &str, 
        cascade: Option<bool>, 
        skip_custom_listeners: Option<bool>, 
        skip_io_mappings: Option<bool>
    ) -> Result<(), Error>;

    fn delete_process_definitions_by_key_and_tenant_id(
        &self, 
        key: &str, 
        tenant_id: &str, 
        cascade: Option<bool>, 
        skip_custom_listeners: Option<bool>, 
        skip_io_mappings: Option<bool>
    ) -> Result<(), Error>;

    fn get_activity_statistics(
        &self, 
        id: &str, 
        failed_jobs: Option<bool>, 
        incidents: Option<bool>, 
        incidents_for_type: Option<&str>
    ) -> Result<Vec<ActivityStatisticsResultDto>, Error>;

    fn get_activity_statistics_by_process_definition_key(
        &self, 
        key: &str, 
        failed_jobs: Option<bool>, 
        incidents: Option<bool>, 
        incidents_for_type: Option<&str>
    ) -> Result<Vec<ActivityStatisticsResultDto>, Error>;

    fn get_activity_statistics_by_process_definition_key_and_tenant_id(
        &self, 
        key: &str, 
        tenant_id: &str, 
        failed_jobs: Option<bool>, 
        incidents: Option<bool>, 
        incidents_for_type: Option<&str>
    ) -> Result<Vec<ActivityStatisticsResultDto>, Error>;

    fn get_deployed_start_form(&self, id: &str) -> Result<PathBuf, Error>;

    fn get_deployed_start_form_by_key(
        &self, 
        key: &str
    ) -> Result<PathBuf, Error>;

    fn get_deployed_start_form_by_key_and_tenant_id(
        &self, 
        key: &str, 
        tenant_id: &str
    ) -> Result<PathBuf, Error>;

    fn get_latest_process_definition_by_tenant_id(
        &self, 
        key: &str, 
        tenant_id: &str
    ) -> Result<ProcessDefinitionDto, Error>;

    fn get_process_definition(
        &self, 
        id: &str
    ) -> Result<ProcessDefinitionDto, Error>;

    fn get_process_definition_bpmn20_xml(
        &self, 
        id: &str
    ) -> Result<ProcessDefinitionDiagramDto, Error>;

    fn get_process_definition_bpmn20_xml_by_key(
        &self, 
        key: &str
    ) -> Result<ProcessDefinitionDiagramDto, Error>;

    fn get_process_definition_bpmn20_xml_by_key_and_tenant_id(
        &self, 
        key: &str, 
        tenant_id: &str
    ) -> Result<ProcessDefinitionDiagramDto, Error>;

    fn get_process_definition_by_key(
        &self, 
        key: &str
    ) -> Result<ProcessDefinitionDto, Error>;

    fn get_process_definition_diagram(&self, id: &str) -> Result<PathBuf, Error>;

    fn get_process_definition_diagram_by_key(
        &self, 
        key: &str
    ) -> Result<PathBuf, Error>;

    fn get_process_definition_diagram_by_key_and_tenant_id(
        &self, 
        key: &str, 
        tenant_id: &str
    ) -> Result<PathBuf, Error>;

    fn get_process_definition_statistics(
        &self, 
        failed_jobs: Option<bool>, 
        incidents: Option<bool>, 
        incidents_for_type: Option<&str>, 
        root_incidents: Option<bool>
    ) -> Result<Vec<ProcessDefinitionStatisticsResultDto>, Error>;

    fn get_process_definitions(
        &self, 
        process_definition_id: Option<&str>, 
        process_definition_id_in: Option<&str>, 
        name: Option<&str>, 
        name_like: Option<&str>, 
        deployment_id: Option<&str>, 
        deployed_after: Option<String>, 
        deployed_at: Option<String>, 
        key: Option<&str>, 
        keys_in: Option<&str>, 
        key_like: Option<&str>, 
        category: Option<&str>, 
        category_like: Option<&str>, 
        version: Option<i32>, 
        latest_version: Option<bool>, 
        resource_name: Option<&str>, 
        resource_name_like: Option<&str>, 
        startable_by: Option<&str>, 
        active: Option<bool>, 
        suspended: Option<bool>, 
        incident_id: Option<&str>, 
        incident_type: Option<&str>, 
        incident_message: Option<&str>, 
        incident_message_like: Option<&str>, 
        tenant_id_in: Option<&str>, 
        without_tenant_id: Option<bool>, 
        include_process_definitions_without_tenant_id: Option<bool>, 
        version_tag: Option<&str>, 
        version_tag_like: Option<&str>, 
        without_version_tag: Option<bool>, 
        startable_in_tasklist: Option<bool>, 
        not_startable_in_tasklist: Option<bool>, 
        startable_permission_check: Option<bool>, 
        sort_by: Option<&str>, 
        sort_order: Option<&str>, 
        first_result: Option<i32>, 
        max_results: Option<i32>
    ) -> Result<Vec<ProcessDefinitionDto>, Error>;

    fn get_process_definitions_count(
        &self, 
        process_definition_id: Option<&str>, 
        process_definition_id_in: Option<&str>, 
        name: Option<&str>, 
        name_like: Option<&str>, 
        deployment_id: Option<&str>, 
        deployed_after: Option<String>, 
        deployed_at: Option<String>, 
        key: Option<&str>, 
        keys_in: Option<&str>, 
        key_like: Option<&str>, 
        category: Option<&str>, 
        category_like: Option<&str>, 
        version: Option<i32>, 
        latest_version: Option<bool>, 
        resource_name: Option<&str>, 
        resource_name_like: Option<&str>, 
        startable_by: Option<&str>, 
        active: Option<bool>, 
        suspended: Option<bool>, 
        incident_id: Option<&str>, 
        incident_type: Option<&str>, 
        incident_message: Option<&str>, 
        incident_message_like: Option<&str>, 
        tenant_id_in: Option<&str>, 
        without_tenant_id: Option<bool>, 
        include_process_definitions_without_tenant_id: Option<bool>, 
        version_tag: Option<&str>, 
        version_tag_like: Option<&str>, 
        without_version_tag: Option<bool>, 
        startable_in_tasklist: Option<bool>, 
        not_startable_in_tasklist: Option<bool>, 
        startable_permission_check: Option<bool>
    ) -> Result<CountResultDto, Error>;

    fn get_rendered_start_form(&self, id: &str) -> Result<PathBuf, Error>;

    fn get_rendered_start_form_by_key(
        &self, 
        key: &str
    ) -> Result<PathBuf, Error>;

    fn get_rendered_start_form_by_key_and_tenant_id(
        &self, 
        key: &str, 
        tenant_id: &str
    ) -> Result<PathBuf, Error>;

    fn get_start_form(&self, id: &str) -> Result<FormDto, Error>;

    fn get_start_form_by_key(&self, key: &str) -> Result<FormDto, Error>;

    fn get_start_form_by_key_and_tenant_id(
        &self, 
        key: &str, 
        tenant_id: &str
    ) -> Result<FormDto, Error>;

    fn get_start_form_variables(
        &self, 
        id: &str, 
        variable_names: Option<&str>, 
        deserialize_values: Option<bool>
    ) -> Result<HashMap<String, VariableValueDto>, Error>;

    fn get_start_form_variables_by_key(
        &self, 
        key: &str, 
        variable_names: Option<&str>, 
        deserialize_values: Option<bool>
    ) -> Result<HashMap<String, VariableValueDto>, Error>;

    fn get_start_form_variables_by_key_and_tenant_id(
        &self, 
        key: &str, 
        tenant_id: &str, 
        variable_names: Option<&str>, 
        deserialize_values: Option<bool>
    ) -> Result<HashMap<String, VariableValueDto>, Error>;

    fn restart_process_instance(
        &self, 
        id: &str, 
        restart_process_instance_dto: Option<RestartProcessInstanceDto>
    ) -> Result<(), Error>;

    fn restart_process_instance_async_operation(
        &self, 
        id: &str, 
        restart_process_instance_dto: Option<RestartProcessInstanceDto>
    ) -> Result<BatchDto, Error>;

    fn start_process_instance(
        &self, 
        id: &str, 
        start_process_instance_dto: Option<StartProcessInstanceDto>
    ) -> Result<ProcessInstanceWithVariablesDto, Error>;

    fn start_process_instance_by_key(
        &self, 
        key: &str, 
        start_process_instance_dto: Option<StartProcessInstanceDto>
    ) -> Result<ProcessInstanceWithVariablesDto, Error>;

    fn start_process_instance_by_key_and_tenant_id(
        &self, 
        key: &str, 
        tenant_id: &str, 
        start_process_instance_dto: Option<StartProcessInstanceDto>
    ) -> Result<ProcessInstanceWithVariablesDto, Error>;

    fn submit_form(
        &self, 
        id: &str, 
        start_process_instance_form_dto: Option<StartProcessInstanceFormDto>
    ) -> Result<ProcessInstanceDto, Error>;

    fn submit_form_by_key(
        &self, 
        key: &str, 
        start_process_instance_form_dto: Option<StartProcessInstanceFormDto>
    ) -> Result<ProcessInstanceDto, Error>;

    fn submit_form_by_key_and_tenant_id(
        &self, 
        key: &str, 
        tenant_id: &str, 
        start_process_instance_form_dto: Option<StartProcessInstanceFormDto>
    ) -> Result<ProcessInstanceDto, Error>;

    fn update_history_time_to_live_by_process_definition_id(
        &self, 
        id: &str, 
        history_time_to_live_dto: Option<HistoryTimeToLiveDto>
    ) -> Result<(), Error>;

    fn update_history_time_to_live_by_process_definition_key(
        &self, 
        key: &str, 
        history_time_to_live_dto: Option<HistoryTimeToLiveDto>
    ) -> Result<(), Error>;

    fn update_history_time_to_live_by_process_definition_key_and_tenant_id(
        &self, 
        key: &str, 
        tenant_id: &str, 
        history_time_to_live_dto: Option<HistoryTimeToLiveDto>
    ) -> Result<(), Error>;

    fn update_process_definition_suspension_state(
        &self, 
        process_definition_suspension_state_dto: Option<ProcessDefinitionSuspensionStateDto>
    ) -> Result<(), Error>;

    fn update_process_definition_suspension_state_by_id(
        &self, 
        id: &str, 
        process_definition_suspension_state_dto: Option<ProcessDefinitionSuspensionStateDto>
    ) -> Result<(), Error>;

    fn update_process_definition_suspension_state_by_key(
        &self, 
        key: &str, 
        process_definition_suspension_state_dto: Option<ProcessDefinitionSuspensionStateDto>
    ) -> Result<(), Error>;

    fn update_process_definition_suspension_state_by_key_and_tenant_id(
        &self, 
        key: &str, 
        tenant_id: &str, 
        process_definition_suspension_state_dto: Option<ProcessDefinitionSuspensionStateDto>
    ) -> Result<(), Error>;
}

Required methods

fn delete_process_definition(
    &self,
    id: &str,
    cascade: Option<bool>,
    skip_custom_listeners: Option<bool>,
    skip_io_mappings: Option<bool>
) -> Result<(), Error>

fn delete_process_definitions_by_key(
    &self,
    key: &str,
    cascade: Option<bool>,
    skip_custom_listeners: Option<bool>,
    skip_io_mappings: Option<bool>
) -> Result<(), Error>

fn delete_process_definitions_by_key_and_tenant_id(
    &self,
    key: &str,
    tenant_id: &str,
    cascade: Option<bool>,
    skip_custom_listeners: Option<bool>,
    skip_io_mappings: Option<bool>
) -> Result<(), Error>

fn get_activity_statistics(
    &self,
    id: &str,
    failed_jobs: Option<bool>,
    incidents: Option<bool>,
    incidents_for_type: Option<&str>
) -> Result<Vec<ActivityStatisticsResultDto>, Error>

fn get_activity_statistics_by_process_definition_key(
    &self,
    key: &str,
    failed_jobs: Option<bool>,
    incidents: Option<bool>,
    incidents_for_type: Option<&str>
) -> Result<Vec<ActivityStatisticsResultDto>, Error>

fn get_activity_statistics_by_process_definition_key_and_tenant_id(
    &self,
    key: &str,
    tenant_id: &str,
    failed_jobs: Option<bool>,
    incidents: Option<bool>,
    incidents_for_type: Option<&str>
) -> Result<Vec<ActivityStatisticsResultDto>, Error>

fn get_deployed_start_form(&self, id: &str) -> Result<PathBuf, Error>

fn get_deployed_start_form_by_key(&self, key: &str) -> Result<PathBuf, Error>

fn get_deployed_start_form_by_key_and_tenant_id(
    &self,
    key: &str,
    tenant_id: &str
) -> Result<PathBuf, Error>

fn get_latest_process_definition_by_tenant_id(
    &self,
    key: &str,
    tenant_id: &str
) -> Result<ProcessDefinitionDto, Error>

fn get_process_definition(
    &self,
    id: &str
) -> Result<ProcessDefinitionDto, Error>

fn get_process_definition_bpmn20_xml(
    &self,
    id: &str
) -> Result<ProcessDefinitionDiagramDto, Error>

fn get_process_definition_bpmn20_xml_by_key(
    &self,
    key: &str
) -> Result<ProcessDefinitionDiagramDto, Error>

fn get_process_definition_bpmn20_xml_by_key_and_tenant_id(
    &self,
    key: &str,
    tenant_id: &str
) -> Result<ProcessDefinitionDiagramDto, Error>

fn get_process_definition_by_key(
    &self,
    key: &str
) -> Result<ProcessDefinitionDto, Error>

fn get_process_definition_diagram(&self, id: &str) -> Result<PathBuf, Error>

fn get_process_definition_diagram_by_key(
    &self,
    key: &str
) -> Result<PathBuf, Error>

fn get_process_definition_diagram_by_key_and_tenant_id(
    &self,
    key: &str,
    tenant_id: &str
) -> Result<PathBuf, Error>

fn get_process_definition_statistics(
    &self,
    failed_jobs: Option<bool>,
    incidents: Option<bool>,
    incidents_for_type: Option<&str>,
    root_incidents: Option<bool>
) -> Result<Vec<ProcessDefinitionStatisticsResultDto>, Error>

fn get_process_definitions(
    &self,
    process_definition_id: Option<&str>,
    process_definition_id_in: Option<&str>,
    name: Option<&str>,
    name_like: Option<&str>,
    deployment_id: Option<&str>,
    deployed_after: Option<String>,
    deployed_at: Option<String>,
    key: Option<&str>,
    keys_in: Option<&str>,
    key_like: Option<&str>,
    category: Option<&str>,
    category_like: Option<&str>,
    version: Option<i32>,
    latest_version: Option<bool>,
    resource_name: Option<&str>,
    resource_name_like: Option<&str>,
    startable_by: Option<&str>,
    active: Option<bool>,
    suspended: Option<bool>,
    incident_id: Option<&str>,
    incident_type: Option<&str>,
    incident_message: Option<&str>,
    incident_message_like: Option<&str>,
    tenant_id_in: Option<&str>,
    without_tenant_id: Option<bool>,
    include_process_definitions_without_tenant_id: Option<bool>,
    version_tag: Option<&str>,
    version_tag_like: Option<&str>,
    without_version_tag: Option<bool>,
    startable_in_tasklist: Option<bool>,
    not_startable_in_tasklist: Option<bool>,
    startable_permission_check: Option<bool>,
    sort_by: Option<&str>,
    sort_order: Option<&str>,
    first_result: Option<i32>,
    max_results: Option<i32>
) -> Result<Vec<ProcessDefinitionDto>, Error>

fn get_process_definitions_count(
    &self,
    process_definition_id: Option<&str>,
    process_definition_id_in: Option<&str>,
    name: Option<&str>,
    name_like: Option<&str>,
    deployment_id: Option<&str>,
    deployed_after: Option<String>,
    deployed_at: Option<String>,
    key: Option<&str>,
    keys_in: Option<&str>,
    key_like: Option<&str>,
    category: Option<&str>,
    category_like: Option<&str>,
    version: Option<i32>,
    latest_version: Option<bool>,
    resource_name: Option<&str>,
    resource_name_like: Option<&str>,
    startable_by: Option<&str>,
    active: Option<bool>,
    suspended: Option<bool>,
    incident_id: Option<&str>,
    incident_type: Option<&str>,
    incident_message: Option<&str>,
    incident_message_like: Option<&str>,
    tenant_id_in: Option<&str>,
    without_tenant_id: Option<bool>,
    include_process_definitions_without_tenant_id: Option<bool>,
    version_tag: Option<&str>,
    version_tag_like: Option<&str>,
    without_version_tag: Option<bool>,
    startable_in_tasklist: Option<bool>,
    not_startable_in_tasklist: Option<bool>,
    startable_permission_check: Option<bool>
) -> Result<CountResultDto, Error>

fn get_rendered_start_form(&self, id: &str) -> Result<PathBuf, Error>

fn get_rendered_start_form_by_key(&self, key: &str) -> Result<PathBuf, Error>

fn get_rendered_start_form_by_key_and_tenant_id(
    &self,
    key: &str,
    tenant_id: &str
) -> Result<PathBuf, Error>

fn get_start_form(&self, id: &str) -> Result<FormDto, Error>

fn get_start_form_by_key(&self, key: &str) -> Result<FormDto, Error>

fn get_start_form_by_key_and_tenant_id(
    &self,
    key: &str,
    tenant_id: &str
) -> Result<FormDto, Error>

fn get_start_form_variables(
    &self,
    id: &str,
    variable_names: Option<&str>,
    deserialize_values: Option<bool>
) -> Result<HashMap<String, VariableValueDto>, Error>

fn get_start_form_variables_by_key(
    &self,
    key: &str,
    variable_names: Option<&str>,
    deserialize_values: Option<bool>
) -> Result<HashMap<String, VariableValueDto>, Error>

fn get_start_form_variables_by_key_and_tenant_id(
    &self,
    key: &str,
    tenant_id: &str,
    variable_names: Option<&str>,
    deserialize_values: Option<bool>
) -> Result<HashMap<String, VariableValueDto>, Error>

fn restart_process_instance(
    &self,
    id: &str,
    restart_process_instance_dto: Option<RestartProcessInstanceDto>
) -> Result<(), Error>

fn restart_process_instance_async_operation(
    &self,
    id: &str,
    restart_process_instance_dto: Option<RestartProcessInstanceDto>
) -> Result<BatchDto, Error>

fn start_process_instance(
    &self,
    id: &str,
    start_process_instance_dto: Option<StartProcessInstanceDto>
) -> Result<ProcessInstanceWithVariablesDto, Error>

fn start_process_instance_by_key(
    &self,
    key: &str,
    start_process_instance_dto: Option<StartProcessInstanceDto>
) -> Result<ProcessInstanceWithVariablesDto, Error>

fn start_process_instance_by_key_and_tenant_id(
    &self,
    key: &str,
    tenant_id: &str,
    start_process_instance_dto: Option<StartProcessInstanceDto>
) -> Result<ProcessInstanceWithVariablesDto, Error>

fn submit_form(
    &self,
    id: &str,
    start_process_instance_form_dto: Option<StartProcessInstanceFormDto>
) -> Result<ProcessInstanceDto, Error>

fn submit_form_by_key(
    &self,
    key: &str,
    start_process_instance_form_dto: Option<StartProcessInstanceFormDto>
) -> Result<ProcessInstanceDto, Error>

fn submit_form_by_key_and_tenant_id(
    &self,
    key: &str,
    tenant_id: &str,
    start_process_instance_form_dto: Option<StartProcessInstanceFormDto>
) -> Result<ProcessInstanceDto, Error>

fn update_history_time_to_live_by_process_definition_id(
    &self,
    id: &str,
    history_time_to_live_dto: Option<HistoryTimeToLiveDto>
) -> Result<(), Error>

fn update_history_time_to_live_by_process_definition_key(
    &self,
    key: &str,
    history_time_to_live_dto: Option<HistoryTimeToLiveDto>
) -> Result<(), Error>

fn update_history_time_to_live_by_process_definition_key_and_tenant_id(
    &self,
    key: &str,
    tenant_id: &str,
    history_time_to_live_dto: Option<HistoryTimeToLiveDto>
) -> Result<(), Error>

fn update_process_definition_suspension_state(
    &self,
    process_definition_suspension_state_dto: Option<ProcessDefinitionSuspensionStateDto>
) -> Result<(), Error>

fn update_process_definition_suspension_state_by_id(
    &self,
    id: &str,
    process_definition_suspension_state_dto: Option<ProcessDefinitionSuspensionStateDto>
) -> Result<(), Error>

fn update_process_definition_suspension_state_by_key(
    &self,
    key: &str,
    process_definition_suspension_state_dto: Option<ProcessDefinitionSuspensionStateDto>
) -> Result<(), Error>

fn update_process_definition_suspension_state_by_key_and_tenant_id(
    &self,
    key: &str,
    tenant_id: &str,
    process_definition_suspension_state_dto: Option<ProcessDefinitionSuspensionStateDto>
) -> Result<(), Error>

Loading content...

Implementors

impl ProcessDefinitionApi for ProcessDefinitionApiClient[src]

Loading content...