Skip to content

Latest commit

 

History

History
123 lines (92 loc) · 6.72 KB

WorkflowTransitionRulesApi.md

File metadata and controls

123 lines (92 loc) · 6.72 KB
Raw

WorkflowTransitionRulesApi

All URIs are relative to https://your-domain.atlassian.com

Method HTTP request Description
getWorkflowTransitionRuleConfigurations GET /rest/api/3/workflow/rule/config Get workflow transition rule configurations
updateWorkflowTransitionRuleConfigurations PUT /rest/api/3/workflow/rule/config Update workflow transition rule configurations

getWorkflowTransitionRuleConfigurations

PageBeanWorkflowTransitionRules getWorkflowTransitionRuleConfigurations(types, startAt, maxResults, keys, expand)

Get workflow transition rule configurations

Returns a paginated list of workflows with transition rules. The workflows can be filtered to return only those containing workflow transition rules: * of one or more transition rule types, such as workflow post functions. * matching one or more transition rule keys. Only workflows containing transition rules created by the calling Connect app are returned. However, if a workflow is returned all transition rules that match the filters are returned for that workflow. Due to server-side optimizations, workflows with an empty list of rules may be returned; these workflows can be ignored. Permissions required: Only Connect apps can use this operation.

Example

// Import classes:
//import com.xminds.jira.rest.client.ApiClient;
//import com.xminds.jira.rest.client.ApiException;
//import com.xminds.jira.rest.client.Configuration;
//import com.xminds.jira.rest.client.auth.*;
//import com.xminds.jira.rest.client.api.WorkflowTransitionRulesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");

WorkflowTransitionRulesApi apiInstance = new WorkflowTransitionRulesApi();
List<String> types = Arrays.asList("types_example"); // List<String> | The types of the transition rules to return.
Long startAt = 0L; // Long | The index of the first item to return in a page of results (page offset).
Integer maxResults = 10; // Integer | The maximum number of items to return per page.
List<String> keys = Arrays.asList("keys_example"); // List<String> | The transition rule class keys, as defined in the Connect app descriptor, of the transition rules to return.
String expand = "expand_example"; // String | Use [expand](#expansion) to include additional information in the response. This parameter accepts `transition`, which, for each rule, returns information about the transition the rule is assigned to.
try {
    PageBeanWorkflowTransitionRules result = apiInstance.getWorkflowTransitionRuleConfigurations(types, startAt, maxResults, keys, expand);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WorkflowTransitionRulesApi#getWorkflowTransitionRuleConfigurations");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
types List<String> The types of the transition rules to return. [enum: postfunction, condition, validator]
startAt Long The index of the first item to return in a page of results (page offset). [optional] [default to 0]
maxResults Integer The maximum number of items to return per page. [optional] [default to 10]
keys List<String> The transition rule class keys, as defined in the Connect app descriptor, of the transition rules to return. [optional]
expand String Use expand to include additional information in the response. This parameter accepts `transition`, which, for each rule, returns information about the transition the rule is assigned to. [optional]

Return type

PageBeanWorkflowTransitionRules

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

updateWorkflowTransitionRuleConfigurations

WorkflowTransitionRulesUpdateErrors updateWorkflowTransitionRuleConfigurations(body)

Update workflow transition rule configurations

Updates configuration of workflow transition rules. The following rule types are supported: * post functions * conditions * validators Only rules created by the calling Connect app can be updated. Permissions required: Only Connect apps can use this operation.

Example

// Import classes:
//import com.xminds.jira.rest.client.ApiClient;
//import com.xminds.jira.rest.client.ApiException;
//import com.xminds.jira.rest.client.Configuration;
//import com.xminds.jira.rest.client.auth.*;
//import com.xminds.jira.rest.client.api.WorkflowTransitionRulesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");

WorkflowTransitionRulesApi apiInstance = new WorkflowTransitionRulesApi();
WorkflowTransitionRulesUpdate body = new WorkflowTransitionRulesUpdate(); // WorkflowTransitionRulesUpdate | 
try {
    WorkflowTransitionRulesUpdateErrors result = apiInstance.updateWorkflowTransitionRuleConfigurations(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WorkflowTransitionRulesApi#updateWorkflowTransitionRuleConfigurations");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body WorkflowTransitionRulesUpdate

Return type

WorkflowTransitionRulesUpdateErrors

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json