All URIs are relative to https://your-domain.atlassian.com
| Method | HTTP request | Description |
|---|---|---|
| bulkDeleteIssueProperty | DELETE /rest/api/3/issue/properties/{propertyKey} | Bulk delete issue property |
| bulkSetIssueProperty | PUT /rest/api/3/issue/properties/{propertyKey} | Bulk set issue property |
| bulkSetIssuesProperties | POST /rest/api/3/issue/properties | Bulk set issues properties |
| deleteIssueProperty | DELETE /rest/api/3/issue/{issueIdOrKey}/properties/{propertyKey} | Delete issue property |
| getIssueProperty | GET /rest/api/3/issue/{issueIdOrKey}/properties/{propertyKey} | Get issue property |
| getIssuePropertyKeys | GET /rest/api/3/issue/{issueIdOrKey}/properties | Get issue property keys |
| setIssueProperty | PUT /rest/api/3/issue/{issueIdOrKey}/properties/{propertyKey} | Set issue property |
bulkDeleteIssueProperty(body, propertyKey)
Bulk delete issue property
Deletes a property value from multiple issues. The issues to be updated can be specified by filter criteria. The criteria the filter used to identify eligible issues are: * `entityIds` Only issues from this list are eligible. * `currentValue` Only issues with the property set to this value are eligible. If both criteria is specified, they are joined with the logical AND: only issues that satisfy both criteria are considered eligible. If no filter criteria are specified, all the issues visible to the user and where the user has the EDIT\_ISSUES permission for the issue are considered eligible. This operation is: * transactional, either the property is deleted from all eligible issues or, when errors occur, no properties are deleted. * asynchronous. Follow the `location` link in the response to determine the status of the task and use Get task to obtain subsequent updates. Permissions required: * Browse projects project permission for each project containing issues. * If issue-level security is configured, issue-level security permission to view the issue. * Edit issues project permission for each issue.
// 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.IssuePropertiesApi;
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");
IssuePropertiesApi apiInstance = new IssuePropertiesApi();
IssueFilterForBulkPropertyDelete body = new IssueFilterForBulkPropertyDelete(); // IssueFilterForBulkPropertyDelete |
String propertyKey = "propertyKey_example"; // String | The key of the property.
try {
apiInstance.bulkDeleteIssueProperty(body, propertyKey);
} catch (ApiException e) {
System.err.println("Exception when calling IssuePropertiesApi#bulkDeleteIssueProperty");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| body | IssueFilterForBulkPropertyDelete | ||
| propertyKey | String | The key of the property. |
null (empty response body)
- Content-Type: application/json
- Accept: application/json
bulkSetIssueProperty(body, propertyKey)
Bulk set issue property
Sets a property value on multiple issues. The value set can be a constant or determined by a Jira expression. Expressions must be computable with constant complexity when applied to a set of issues. Expressions must also comply with the restrictions that apply to all Jira expressions. The issues to be updated can be specified by a filter. The filter identifies issues eligible for update using these criteria: * `entityIds` Only issues from this list are eligible. * `currentValue` Only issues with the property set to this value are eligible. * `hasProperty`: * If true, only issues with the property are eligible. * If false, only issues without the property are eligible. If more than one criteria is specified, they are joined with the logical AND: only issues that satisfy all criteria are eligible. If an invalid combination of criteria is provided, an error is returned. For example, specifying a `currentValue` and `hasProperty` as false would not match any issues (because without the property the property cannot have a value). The filter is optional. Without the filter all the issues visible to the user and where the user has the EDIT\_ISSUES permission for the issue are considered eligible. This operation is: * transactional, either all eligible issues are updated or, when errors occur, none are updated. * asynchronous. Follow the `location` link in the response to determine the status of the task and use Get task to obtain subsequent updates. Permissions required: * Browse projects project permission for each project containing issues. * If issue-level security is configured, issue-level security permission to view the issue. * Edit issues project permission for each issue.
// 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.IssuePropertiesApi;
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");
IssuePropertiesApi apiInstance = new IssuePropertiesApi();
BulkIssuePropertyUpdateRequest body = new BulkIssuePropertyUpdateRequest(); // BulkIssuePropertyUpdateRequest |
String propertyKey = "propertyKey_example"; // String | The key of the property. The maximum length is 255 characters.
try {
apiInstance.bulkSetIssueProperty(body, propertyKey);
} catch (ApiException e) {
System.err.println("Exception when calling IssuePropertiesApi#bulkSetIssueProperty");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| body | BulkIssuePropertyUpdateRequest | ||
| propertyKey | String | The key of the property. The maximum length is 255 characters. |
null (empty response body)
- Content-Type: application/json
- Accept: application/json
bulkSetIssuesProperties(body)
Bulk set issues properties
Sets the values of entity properties on issues. It can set up to 10 entity properties on up to 10,000 issues. The value of the request body must be a valid, non-empty JSON. The maximum length of single issue property value is 32768 characters. This operation can be accessed anonymously. This operation is: * transactional, either all properties are updated in all eligible issues or, when errors occur, no properties are updated. * asynchronous. Follow the `location` link in the response to determine the status of the task and use Get task to obtain subsequent updates. Permissions required: * Browse projects and Edit issues project permissions for the project containing the issue. * If issue-level security is configured, issue-level security permission to view the issue.
// 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.IssuePropertiesApi;
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");
IssuePropertiesApi apiInstance = new IssuePropertiesApi();
IssueEntityProperties body = new IssueEntityProperties(); // IssueEntityProperties | Issue properties to be set or updated with values.
try {
apiInstance.bulkSetIssuesProperties(body);
} catch (ApiException e) {
System.err.println("Exception when calling IssuePropertiesApi#bulkSetIssuesProperties");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| body | IssueEntityProperties | Issue properties to be set or updated with values. |
null (empty response body)
- Content-Type: application/json
- Accept: application/json
deleteIssueProperty(issueIdOrKey, propertyKey)
Delete issue property
Deletes an issue's property. This operation can be accessed anonymously. Permissions required: * Browse projects and Edit issues project permissions for the project containing the issue. * If issue-level security is configured, issue-level security permission to view the issue.
// 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.IssuePropertiesApi;
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");
IssuePropertiesApi apiInstance = new IssuePropertiesApi();
String issueIdOrKey = "issueIdOrKey_example"; // String | The key or ID of the issue.
String propertyKey = "propertyKey_example"; // String | The key of the property.
try {
apiInstance.deleteIssueProperty(issueIdOrKey, propertyKey);
} catch (ApiException e) {
System.err.println("Exception when calling IssuePropertiesApi#deleteIssueProperty");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| issueIdOrKey | String | The key or ID of the issue. | |
| propertyKey | String | The key of the property. |
null (empty response body)
- Content-Type: Not defined
- Accept: Not defined
EntityProperty getIssueProperty(issueIdOrKey, propertyKey)
Get issue property
Returns the key and value of an issue's property. This operation can be accessed anonymously. Permissions required: * Browse projects project permission for the project containing the issue. * If issue-level security is configured, issue-level security permission to view the issue.
// 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.IssuePropertiesApi;
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");
IssuePropertiesApi apiInstance = new IssuePropertiesApi();
String issueIdOrKey = "issueIdOrKey_example"; // String | The key or ID of the issue.
String propertyKey = "propertyKey_example"; // String | The key of the property.
try {
EntityProperty result = apiInstance.getIssueProperty(issueIdOrKey, propertyKey);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IssuePropertiesApi#getIssueProperty");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| issueIdOrKey | String | The key or ID of the issue. | |
| propertyKey | String | The key of the property. |
- Content-Type: Not defined
- Accept: application/json
PropertyKeys getIssuePropertyKeys(issueIdOrKey)
Get issue property keys
Returns the URLs and keys of an issue's properties. This operation can be accessed anonymously. Permissions required: Property details are only returned where the user has: * Browse projects project permission for the project containing the issue. * If issue-level security is configured, issue-level security permission to view the issue.
// 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.IssuePropertiesApi;
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");
IssuePropertiesApi apiInstance = new IssuePropertiesApi();
String issueIdOrKey = "issueIdOrKey_example"; // String | The key or ID of the issue.
try {
PropertyKeys result = apiInstance.getIssuePropertyKeys(issueIdOrKey);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IssuePropertiesApi#getIssuePropertyKeys");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| issueIdOrKey | String | The key or ID of the issue. |
- Content-Type: Not defined
- Accept: application/json
Object setIssueProperty(body, issueIdOrKey, propertyKey)
Set issue property
Sets the value of an issue's property. Use this resource to store custom data against an issue. The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters. This operation can be accessed anonymously. Permissions required: * Browse projects and Edit issues project permissions for the project containing the issue. * If issue-level security is configured, issue-level security permission to view the issue.
// 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.IssuePropertiesApi;
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");
IssuePropertiesApi apiInstance = new IssuePropertiesApi();
Object body = null; // Object |
String issueIdOrKey = "issueIdOrKey_example"; // String | The ID or key of the issue.
String propertyKey = "propertyKey_example"; // String | The key of the issue property. The maximum length is 255 characters.
try {
Object result = apiInstance.setIssueProperty(body, issueIdOrKey, propertyKey);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IssuePropertiesApi#setIssueProperty");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| body | Object | ||
| issueIdOrKey | String | The ID or key of the issue. | |
| propertyKey | String | The key of the issue property. The maximum length is 255 characters. |
Object
- Content-Type: application/json
- Accept: application/json