camunda_client/models/
start_process_instance_dto.rs

1/*
2 * Camunda BPM REST API
3 *
4 * OpenApi Spec for Camunda BPM REST API.
5 *
6 * The version of the OpenAPI document: 7.13.0
7 * 
8 * Generated by: https://openapi-generator.tech
9 */
10
11
12
13
14#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
15pub struct StartProcessInstanceDto {
16    /// The business key of the process instance.
17    #[serde(rename = "businessKey", skip_serializing_if = "Option::is_none")]
18    pub business_key: Option<String>,
19    #[serde(rename = "variables", skip_serializing_if = "Option::is_none")]
20    pub variables: Option<::std::collections::HashMap<String, crate::models::VariableValueDto>>,
21    /// The case instance id the process instance is to be initialized with.
22    #[serde(rename = "caseInstanceId", skip_serializing_if = "Option::is_none")]
23    pub case_instance_id: Option<String>,
24    /// **Optional**. A JSON array of instructions that specify which activities to start the process instance at. If this property is omitted, the process instance starts at its default blank start event.
25    #[serde(rename = "startInstructions", skip_serializing_if = "Option::is_none")]
26    pub start_instructions: Option<Vec<crate::models::ProcessInstanceModificationInstructionDto>>,
27    /// Skip execution listener invocation for activities that are started or ended as part of this request. **Note**: This option is currently only respected when start instructions are submitted via the `startInstructions` property.
28    #[serde(rename = "skipCustomListeners", skip_serializing_if = "Option::is_none")]
29    pub skip_custom_listeners: Option<bool>,
30    /// Skip execution of [input/output variable mappings](https://docs.camunda.org/manual/7.13/user-guide/process-engine/variables/#input-output-variable-mapping) for activities that are started or ended as part of this request. **Note**: This option is currently only respected when start instructions are submitted via the `startInstructions` property.
31    #[serde(rename = "skipIoMappings", skip_serializing_if = "Option::is_none")]
32    pub skip_io_mappings: Option<bool>,
33    /// Indicates if the variables, which was used by the process instance during execution, should be returned. Default value: `false`
34    #[serde(rename = "withVariablesInReturn", skip_serializing_if = "Option::is_none")]
35    pub with_variables_in_return: Option<bool>,
36}
37
38impl StartProcessInstanceDto {
39    pub fn new() -> StartProcessInstanceDto {
40        StartProcessInstanceDto {
41            business_key: None,
42            variables: None,
43            case_instance_id: None,
44            start_instructions: None,
45            skip_custom_listeners: None,
46            skip_io_mappings: None,
47            with_variables_in_return: None,
48        }
49    }
50}
51
52