All URIs are relative to https://your-domain.atlassian.com
Method | HTTP request | Description |
---|---|---|
createVersion | POST /rest/api/3/version | Create version |
deleteAndReplaceVersion | POST /rest/api/3/version/{id}/removeAndSwap | Delete and replace version |
deleteVersion | DELETE /rest/api/3/version/{id} | Delete version |
getProjectVersions | GET /rest/api/3/project/{projectIdOrKey}/versions | Get project versions |
getProjectVersionsPaginated | GET /rest/api/3/project/{projectIdOrKey}/version | Get project versions paginated |
getVersion | GET /rest/api/3/version/{id} | Get version |
getVersionRelatedIssues | GET /rest/api/3/version/{id}/relatedIssueCounts | Get version's related issues count |
getVersionUnresolvedIssues | GET /rest/api/3/version/{id}/unresolvedIssueCount | Get version's unresolved issues count |
mergeVersions | PUT /rest/api/3/version/{id}/mergeto/{moveIssuesTo} | Merge versions |
moveVersion | POST /rest/api/3/version/{id}/move | Move version |
updateVersion | PUT /rest/api/3/version/{id} | Update version |
Version createVersion(body)
Create version
Creates a project version. This operation can be accessed anonymously. Permissions required: Administer Jira global permission or Administer Projects project permission for the project the version is added to.
// 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.ProjectVersionsApi;
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");
ProjectVersionsApi apiInstance = new ProjectVersionsApi();
Version body = new Version(); // Version |
try {
Version result = apiInstance.createVersion(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ProjectVersionsApi#createVersion");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
body | Version |
- Content-Type: application/json
- Accept: application/json
Object deleteAndReplaceVersion(body, id)
Delete and replace version
Deletes a project version. Alternative versions can be provided to update issues that use the deleted version in `fixVersion`, `affectedVersion`, or any version picker custom fields. If alternatives are not provided, occurrences of `fixVersion`, `affectedVersion`, and any version picker custom field, that contain the deleted version, are cleared. Any replacement version must be in the same project as the version being deleted and cannot be the version being deleted. This operation can be accessed anonymously. Permissions required: Administer Jira global permission or Administer Projects project permission for the project that contains the version.
// 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.ProjectVersionsApi;
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");
ProjectVersionsApi apiInstance = new ProjectVersionsApi();
DeleteAndReplaceVersionBean body = new DeleteAndReplaceVersionBean(); // DeleteAndReplaceVersionBean |
String id = "id_example"; // String | The ID of the version.
try {
Object result = apiInstance.deleteAndReplaceVersion(body, id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ProjectVersionsApi#deleteAndReplaceVersion");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
body | DeleteAndReplaceVersionBean | ||
id | String | The ID of the version. |
Object
- Content-Type: application/json
- Accept: application/json
deleteVersion(id, moveFixIssuesTo, moveAffectedIssuesTo)
Delete version
Deletes a project version. Deprecated, use Delete and replace version that supports swapping version values in custom fields, in addition to the swapping for `fixVersion` and `affectedVersion` provided in this resource. Alternative versions can be provided to update issues that use the deleted version in `fixVersion` or `affectedVersion`. If alternatives are not provided, occurrences of `fixVersion` and `affectedVersion` that contain the deleted version are cleared. This operation can be accessed anonymously. Permissions required: Administer Jira global permission or Administer Projects project permission for the project that contains the version.
// 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.ProjectVersionsApi;
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");
ProjectVersionsApi apiInstance = new ProjectVersionsApi();
String id = "id_example"; // String | The ID of the version.
String moveFixIssuesTo = "moveFixIssuesTo_example"; // String | The ID of the version to update `fixVersion` to when the field contains the deleted version. The replacement version must be in the same project as the version being deleted and cannot be the version being deleted.
String moveAffectedIssuesTo = "moveAffectedIssuesTo_example"; // String | The ID of the version to update `affectedVersion` to when the field contains the deleted version. The replacement version must be in the same project as the version being deleted and cannot be the version being deleted.
try {
apiInstance.deleteVersion(id, moveFixIssuesTo, moveAffectedIssuesTo);
} catch (ApiException e) {
System.err.println("Exception when calling ProjectVersionsApi#deleteVersion");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
id | String | The ID of the version. | |
moveFixIssuesTo | String | The ID of the version to update `fixVersion` to when the field contains the deleted version. The replacement version must be in the same project as the version being deleted and cannot be the version being deleted. | [optional] |
moveAffectedIssuesTo | String | The ID of the version to update `affectedVersion` to when the field contains the deleted version. The replacement version must be in the same project as the version being deleted and cannot be the version being deleted. | [optional] |
null (empty response body)
- Content-Type: Not defined
- Accept: Not defined
List<Version> getProjectVersions(projectIdOrKey, expand)
Get project versions
Returns all versions in a project. The response is not paginated. Use Get project versions paginated if you want to get the versions in a project with pagination. This operation can be accessed anonymously. Permissions required: Browse Projects project permission for the project.
// 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.ProjectVersionsApi;
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");
ProjectVersionsApi apiInstance = new ProjectVersionsApi();
String projectIdOrKey = "projectIdOrKey_example"; // String | The project ID or project key (case sensitive).
String expand = "expand_example"; // String | Use [expand](#expansion) to include additional information in the response. This parameter accepts `operations`, which returns actions that can be performed on the version.
try {
List<Version> result = apiInstance.getProjectVersions(projectIdOrKey, expand);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ProjectVersionsApi#getProjectVersions");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
projectIdOrKey | String | The project ID or project key (case sensitive). | |
expand | String | Use expand to include additional information in the response. This parameter accepts `operations`, which returns actions that can be performed on the version. | [optional] |
- Content-Type: Not defined
- Accept: application/json
PageBeanVersion getProjectVersionsPaginated(projectIdOrKey, startAt, maxResults, orderBy, query, status, expand)
Get project versions paginated
Returns a paginated list of all versions in a project. See the Get project versions resource if you want to get a full list of versions without pagination. This operation can be accessed anonymously. Permissions required: Browse Projects project permission for the project.
// 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.ProjectVersionsApi;
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");
ProjectVersionsApi apiInstance = new ProjectVersionsApi();
String projectIdOrKey = "projectIdOrKey_example"; // String | The project ID or project key (case sensitive).
Long startAt = 0L; // Long | The index of the first item to return in a page of results (page offset).
Integer maxResults = 50; // Integer | The maximum number of items to return per page.
String orderBy = "orderBy_example"; // String | [Order](#ordering) the results by a field: * `description` Sorts by version description. * `name` Sorts by version name. * `releaseDate` Sorts by release date, starting with the oldest date. Versions with no release date are listed last. * `sequence` Sorts by the order of appearance in the user interface. * `startDate` Sorts by start date, starting with the oldest date. Versions with no start date are listed last.
String query = "query_example"; // String | Filter the results using a literal string. Versions with matching `name` or `description` are returned (case insensitive).
String status = "status_example"; // String | A list of status values used to filter the results by version status. This parameter accepts a comma-separated list. The status values are `released`, `unreleased`, and `archived`.
String expand = "expand_example"; // String | Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * `issuesstatus` Returns the number of issues in each status category for each version. * `operations` Returns actions that can be performed on the specified version.
try {
PageBeanVersion result = apiInstance.getProjectVersionsPaginated(projectIdOrKey, startAt, maxResults, orderBy, query, status, expand);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ProjectVersionsApi#getProjectVersionsPaginated");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
projectIdOrKey | String | The project ID or project key (case sensitive). | |
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 50] |
orderBy | String | Order the results by a field: * `description` Sorts by version description. * `name` Sorts by version name. * `releaseDate` Sorts by release date, starting with the oldest date. Versions with no release date are listed last. * `sequence` Sorts by the order of appearance in the user interface. * `startDate` Sorts by start date, starting with the oldest date. Versions with no start date are listed last. | [optional] [enum: description, -description, +description, name, -name, +name, releaseDate, -releaseDate, +releaseDate, sequence, -sequence, +sequence, startDate, -startDate, +startDate] |
query | String | Filter the results using a literal string. Versions with matching `name` or `description` are returned (case insensitive). | [optional] |
status | String | A list of status values used to filter the results by version status. This parameter accepts a comma-separated list. The status values are `released`, `unreleased`, and `archived`. | [optional] |
expand | String | Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * `issuesstatus` Returns the number of issues in each status category for each version. * `operations` Returns actions that can be performed on the specified version. | [optional] |
- Content-Type: Not defined
- Accept: application/json
Version getVersion(id, expand)
Get version
Returns a project version. This operation can be accessed anonymously. Permissions required: Browse projects project permission for the project containing the version.
// 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.ProjectVersionsApi;
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");
ProjectVersionsApi apiInstance = new ProjectVersionsApi();
String id = "id_example"; // String | The ID of the version.
String expand = "expand_example"; // String | Use [expand](#expansion) to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include: * `operations` Returns the list of operations available for this version. * `issuesstatus` Returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property represents the number of issues with a status other than *to do*, *in progress*, and *done*.
try {
Version result = apiInstance.getVersion(id, expand);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ProjectVersionsApi#getVersion");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
id | String | The ID of the version. | |
expand | String | Use expand to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include: * `operations` Returns the list of operations available for this version. * `issuesstatus` Returns the count of issues in this version for each of the status categories to do, in progress, done, and unmapped. The unmapped property represents the number of issues with a status other than to do, in progress, and done. | [optional] |
- Content-Type: Not defined
- Accept: application/json
VersionIssueCounts getVersionRelatedIssues(id)
Get version's related issues count
Returns the following counts for a version: * Number of issues where the `fixVersion` is set to the version. * Number of issues where the `affectedVersion` is set to the version. * Number of issues where a version custom field is set to the version. This operation can be accessed anonymously. Permissions required: Browse projects project permission for the project that contains the version.
// 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.ProjectVersionsApi;
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");
ProjectVersionsApi apiInstance = new ProjectVersionsApi();
String id = "id_example"; // String | The ID of the version.
try {
VersionIssueCounts result = apiInstance.getVersionRelatedIssues(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ProjectVersionsApi#getVersionRelatedIssues");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
id | String | The ID of the version. |
- Content-Type: Not defined
- Accept: application/json
VersionUnresolvedIssuesCount getVersionUnresolvedIssues(id)
Get version's unresolved issues count
Returns counts of the issues and unresolved issues for the project version. This operation can be accessed anonymously. Permissions required: Browse projects project permission for the project that contains the version.
// 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.ProjectVersionsApi;
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");
ProjectVersionsApi apiInstance = new ProjectVersionsApi();
String id = "id_example"; // String | The ID of the version.
try {
VersionUnresolvedIssuesCount result = apiInstance.getVersionUnresolvedIssues(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ProjectVersionsApi#getVersionUnresolvedIssues");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
id | String | The ID of the version. |
- Content-Type: Not defined
- Accept: application/json
Object mergeVersions(id, moveIssuesTo)
Merge versions
Merges two project versions. The merge is completed by deleting the version specified in `id` and replacing any occurrences of its ID in `fixVersion` with the version ID specified in `moveIssuesTo`. Consider using Delete and replace version instead. This resource supports swapping version values in `fixVersion`, `affectedVersion`, and custom fields. This operation can be accessed anonymously. Permissions required: Administer Jira global permission or Administer Projects project permission for the project that contains the version.
// 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.ProjectVersionsApi;
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");
ProjectVersionsApi apiInstance = new ProjectVersionsApi();
String id = "id_example"; // String | The ID of the version to delete.
String moveIssuesTo = "moveIssuesTo_example"; // String | The ID of the version to merge into.
try {
Object result = apiInstance.mergeVersions(id, moveIssuesTo);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ProjectVersionsApi#mergeVersions");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
id | String | The ID of the version to delete. | |
moveIssuesTo | String | The ID of the version to merge into. |
Object
- Content-Type: Not defined
- Accept: application/json
Version moveVersion(body, id)
Move version
Modifies the version's sequence within the project, which affects the display order of the versions in Jira. This operation can be accessed anonymously. Permissions required: Browse projects project permission for the project that contains the version.
// 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.ProjectVersionsApi;
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");
ProjectVersionsApi apiInstance = new ProjectVersionsApi();
VersionMoveBean body = new VersionMoveBean(); // VersionMoveBean |
String id = "id_example"; // String | The ID of the version to be moved.
try {
Version result = apiInstance.moveVersion(body, id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ProjectVersionsApi#moveVersion");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
body | VersionMoveBean | ||
id | String | The ID of the version to be moved. |
- Content-Type: application/json
- Accept: application/json
Version updateVersion(body, id)
Update version
Updates a project version. This operation can be accessed anonymously. Permissions required: Administer Jira global permission or Administer Projects project permission for the project that contains the version.
// 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.ProjectVersionsApi;
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");
ProjectVersionsApi apiInstance = new ProjectVersionsApi();
Version body = new Version(); // Version |
String id = "id_example"; // String | The ID of the version.
try {
Version result = apiInstance.updateVersion(body, id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ProjectVersionsApi#updateVersion");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
body | Version | ||
id | String | The ID of the version. |
- Content-Type: application/json
- Accept: application/json