hi_jira2/apis/workflows_api.rs
1/*
2 * The Jira Cloud platform REST API
3 *
4 * Jira Cloud platform REST API documentation
5 *
6 * The version of the OpenAPI document: 1001.0.0-SNAPSHOT
7 * Contact: ecosystem@atlassian.com
8 * Generated by: https://openapi-generator.tech
9 */
10
11
12use reqwest;
13
14use crate::apis::ResponseContent;
15use super::{Error, configuration};
16
17/// struct for passing parameters to the method [`create_workflow`]
18#[derive(Clone, Debug, Default)]
19pub struct CreateWorkflowParams {
20 /// The workflow details.
21 pub create_workflow_details: crate::models::CreateWorkflowDetails
22}
23
24/// struct for passing parameters to the method [`delete_inactive_workflow`]
25#[derive(Clone, Debug, Default)]
26pub struct DeleteInactiveWorkflowParams {
27 /// The entity ID of the workflow.
28 pub entity_id: String
29}
30
31/// struct for passing parameters to the method [`get_all_workflows`]
32#[derive(Clone, Debug, Default)]
33pub struct GetAllWorkflowsParams {
34 /// The name of the workflow to be returned. Only one workflow can be specified.
35 pub workflow_name: Option<String>
36}
37
38/// struct for passing parameters to the method [`get_workflows_paginated`]
39#[derive(Clone, Debug, Default)]
40pub struct GetWorkflowsPaginatedParams {
41 /// The index of the first item to return in a page of results (page offset).
42 pub start_at: Option<i64>,
43 /// The maximum number of items to return per page.
44 pub max_results: Option<i32>,
45 /// The name of a workflow to return. To include multiple workflows, provide an ampersand-separated list. For example, `workflowName=name1&workflowName=name2`.
46 pub workflow_name: Option<Vec<String>>,
47 /// Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * `transitions` For each workflow, returns information about the transitions inside the workflow. * `transitions.rules` For each workflow transition, returns information about its rules. Transitions are included automatically if this expand is requested. * `transitions.properties` For each workflow transition, returns information about its properties. Transitions are included automatically if this expand is requested. * `statuses` For each workflow, returns information about the statuses inside the workflow. * `statuses.properties` For each workflow status, returns information about its properties. Statuses are included automatically if this expand is requested. * `default` For each workflow, returns information about whether this is the default workflow. * `schemes` For each workflow, returns information about the workflow schemes the workflow is assigned to. * `projects` For each workflow, returns information about the projects the workflow is assigned to, through workflow schemes. * `hasDraftWorkflow` For each workflow, returns information about whether the workflow has a draft version. * `operations` For each workflow, returns information about the actions that can be undertaken on the workflow.
48 pub expand: Option<String>,
49 /// String used to perform a case-insensitive partial match with workflow name.
50 pub query_string: Option<String>,
51 /// [Order](#ordering) the results by a field: * `name` Sorts by workflow name. * `created` Sorts by create time. * `updated` Sorts by update time.
52 pub order_by: Option<String>,
53 /// Filters active and inactive workflows.
54 pub is_active: Option<bool>
55}
56
57
58/// struct for typed errors of method [`create_workflow`]
59#[derive(Debug, Clone, Serialize, Deserialize)]
60#[serde(untagged)]
61pub enum CreateWorkflowError {
62 Status400(),
63 Status401(),
64 Status403(),
65 Status404(),
66 UnknownValue(serde_json::Value),
67}
68
69/// struct for typed errors of method [`delete_inactive_workflow`]
70#[derive(Debug, Clone, Serialize, Deserialize)]
71#[serde(untagged)]
72pub enum DeleteInactiveWorkflowError {
73 Status400(),
74 Status401(),
75 Status403(),
76 Status404(),
77 UnknownValue(serde_json::Value),
78}
79
80/// struct for typed errors of method [`get_all_workflows`]
81#[derive(Debug, Clone, Serialize, Deserialize)]
82#[serde(untagged)]
83pub enum GetAllWorkflowsError {
84 Status401(),
85 UnknownValue(serde_json::Value),
86}
87
88/// struct for typed errors of method [`get_workflows_paginated`]
89#[derive(Debug, Clone, Serialize, Deserialize)]
90#[serde(untagged)]
91pub enum GetWorkflowsPaginatedError {
92 Status401(),
93 Status403(crate::models::ErrorCollection),
94 UnknownValue(serde_json::Value),
95}
96
97
98/// Creates a workflow. You can define transition rules using the shapes detailed in the following sections. If no transitional rules are specified the default system transition rules are used. #### Conditions #### Conditions enable workflow rules that govern whether a transition can execute. ##### Always false condition ##### A condition that always fails. { \"type\": \"AlwaysFalseCondition\" } ##### Block transition until approval ##### A condition that blocks issue transition if there is a pending approval. { \"type\": \"BlockInProgressApprovalCondition\" } ##### Compare number custom field condition ##### A condition that allows transition if a comparison between a number custom field and a value is true. { \"type\": \"CompareNumberCFCondition\", \"configuration\": { \"comparator\": \"=\", \"fieldId\": \"customfield_10029\", \"fieldValue\": 2 } } * `comparator` One of the supported comparator: `=`, `>`, and `<`. * `fieldId` The custom numeric field ID. Allowed field types: * `com.atlassian.jira.plugin.system.customfieldtypes:float` * `com.pyxis.greenhopper.jira:jsw-story-points` * `fieldValue` The value for comparison. ##### Hide from user condition ##### A condition that hides a transition from users. The transition can only be triggered from a workflow function or REST API operation. { \"type\": \"RemoteOnlyCondition\" } ##### Only assignee condition ##### A condition that allows only the assignee to execute a transition. { \"type\": \"AllowOnlyAssignee\" } ##### Only Bamboo notifications workflow condition ##### A condition that makes the transition available only to Bamboo build notifications. { \"type\": \"OnlyBambooNotificationsCondition\" } ##### Only reporter condition ##### A condition that allows only the reporter to execute a transition. { \"type\": \"AllowOnlyReporter\" } ##### Permission condition ##### A condition that allows only users with a permission to execute a transition. { \"type\": \"PermissionCondition\", \"configuration\": { \"permissionKey\": \"BROWSE_PROJECTS\" } } * `permissionKey` The permission required to perform the transition. Allowed values: [built-in](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permission-schemes/#built-in-permissions) or app defined permissions. ##### Previous status condition ##### A condition that allows a transition based on whether an issue has or has not transitioned through a status. { \"type\": \"PreviousStatusCondition\", \"configuration\": { \"ignoreLoopTransitions\": true, \"includeCurrentStatus\": true, \"mostRecentStatusOnly\": true, \"reverseCondition\": true, \"previousStatus\": { \"id\": \"5\" } } } By default this condition allows the transition if the status, as defined by its ID in the `previousStatus` object, matches any previous issue status, unless: * `ignoreLoopTransitions` is `true`, then loop transitions (from and to the same status) are ignored. * `includeCurrentStatus` is `true`, then the current issue status is also checked. * `mostRecentStatusOnly` is `true`, then only the issue's preceding status (the one immediately before the current status) is checked. * `reverseCondition` is `true`, then the status must not be present. ##### Separation of duties condition ##### A condition that prevents a user to perform the transition, if the user has already performed a transition on the issue. { \"type\": \"SeparationOfDutiesCondition\", \"configuration\": { \"fromStatus\": { \"id\": \"5\" }, \"toStatus\": { \"id\": \"6\" } } } * `fromStatus` OPTIONAL. An object containing the ID of the source status of the transition that is blocked. If omitted any transition to `toStatus` is blocked. * `toStatus` An object containing the ID of the target status of the transition that is blocked. ##### Subtask blocking condition ##### A condition that blocks transition on a parent issue if any of its subtasks are in any of one or more statuses. { \"type\": \"SubTaskBlockingCondition\", \"configuration\": { \"statuses\": [ { \"id\": \"1\" }, { \"id\": \"3\" } ] } } * `statuses` A list of objects containing status IDs. ##### User is in any group condition ##### A condition that allows users belonging to any group from a list of groups to execute a transition. { \"type\": \"UserInAnyGroupCondition\", \"configuration\": { \"groups\": [ \"administrators\", \"atlassian-addons-admin\" ] } } * `groups` A list of group names. ##### User is in any project role condition ##### A condition that allows only users with at least one project roles from a list of project roles to execute a transition. { \"type\": \"InAnyProjectRoleCondition\", \"configuration\": { \"projectRoles\": [ { \"id\": \"10002\" }, { \"id\": \"10003\" }, { \"id\": \"10012\" }, { \"id\": \"10013\" } ] } } * `projectRoles` A list of objects containing project role IDs. ##### User is in custom field condition ##### A condition that allows only users listed in a given custom field to execute the transition. { \"type\": \"UserIsInCustomFieldCondition\", \"configuration\": { \"allowUserInField\": false, \"fieldId\": \"customfield_10010\" } } * `allowUserInField` If `true` only a user who is listed in `fieldId` can perform the transition, otherwise, only a user who is not listed in `fieldId` can perform the transition. * `fieldId` The ID of the field containing the list of users. ##### User is in group condition ##### A condition that allows users belonging to a group to execute a transition. { \"type\": \"UserInGroupCondition\", \"configuration\": { \"group\": \"administrators\" } } * `group` The name of the group. ##### User is in group custom field condition ##### A condition that allows users belonging to a group specified in a custom field to execute a transition. { \"type\": \"InGroupCFCondition\", \"configuration\": { \"fieldId\": \"customfield_10012\" } } * `fieldId` The ID of the field. Allowed field types: * `com.atlassian.jira.plugin.system.customfieldtypes:multigrouppicker` * `com.atlassian.jira.plugin.system.customfieldtypes:grouppicker` * `com.atlassian.jira.plugin.system.customfieldtypes:select` * `com.atlassian.jira.plugin.system.customfieldtypes:multiselect` * `com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons` * `com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes` * `com.pyxis.greenhopper.jira:gh-epic-status` ##### User is in project role condition ##### A condition that allows users with a project role to execute a transition. { \"type\": \"InProjectRoleCondition\", \"configuration\": { \"projectRole\": { \"id\": \"10002\" } } } * `projectRole` An object containing the ID of a project role. ##### Value field condition ##### A conditions that allows a transition to execute if the value of a field is equal to a constant value or simply set. { \"type\": \"ValueFieldCondition\", \"configuration\": { \"fieldId\": \"assignee\", \"fieldValue\": \"qm:6e1ecee6-8e64-4db6-8c85-916bb3275f51:54b56885-2bd2-4381-8239-78263442520f\", \"comparisonType\": \"NUMBER\", \"comparator\": \"=\" } } * `fieldId` The ID of a field used in the comparison. * `fieldValue` The expected value of the field. * `comparisonType` The type of the comparison. Allowed values: `STRING`, `NUMBER`, `DATE`, `DATE_WITHOUT_TIME`, or `OPTIONID`. * `comparator` One of the supported comparator: `>`, `>=`, `=`, `<=`, `<`, `!=`. **Notes:** * If you choose the comparison type `STRING`, only `=` and `!=` are valid options. * You may leave `fieldValue` empty when comparison type is `!=` to indicate that a value is required in the field. * For date fields without time format values as `yyyy-MM-dd`, and for those with time as `yyyy-MM-dd HH:mm`. For example, for July 16 2021 use `2021-07-16`, for 8:05 AM use `2021-07-16 08:05`, and for 4 PM: `2021-07-16 16:00`. #### Validators #### Validators check that any input made to the transition is valid before the transition is performed. ##### Date field validator ##### A validator that compares two dates. { \"type\": \"DateFieldValidator\", \"configuration\": { \"comparator\": \">\", \"date1\": \"updated\", \"date2\": \"created\", \"expression\": \"1d\", \"includeTime\": true } } * `comparator` One of the supported comparator: `>`, `>=`, `=`, `<=`, `<`, or `!=`. * `date1` The date field to validate. Allowed field types: * `com.atlassian.jira.plugin.system.customfieldtypes:datepicker` * `com.atlassian.jira.plugin.system.customfieldtypes:datetime` * `com.atlassian.jpo:jpo-custom-field-baseline-end` * `com.atlassian.jpo:jpo-custom-field-baseline-start` * `duedate` * `created` * `updated` * `Resolved` * `date2` The second date field. Required, if `expression` is not passed. Allowed field types: * `com.atlassian.jira.plugin.system.customfieldtypes:datepicker` * `com.atlassian.jira.plugin.system.customfieldtypes:datetime` * `com.atlassian.jpo:jpo-custom-field-baseline-end` * `com.atlassian.jpo:jpo-custom-field-baseline-start` * `duedate` * `created` * `updated` * `Resolved` * `expression` An expression specifying an offset. Required, if `date2` is not passed. Offsets are built with a number, with `-` as prefix for the past, and one of these time units: `d` for day, `w` for week, `m` for month, or `y` for year. For example, -2d means two days into the past and 1w means one week into the future. The `now` keyword enables a comparison with the current date. * `includeTime` If `true`, then the time part of the data is included for the comparison. If the field doesn't have a time part, 00:00:00 is used. ##### Windows date validator ##### A validator that checks that a date falls on or after a reference date and before or on the reference date plus a number of days. { \"type\": \"WindowsDateValidator\", \"configuration\": { \"date1\": \"customfield_10009\", \"date2\": \"created\", \"windowsDays\": 5 } } * `date1` The date field to validate. Allowed field types: * `com.atlassian.jira.plugin.system.customfieldtypes:datepicker` * `com.atlassian.jira.plugin.system.customfieldtypes:datetime` * `com.atlassian.jpo:jpo-custom-field-baseline-end` * `com.atlassian.jpo:jpo-custom-field-baseline-start` * `duedate` * `created` * `updated` * `Resolved` * `date2` The reference date. Allowed field types: * `com.atlassian.jira.plugin.system.customfieldtypes:datepicker` * `com.atlassian.jira.plugin.system.customfieldtypes:datetime` * `com.atlassian.jpo:jpo-custom-field-baseline-end` * `com.atlassian.jpo:jpo-custom-field-baseline-start` * `duedate` * `created` * `updated` * `Resolved` * `windowsDays` A positive integer indicating a number of days. ##### Field required validator ##### A validator that checks fields are not empty. By default, if a field is not included in the current context it's ignored and not validated. { \"type\": \"FieldRequiredValidator\", \"configuration\": { \"ignoreContext\": true, \"errorMessage\": \"Hey\", \"fieldIds\": [ \"versions\", \"customfield_10037\", \"customfield_10003\" ] } } * `ignoreContext` If `true`, then the context is ignored and all the fields are validated. * `errorMessage` OPTIONAL. The error message displayed when one or more fields are empty. A default error message is shown if an error message is not provided. * `fieldIds` The list of fields to validate. ##### Field changed validator ##### A validator that checks that a field value is changed. However, this validation can be ignored for users from a list of groups. { \"type\": \"FieldChangedValidator\", \"configuration\": { \"fieldId\": \"comment\", \"errorMessage\": \"Hey\", \"exemptedGroups\": [ \"administrators\", \"atlassian-addons-admin\" ] } } * `fieldId` The ID of a field. * `errorMessage` OPTIONAL. The error message displayed if the field is not changed. A default error message is shown if the error message is not provided. * `exemptedGroups` OPTIONAL. The list of groups. ##### Field has single value validator ##### A validator that checks that a multi-select field has only one value. Optionally, the validation can ignore values copied from subtasks. { \"type\": \"FieldHasSingleValueValidator\", \"configuration\": { \"fieldId\": \"attachment, \"excludeSubtasks\": true } } * `fieldId` The ID of a field. * `excludeSubtasks` If `true`, then values copied from subtasks are ignored. ##### Parent status validator ##### A validator that checks the status of the parent issue of a subtask. Ìf the issue is not a subtask, no validation is performed. { \"type\": \"ParentStatusValidator\", \"configuration\": { \"parentStatuses\": [ { \"id\":\"1\" }, { \"id\":\"2\" } ] } } * `parentStatus` The list of required parent issue statuses. ##### Permission validator ##### A validator that checks the user has a permission. { \"type\": \"PermissionValidator\", \"configuration\": { \"permissionKey\": \"ADMINISTER_PROJECTS\" } } * `permissionKey` The permission required to perform the transition. Allowed values: [built-in](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permission-schemes/#built-in-permissions) or app defined permissions. ##### Previous status validator ##### A validator that checks if the issue has held a status. { \"type\": \"PreviousStatusValidator\", \"configuration\": { \"mostRecentStatusOnly\": false, \"previousStatus\": { \"id\": \"15\" } } } * `mostRecentStatusOnly` If `true`, then only the issue's preceding status (the one immediately before the current status) is checked. * `previousStatus` An object containing the ID of an issue status. ##### Regular expression validator ##### A validator that checks the content of a field against a regular expression. { \"type\": \"RegexpFieldValidator\", \"configuration\": { \"regExp\": \"[0-9]\", \"fieldId\": \"customfield_10029\" } } * `regExp`A regular expression. * `fieldId` The ID of a field. Allowed field types: * `com.atlassian.jira.plugin.system.customfieldtypes:select` * `com.atlassian.jira.plugin.system.customfieldtypes:multiselect` * `com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons` * `com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes` * `com.atlassian.jira.plugin.system.customfieldtypes:textarea` * `com.atlassian.jira.plugin.system.customfieldtypes:textfield` * `com.atlassian.jira.plugin.system.customfieldtypes:url` * `com.atlassian.jira.plugin.system.customfieldtypes:float` * `com.pyxis.greenhopper.jira:jsw-story-points` * `com.pyxis.greenhopper.jira:gh-epic-status` * `description` * `summary` ##### User permission validator ##### A validator that checks if a user has a permission. Obsolete. You may encounter this validator when getting transition rules and can pass it when updating or creating rules, for example, when you want to duplicate the rules from a workflow on a new workflow. { \"type\": \"UserPermissionValidator\", \"configuration\": { \"permissionKey\": \"BROWSE_PROJECTS\", \"nullAllowed\": false, \"username\": \"TestUser\" } } * `permissionKey` The permission to be validated. Allowed values: [built-in](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permission-schemes/#built-in-permissions) or app defined permissions. * `nullAllowed` If `true`, allows the transition when `username` is empty. * `username` The username to validate against the `permissionKey`. #### Post functions #### Post functions carry out any additional processing required after a Jira workflow transition is executed. ##### Fire issue event function ##### A post function that fires an event that is processed by the listeners. { \"type\": \"FireIssueEventFunction\", \"configuration\": { \"event\": { \"id\":\"1\" } } } **Note:** If provided, this post function overrides the default `FireIssueEventFunction`. Can be included once in a transition. * `event` An object containing the ID of the issue event. ##### Update issue status ##### A post function that sets issue status to the linked status of the destination workflow status. { \"type\": \"UpdateIssueStatusFunction\" } **Note:** This post function is a default function in global and directed transitions. It can only be added to the initial transition and can only be added once. ##### Create comment ##### A post function that adds a comment entered during the transition to an issue. { \"type\": \"CreateCommentFunction\" } **Note:** This post function is a default function in global and directed transitions. It can only be added to the initial transition and can only be added once. ##### Store issue ##### A post function that stores updates to an issue. { \"type\": \"IssueStoreFunction\" } **Note:** This post function can only be added to the initial transition and can only be added once. ##### Assign to current user function ##### A post function that assigns the issue to the current user if the current user has the `ASSIGNABLE_USER` permission. { \"type\": \"AssignToCurrentUserFunction\" } **Note:** This post function can be included once in a transition. ##### Assign to lead function ##### A post function that assigns the issue to the project or component lead developer. { \"type\": \"AssignToLeadFunction\" } **Note:** This post function can be included once in a transition. ##### Assign to reporter function ##### A post function that assigns the issue to the reporter. { \"type\": \"AssignToReporterFunction\" } **Note:** This post function can be included once in a transition. ##### Clear field value function ##### A post function that clears the value from a field. { \"type\": \"ClearFieldValuePostFunction\", \"configuration\": { \"fieldId\": \"assignee\" } } * `fieldId` The ID of the field. ##### Copy value from other field function ##### A post function that copies the value of one field to another, either within an issue or from parent to subtask. { \"type\": \"CopyValueFromOtherFieldPostFunction\", \"configuration\": { \"sourceFieldId\": \"assignee\", \"destinationFieldId\": \"creator\", \"copyType\": \"same\" } } * `sourceFieldId` The ID of the source field. * `destinationFieldId` The ID of the destination field. * `copyType` Use `same` to copy the value from a field inside the issue, or `parent` to copy the value from the parent issue. ##### Create Crucible review workflow function ##### A post function that creates a Crucible review for all unreviewed code for the issue. { \"type\": \"CreateCrucibleReviewWorkflowFunction\" } **Note:** This post function can be included once in a transition. ##### Set issue security level based on user's project role function ##### A post function that sets the issue's security level if the current user has a project role. { \"type\": \"SetIssueSecurityFromRoleFunction\", \"configuration\": { \"projectRole\": { \"id\":\"10002\" }, \"issueSecurityLevel\": { \"id\":\"10000\" } } } * `projectRole` An object containing the ID of the project role. * `issueSecurityLevel` OPTIONAL. The object containing the ID of the security level. If not passed, then the security level is set to `none`. ##### Trigger a webhook function ##### A post function that triggers a webhook. { \"type\": \"TriggerWebhookFunction\", \"configuration\": { \"webhook\": { \"id\": \"1\" } } } * `webhook` An object containing the ID of the webhook listener to trigger. ##### Update issue custom field function ##### A post function that updates the content of an issue custom field. { \"type\": \"UpdateIssueCustomFieldPostFunction\", \"configuration\": { \"mode\": \"append\", \"fieldId\": \"customfield_10003\", \"fieldValue\": \"yikes\" } } * `mode` Use `replace` to override the field content with `fieldValue` or `append` to add `fieldValue` to the end of the field content. * `fieldId` The ID of the field. * `fieldValue` The update content. ##### Update issue field function ##### A post function that updates a simple issue field. { \"type\": \"UpdateIssueFieldFunction\", \"configuration\": { \"fieldId\": \"assignee\", \"fieldValue\": \"5f0c277e70b8a90025a00776\" } } * `fieldId` The ID of the field. Allowed field types: * `assignee` * `description` * `environment` * `priority` * `resolution` * `summary` * `timeoriginalestimate` * `timeestimate` * `timespent` * `fieldValue` The update value. * If the `fieldId` is `assignee`, the `fieldValue` should be one of these values: * an account ID. * `automatic`. * a blank string, which sets the value to `unassigned`. #### Connect rules #### Connect rules are conditions, validators, and post functions of a transition that are registered by Connect apps. To create a rule registered by the app, the app must be enabled and the rule's module must exist. { \"type\": \"appKey__moduleKey\", \"configuration\": { \"value\":\"{\\\"isValid\\\":\\\"true\\\"}\" } } * `type` A Connect rule key in a form of `appKey__moduleKey`. * `value` The stringified JSON configuration of a Connect rule. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
99pub async fn create_workflow(configuration: &configuration::Configuration, params: CreateWorkflowParams) -> Result<crate::models::WorkflowIds, Error<CreateWorkflowError>> {
100 let local_var_configuration = configuration;
101
102 // unbox the parameters
103 let create_workflow_details = params.create_workflow_details;
104
105
106 let local_var_client = &local_var_configuration.client;
107
108 let local_var_uri_str = format!("{}/rest/api/2/workflow", local_var_configuration.base_path);
109 let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str());
110
111 if let Some(ref local_var_user_agent) = local_var_configuration.user_agent {
112 local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone());
113 }
114 if let Some(ref local_var_token) = local_var_configuration.oauth_access_token {
115 local_var_req_builder = local_var_req_builder.bearer_auth(local_var_token.to_owned());
116 };
117 if let Some(ref local_var_auth_conf) = local_var_configuration.basic_auth {
118 local_var_req_builder = local_var_req_builder.basic_auth(local_var_auth_conf.0.to_owned(), local_var_auth_conf.1.to_owned());
119 };
120 local_var_req_builder = local_var_req_builder.json(&create_workflow_details);
121
122 let local_var_req = local_var_req_builder.build()?;
123 let local_var_resp = local_var_client.execute(local_var_req).await?;
124
125 let local_var_status = local_var_resp.status();
126 let local_var_content = local_var_resp.text().await?;
127
128 if !local_var_status.is_client_error() && !local_var_status.is_server_error() {
129 serde_json::from_str(&local_var_content).map_err(Error::from)
130 } else {
131 let local_var_entity: Option<CreateWorkflowError> = serde_json::from_str(&local_var_content).ok();
132 let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity };
133 Err(Error::ResponseError(local_var_error))
134 }
135}
136
137/// Deletes a workflow. The workflow cannot be deleted if it is: * an active workflow. * a system workflow. * associated with any workflow scheme. * associated with any draft workflow scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
138pub async fn delete_inactive_workflow(configuration: &configuration::Configuration, params: DeleteInactiveWorkflowParams) -> Result<(), Error<DeleteInactiveWorkflowError>> {
139 let local_var_configuration = configuration;
140
141 // unbox the parameters
142 let entity_id = params.entity_id;
143
144
145 let local_var_client = &local_var_configuration.client;
146
147 let local_var_uri_str = format!("{}/rest/api/2/workflow/{entityId}", local_var_configuration.base_path, entityId=crate::apis::urlencode(entity_id));
148 let mut local_var_req_builder = local_var_client.request(reqwest::Method::DELETE, local_var_uri_str.as_str());
149
150 if let Some(ref local_var_user_agent) = local_var_configuration.user_agent {
151 local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone());
152 }
153 if let Some(ref local_var_token) = local_var_configuration.oauth_access_token {
154 local_var_req_builder = local_var_req_builder.bearer_auth(local_var_token.to_owned());
155 };
156 if let Some(ref local_var_auth_conf) = local_var_configuration.basic_auth {
157 local_var_req_builder = local_var_req_builder.basic_auth(local_var_auth_conf.0.to_owned(), local_var_auth_conf.1.to_owned());
158 };
159
160 let local_var_req = local_var_req_builder.build()?;
161 let local_var_resp = local_var_client.execute(local_var_req).await?;
162
163 let local_var_status = local_var_resp.status();
164 let local_var_content = local_var_resp.text().await?;
165
166 if !local_var_status.is_client_error() && !local_var_status.is_server_error() {
167 Ok(())
168 } else {
169 let local_var_entity: Option<DeleteInactiveWorkflowError> = serde_json::from_str(&local_var_content).ok();
170 let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity };
171 Err(Error::ResponseError(local_var_error))
172 }
173}
174
175/// Returns all workflows in Jira or a workflow. Deprecated, use [Get workflows paginated](#api-rest-api-2-workflow-search-get). If the `workflowName` parameter is specified, the workflow is returned as an object (not in an array). Otherwise, an array of workflow objects is returned. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
176pub async fn get_all_workflows(configuration: &configuration::Configuration, params: GetAllWorkflowsParams) -> Result<Vec<crate::models::DeprecatedWorkflow>, Error<GetAllWorkflowsError>> {
177 let local_var_configuration = configuration;
178
179 // unbox the parameters
180 let workflow_name = params.workflow_name;
181
182
183 let local_var_client = &local_var_configuration.client;
184
185 let local_var_uri_str = format!("{}/rest/api/2/workflow", local_var_configuration.base_path);
186 let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str());
187
188 if let Some(ref local_var_str) = workflow_name {
189 local_var_req_builder = local_var_req_builder.query(&[("workflowName", &local_var_str.to_string())]);
190 }
191 if let Some(ref local_var_user_agent) = local_var_configuration.user_agent {
192 local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone());
193 }
194 if let Some(ref local_var_token) = local_var_configuration.oauth_access_token {
195 local_var_req_builder = local_var_req_builder.bearer_auth(local_var_token.to_owned());
196 };
197 if let Some(ref local_var_auth_conf) = local_var_configuration.basic_auth {
198 local_var_req_builder = local_var_req_builder.basic_auth(local_var_auth_conf.0.to_owned(), local_var_auth_conf.1.to_owned());
199 };
200
201 let local_var_req = local_var_req_builder.build()?;
202 let local_var_resp = local_var_client.execute(local_var_req).await?;
203
204 let local_var_status = local_var_resp.status();
205 let local_var_content = local_var_resp.text().await?;
206
207 if !local_var_status.is_client_error() && !local_var_status.is_server_error() {
208 serde_json::from_str(&local_var_content).map_err(Error::from)
209 } else {
210 let local_var_entity: Option<GetAllWorkflowsError> = serde_json::from_str(&local_var_content).ok();
211 let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity };
212 Err(Error::ResponseError(local_var_error))
213 }
214}
215
216/// Returns a [paginated](#pagination) list of published classic workflows. When workflow names are specified, details of those workflows are returned. Otherwise, all published classic workflows are returned. This operation does not return next-gen workflows. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
217pub async fn get_workflows_paginated(configuration: &configuration::Configuration, params: GetWorkflowsPaginatedParams) -> Result<crate::models::PageBeanWorkflow, Error<GetWorkflowsPaginatedError>> {
218 let local_var_configuration = configuration;
219
220 // unbox the parameters
221 let start_at = params.start_at;
222 let max_results = params.max_results;
223 let workflow_name = params.workflow_name;
224 let expand = params.expand;
225 let query_string = params.query_string;
226 let order_by = params.order_by;
227 let is_active = params.is_active;
228
229
230 let local_var_client = &local_var_configuration.client;
231
232 let local_var_uri_str = format!("{}/rest/api/2/workflow/search", local_var_configuration.base_path);
233 let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str());
234
235 if let Some(ref local_var_str) = start_at {
236 local_var_req_builder = local_var_req_builder.query(&[("startAt", &local_var_str.to_string())]);
237 }
238 if let Some(ref local_var_str) = max_results {
239 local_var_req_builder = local_var_req_builder.query(&[("maxResults", &local_var_str.to_string())]);
240 }
241 if let Some(ref local_var_str) = workflow_name {
242 local_var_req_builder = match "multi" {
243 "multi" => local_var_req_builder.query(&local_var_str.into_iter().map(|p| ("workflowName".to_owned(), p.to_string())).collect::<Vec<(std::string::String, std::string::String)>>()),
244 _ => local_var_req_builder.query(&[("workflowName", &local_var_str.into_iter().map(|p| p.to_string()).collect::<Vec<String>>().join(",").to_string())]),
245 };
246 }
247 if let Some(ref local_var_str) = expand {
248 local_var_req_builder = local_var_req_builder.query(&[("expand", &local_var_str.to_string())]);
249 }
250 if let Some(ref local_var_str) = query_string {
251 local_var_req_builder = local_var_req_builder.query(&[("queryString", &local_var_str.to_string())]);
252 }
253 if let Some(ref local_var_str) = order_by {
254 local_var_req_builder = local_var_req_builder.query(&[("orderBy", &local_var_str.to_string())]);
255 }
256 if let Some(ref local_var_str) = is_active {
257 local_var_req_builder = local_var_req_builder.query(&[("isActive", &local_var_str.to_string())]);
258 }
259 if let Some(ref local_var_user_agent) = local_var_configuration.user_agent {
260 local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone());
261 }
262 if let Some(ref local_var_token) = local_var_configuration.oauth_access_token {
263 local_var_req_builder = local_var_req_builder.bearer_auth(local_var_token.to_owned());
264 };
265 if let Some(ref local_var_auth_conf) = local_var_configuration.basic_auth {
266 local_var_req_builder = local_var_req_builder.basic_auth(local_var_auth_conf.0.to_owned(), local_var_auth_conf.1.to_owned());
267 };
268
269 let local_var_req = local_var_req_builder.build()?;
270 let local_var_resp = local_var_client.execute(local_var_req).await?;
271
272 let local_var_status = local_var_resp.status();
273 let local_var_content = local_var_resp.text().await?;
274
275 if !local_var_status.is_client_error() && !local_var_status.is_server_error() {
276 serde_json::from_str(&local_var_content).map_err(Error::from)
277 } else {
278 let local_var_entity: Option<GetWorkflowsPaginatedError> = serde_json::from_str(&local_var_content).ok();
279 let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity };
280 Err(Error::ResponseError(local_var_error))
281 }
282}
283