POST /rest/api/2/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.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
projectId Integer No

The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version.

driver String No

If the expand option driver is used, returns the Atlassian account ID of the driver.

overdue Boolean No

Indicates that the version is overdue.

approvers[] Array No

If the expand option approvers is used, returns a list containing the approvers for this version.

approvers[].accountId String No

The Atlassian account ID of the approver.

approvers[].description String No

A description of what the user is approving within the specified version.

approvers[].status String No

The status of the approval, which can be PENDING, APPROVED, or DECLINED

approvers[].declineReason String No

A description of why the user is declining the approval.

archived Boolean No

Indicates that the version is archived. Optional when creating or updating a version.

description String No

The description of the version. Optional when creating or updating a version. The maximum size is 16,384 bytes.

userStartDate String No

The date on which work on this version is expected to start, expressed in the instance's Day/Month/Year Format date format.

expand String No

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 contains a count of issues with a status other than to do, in progress, and done.
  • driver Returns the Atlassian account ID of the version driver.
  • approvers Returns a list containing approvers for this version.

Optional for create and update.

startDate String No

The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.

userReleaseDate String No

The date on which work on this version is expected to finish, expressed in the instance's Day/Month/Year Format date format.

id String No

The ID of the version.

released Boolean No

Indicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version. Optional when updating a version.

moveUnfixedIssuesTo String No

The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not applicable when creating a version. Optional when updating a version.

name String No

The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters.

self String No

The URL of the version.

releaseDate String No

The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.

operations[] Array No

If the expand option operations is used, returns the list of operations available for this version.

operations[].id String No
operations[].href String No
operations[].iconClass String No
operations[].label String No
operations[].styleClass String No
operations[].title String No
operations[].weight Integer No
project String No

Deprecated. Use projectId.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.