Skip to content

Latest commit

 

History

History
268 lines (205 loc) · 15.6 KB

WorkflowTransitionPropertiesApi.md

File metadata and controls

268 lines (205 loc) · 15.6 KB

WorkflowTransitionPropertiesApi

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

Method HTTP request Description
createWorkflowTransitionProperty POST /rest/api/3/workflow/transitions/{transitionId}/properties Create workflow transition property
deleteWorkflowTransitionProperty DELETE /rest/api/3/workflow/transitions/{transitionId}/properties Delete workflow transition property
getWorkflowTransitionProperties GET /rest/api/3/workflow/transitions/{transitionId}/properties Get workflow transition properties
updateWorkflowTransitionProperty PUT /rest/api/3/workflow/transitions/{transitionId}/properties Update workflow transition property

createWorkflowTransitionProperty

WorkflowTransitionProperty createWorkflowTransitionProperty(body, key, workflowName, transitionId, workflowMode)

Create workflow transition property

Adds a property to a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties. Permissions required: Administer Jira global permission.

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.WorkflowTransitionPropertiesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: OAuth2
OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
OAuth2.setAccessToken("YOUR ACCESS TOKEN");
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");

WorkflowTransitionPropertiesApi apiInstance = new WorkflowTransitionPropertiesApi();
Map<String, Object> body = new Map(); // Map<String, Object> | 
String key = "key_example"; // String | The key of the property being added, also known as the name of the property. Set this to the same value as the `key` defined in the request body.
String workflowName = "workflowName_example"; // String | The name of the workflow that the transition belongs to.
Long transitionId = 789L; // Long | The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition.
String workflowMode = "live"; // String | The workflow status. Set to *live* for inactive workflows or *draft* for draft workflows. Active workflows cannot be edited.
try {
    WorkflowTransitionProperty result = apiInstance.createWorkflowTransitionProperty(body, key, workflowName, transitionId, workflowMode);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WorkflowTransitionPropertiesApi#createWorkflowTransitionProperty");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body Map<String, Object>
key String The key of the property being added, also known as the name of the property. Set this to the same value as the `key` defined in the request body.
workflowName String The name of the workflow that the transition belongs to.
transitionId Long The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition.
workflowMode String The workflow status. Set to live for inactive workflows or draft for draft workflows. Active workflows cannot be edited. [optional] [default to live] [enum: live, draft]

Return type

WorkflowTransitionProperty

Authorization

OAuth2basicAuth

HTTP request headers

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

deleteWorkflowTransitionProperty

deleteWorkflowTransitionProperty(transitionId, key, workflowName, workflowMode)

Delete workflow transition property

Deletes a property from a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties. Permissions required: Administer Jira global permission.

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.WorkflowTransitionPropertiesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: OAuth2
OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
OAuth2.setAccessToken("YOUR ACCESS TOKEN");
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");

WorkflowTransitionPropertiesApi apiInstance = new WorkflowTransitionPropertiesApi();
Long transitionId = 789L; // Long | The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition.
String key = "key_example"; // String | The name of the transition property to delete, also known as the name of the property.
String workflowName = "workflowName_example"; // String | The name of the workflow that the transition belongs to.
String workflowMode = "workflowMode_example"; // String | The workflow status. Set to `live` for inactive workflows or `draft` for draft workflows. Active workflows cannot be edited.
try {
    apiInstance.deleteWorkflowTransitionProperty(transitionId, key, workflowName, workflowMode);
} catch (ApiException e) {
    System.err.println("Exception when calling WorkflowTransitionPropertiesApi#deleteWorkflowTransitionProperty");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
transitionId Long The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition.
key String The name of the transition property to delete, also known as the name of the property.
workflowName String The name of the workflow that the transition belongs to.
workflowMode String The workflow status. Set to `live` for inactive workflows or `draft` for draft workflows. Active workflows cannot be edited. [optional] [enum: live, draft]

Return type

null (empty response body)

Authorization

OAuth2basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

getWorkflowTransitionProperties

WorkflowTransitionProperty getWorkflowTransitionProperties(transitionId, workflowName, includeReservedKeys, key, workflowMode)

Get workflow transition properties

Returns the properties on a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties. Permissions required: Administer Jira global permission.

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.WorkflowTransitionPropertiesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: OAuth2
OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
OAuth2.setAccessToken("YOUR ACCESS TOKEN");
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");

WorkflowTransitionPropertiesApi apiInstance = new WorkflowTransitionPropertiesApi();
Long transitionId = 789L; // Long | The ID of the transition. To get the ID, view the workflow in text mode in the Jira administration console. The ID is shown next to the transition.
String workflowName = "workflowName_example"; // String | The name of the workflow that the transition belongs to.
Boolean includeReservedKeys = false; // Boolean | Some properties with keys that have the *jira.* prefix are reserved, which means they are not editable. To include these properties in the results, set this parameter to *true*.
String key = "key_example"; // String | The key of the property being returned, also known as the name of the property. If this parameter is not specified, all properties on the transition are returned.
String workflowMode = "live"; // String | The workflow status. Set to *live* for active and inactive workflows, or *draft* for draft workflows.
try {
    WorkflowTransitionProperty result = apiInstance.getWorkflowTransitionProperties(transitionId, workflowName, includeReservedKeys, key, workflowMode);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WorkflowTransitionPropertiesApi#getWorkflowTransitionProperties");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
transitionId Long The ID of the transition. To get the ID, view the workflow in text mode in the Jira administration console. The ID is shown next to the transition.
workflowName String The name of the workflow that the transition belongs to.
includeReservedKeys Boolean Some properties with keys that have the jira. prefix are reserved, which means they are not editable. To include these properties in the results, set this parameter to true. [optional] [default to false]
key String The key of the property being returned, also known as the name of the property. If this parameter is not specified, all properties on the transition are returned. [optional]
workflowMode String The workflow status. Set to live for active and inactive workflows, or draft for draft workflows. [optional] [default to live] [enum: live, draft]

Return type

WorkflowTransitionProperty

Authorization

OAuth2basicAuth

HTTP request headers

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

updateWorkflowTransitionProperty

WorkflowTransitionProperty updateWorkflowTransitionProperty(body, key, workflowName, transitionId, workflowMode)

Update workflow transition property

Updates a workflow transition by changing the property value. Trying to update a property that does not exist results in a new property being added to the transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties. Permissions required: Administer Jira global permission.

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.WorkflowTransitionPropertiesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: OAuth2
OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
OAuth2.setAccessToken("YOUR ACCESS TOKEN");
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");

WorkflowTransitionPropertiesApi apiInstance = new WorkflowTransitionPropertiesApi();
Map<String, Object> body = new Map(); // Map<String, Object> | 
String key = "key_example"; // String | The key of the property being updated, also known as the name of the property. Set this to the same value as the `key` defined in the request body.
String workflowName = "workflowName_example"; // String | The name of the workflow that the transition belongs to.
Long transitionId = 789L; // Long | The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition.
String workflowMode = "workflowMode_example"; // String | The workflow status. Set to `live` for inactive workflows or `draft` for draft workflows. Active workflows cannot be edited.
try {
    WorkflowTransitionProperty result = apiInstance.updateWorkflowTransitionProperty(body, key, workflowName, transitionId, workflowMode);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WorkflowTransitionPropertiesApi#updateWorkflowTransitionProperty");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body Map<String, Object>
key String The key of the property being updated, also known as the name of the property. Set this to the same value as the `key` defined in the request body.
workflowName String The name of the workflow that the transition belongs to.
transitionId Long The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition.
workflowMode String The workflow status. Set to `live` for inactive workflows or `draft` for draft workflows. Active workflows cannot be edited. [optional] [enum: live, draft]

Return type

WorkflowTransitionProperty

Authorization

OAuth2basicAuth

HTTP request headers

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