Skip to content

Atlassian: Project versions schemas

17 Atlassian schemas with complete fields and constraints.

← Project versions operations · All schemas

Create related work — request body — body

FieldTypePresenceDescription and constraints
$objectRootAssociated related work to a version
Additional keys: not allowed
categorystringRequired within parentThe category of the related work
issueIdintegerOptionalThe ID of the issue associated with the related work (if there is one). Cannot be updated via the Rest API.
Format: int64
Read only: true
relatedWorkIdstringOptionalThe id of the related work. For the native release note related work item, this will be null, and Rest API does not support updating it.
Read only: true
titlestringOptionalThe title of the related work
urlstringOptionalThe URL of the related work. Will be null for the native release note related work item, but is otherwise required.
Format: uri

Create related work — response body

FieldTypePresenceDescription and constraints
$objectRootAssociated related work to a version
categoryJSONOptional
category (anyOf 1)stringAlternativeThe category of the related work
category (anyOf 2)nullAlternative
issueIdJSONOptional
issueId (anyOf 1)JSONAlternative
issueId (anyOf 1) (anyOf 1)integerAlternativeThe ID of the issue associated with the related work (if there is one). Cannot be updated via the Rest API.
Format: int64
Read only: true
issueId (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
issueId (anyOf 2)nullAlternative
relatedWorkIdJSONOptional
relatedWorkId (anyOf 1)stringAlternativeThe id of the related work. For the native release note related work item, this will be null, and Rest API does not support updating it.
Read only: true
relatedWorkId (anyOf 2)nullAlternative
titleJSONOptional
title (anyOf 1)stringAlternativeThe title of the related work
title (anyOf 2)nullAlternative
urlJSONOptional
url (anyOf 1)stringAlternativeThe URL of the related work. Will be null for the native release note related work item, but is otherwise required.
Format: uri
url (anyOf 2)nullAlternative

Create version — request body — body

FieldTypePresenceDescription and constraints
$objectRootDetails about a project version.
Additional keys: not allowed
approversarrayOptionalIf the expand option `approvers` is used, returns a list containing the approvers for this version.
Read only: true
approvers[]ModelEach itemExpand Create version — request body — body approvers item
archivedbooleanOptionalIndicates that the version is archived. Optional when creating or updating a version.
descriptionstringOptionalThe description of the version. Optional when creating or updating a version. The maximum size is 16,384 bytes.
driverstringOptionalThe Atlassian account ID of the version driver. Optional when creating or updating a version. If the expand option `driver` is used, returns the Atlassian account ID of the driver.
expandstringOptionalUse [expand](em>#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 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.
idstringOptionalThe ID of the version.
Read only: true
issuesStatusForFixVersionModelOptionalExpand Create version — request body — body issues Status For Fix Version
If the expand option `issuesstatus` is used, 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*.
Read only: true
moveUnfixedIssuesTostringOptionalThe 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.
Format: uri
namestringOptionalThe unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters.
operationsarrayOptionalIf the expand option `operations` is used, returns the list of operations available for this version.
Read only: true
operations[]ModelEach itemExpand Create version — request body — body operations item
overduebooleanOptionalIndicates that the version is overdue.
Read only: true
projectstringOptionalDeprecated. Use `projectId`.
projectIdintegerOptionalThe ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version.
Format: int64
releaseDatestringOptionalThe release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.
Format: date
releasedbooleanOptionalIndicates 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.
selfstringOptionalThe URL of the version.
Format: uri
Read only: true
startDatestringOptionalThe start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.
Format: date
userReleaseDatestringOptionalThe date on which work on this version is expected to finish, expressed in the instance's *Day/Month/Year Format* date format.
Read only: true
userStartDatestringOptionalThe date on which work on this version is expected to start, expressed in the instance's *Day/Month/Year Format* date format.
Read only: true

Referenced models: Create version — request body — body operations item, Create version — request body — body approvers item, Create version — request body — body issues Status For Fix Version

Create version — request body — body approvers item

FieldTypePresenceDescription and constraints
$objectRootContains details about a version approver.
Additional keys: allowed
accountIdstringOptionalThe Atlassian account ID of the approver.
Read only: true
declineReasonstringOptionalA description of why the user is declining the approval.
Read only: true
descriptionstringOptionalA description of what the user is approving within the specified version.
Read only: true
statusstringOptionalThe status of the approval, which can be *PENDING*, *APPROVED*, or *DECLINED*
Read only: true

Create version — request body — body issues Status For Fix Version

FieldTypePresenceDescription and constraints
$objectRootCounts of the number of issues in various statuses.
Additional keys: allowed
doneintegerOptionalCount of issues with status *done*.
Format: int64
Read only: true
inProgressintegerOptionalCount of issues with status *in progress*.
Format: int64
Read only: true
toDointegerOptionalCount of issues with status *to do*.
Format: int64
Read only: true
unmappedintegerOptionalCount of issues with a status other than *to do*, *in progress*, and *done*.
Format: int64
Read only: true

Create version — request body — body operations item

FieldTypePresenceDescription and constraints
$objectRootDetails about the operations available in this version.
Additional keys: not allowed
hrefstringOptional
iconClassstringOptional
idstringOptional
labelstringOptional
styleClassstringOptional
titlestringOptional
weightintegerOptionalFormat: int32

Delete and replace version — request body — body

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
customFieldReplacementListarrayOptionalAn array of custom field IDs (`customFieldId`) and version IDs (`moveTo`) to update when the fields contain the deleted version.
customFieldReplacementList[]ModelEach itemExpand Delete and replace version — request body — body custom Field Replacement List item
moveAffectedIssuesTointegerOptionalThe ID of the version to update `affectedVersion` to when the field contains the deleted version.
Format: int64
moveFixIssuesTointegerOptionalThe ID of the version to update `fixVersion` to when the field contains the deleted version.
Format: int64

Referenced models: Delete and replace version — request body — body custom Field Replacement List item

Delete and replace version — request body — body custom Field Replacement List item

FieldTypePresenceDescription and constraints
$objectRootDetails about the replacement for a deleted version.
Additional keys: not allowed
customFieldIdintegerOptionalThe ID of the custom field in which to replace the version number.
Format: int64
moveTointegerOptionalThe version number to use as a replacement for the deleted version.
Format: int64

Get project versions paginated — response body

FieldTypePresenceDescription and constraints
$objectRootA page of items.
isLastJSONOptional
isLast (anyOf 1)booleanAlternativeWhether this is the last page.
Read only: true
isLast (anyOf 2)nullAlternative
maxResultsJSONOptional
maxResults (anyOf 1)JSONAlternative
maxResults (anyOf 1) (anyOf 1)integerAlternativeThe maximum number of items that could be returned.
Format: int32
Read only: true
maxResults (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
maxResults (anyOf 2)nullAlternative
nextPageJSONOptional
nextPage (anyOf 1)stringAlternativeIf there is another page of results, the URL of the next page.
Format: uri
Read only: true
nextPage (anyOf 2)nullAlternative
selfJSONOptional
self (anyOf 1)stringAlternativeThe URL of the page.
Format: uri
Read only: true
self (anyOf 2)nullAlternative
startAtJSONOptional
startAt (anyOf 1)JSONAlternative
startAt (anyOf 1) (anyOf 1)integerAlternativeThe index of the first item returned.
Format: int64
Read only: true
startAt (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
startAt (anyOf 2)nullAlternative
totalJSONOptional
total (anyOf 1)JSONAlternative
total (anyOf 1) (anyOf 1)integerAlternativeThe number of items returned.
Format: int64
Read only: true
total (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total (anyOf 2)nullAlternative
valuesJSONOptional
values (anyOf 1)arrayAlternativeThe list of items.
Read only: true
values (anyOf 1)[]ModelEach itemExpand Get version — response body
values (anyOf 2)nullAlternative

Referenced models: Get version — response body

Get version — response body

FieldTypePresenceDescription and constraints
$objectRootDetails about a project version.
approversJSONOptional
approvers (anyOf 1)arrayAlternativeIf the expand option `approvers` is used, returns a list containing the approvers for this version.
Read only: true
approvers (anyOf 1)[]ModelEach itemExpand Get version — response body — approvers array item
approvers (anyOf 2)nullAlternative
archivedJSONOptional
archived (anyOf 1)booleanAlternativeIndicates that the version is archived. Optional when creating or updating a version.
archived (anyOf 2)nullAlternative
descriptionJSONOptional
description (anyOf 1)stringAlternativeThe description of the version. Optional when creating or updating a version. The maximum size is 16,384 bytes.
description (anyOf 2)nullAlternative
driverJSONOptional
driver (anyOf 1)stringAlternativeThe Atlassian account ID of the version driver. Optional when creating or updating a version. If the expand option `driver` is used, returns the Atlassian account ID of the driver.
driver (anyOf 2)nullAlternative
expandJSONOptional
expand (anyOf 1)stringAlternativeUse [expand](em>#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 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.
expand (anyOf 2)nullAlternative
idJSONOptional
id (anyOf 1)stringAlternativeThe ID of the version.
Read only: true
id (anyOf 2)nullAlternative
issuesStatusForFixVersionJSONOptional
issuesStatusForFixVersion (anyOf 1)ModelAlternativeExpand Get version — response body — issues Status For Fix Version Counts of the number of issues in various statuses
If the expand option `issuesstatus` is used, 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*.
Read only: true
issuesStatusForFixVersion (anyOf 2)nullAlternative
moveUnfixedIssuesToJSONOptional
moveUnfixedIssuesTo (anyOf 1)stringAlternativeThe 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.
Format: uri
moveUnfixedIssuesTo (anyOf 2)nullAlternative
nameJSONOptional
name (anyOf 1)stringAlternativeThe unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters.
name (anyOf 2)nullAlternative
operationsJSONOptional
operations (anyOf 1)arrayAlternativeIf the expand option `operations` is used, returns the list of operations available for this version.
Read only: true
operations (anyOf 1)[]ModelEach itemExpand Get version — response body — operations array item
operations (anyOf 2)nullAlternative
overdueJSONOptional
overdue (anyOf 1)booleanAlternativeIndicates that the version is overdue.
Read only: true
overdue (anyOf 2)nullAlternative
projectJSONOptional
project (anyOf 1)stringAlternativeDeprecated. Use `projectId`.
project (anyOf 2)nullAlternative
projectIdJSONOptional
projectId (anyOf 1)JSONAlternative
projectId (anyOf 1) (anyOf 1)integerAlternativeThe ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version.
Format: int64
projectId (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
projectId (anyOf 2)nullAlternative
releaseDateJSONOptional
releaseDate (anyOf 1)JSONAlternative
releaseDate (anyOf 1) (anyOf 1)stringAlternativeThe release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.
releaseDate (anyOf 1) (anyOf 2)integerAlternative
releaseDate (anyOf 2)nullAlternative
releasedJSONOptional
released (anyOf 1)booleanAlternativeIndicates 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.
released (anyOf 2)nullAlternative
selfJSONOptional
self (anyOf 1)stringAlternativeThe URL of the version.
Format: uri
Read only: true
self (anyOf 2)nullAlternative
startDateJSONOptional
startDate (anyOf 1)JSONAlternative
startDate (anyOf 1) (anyOf 1)stringAlternativeThe start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.
startDate (anyOf 1) (anyOf 2)integerAlternative
startDate (anyOf 2)nullAlternative
userReleaseDateJSONOptional
userReleaseDate (anyOf 1)stringAlternativeThe date on which work on this version is expected to finish, expressed in the instance's *Day/Month/Year Format* date format.
Read only: true
userReleaseDate (anyOf 2)nullAlternative
userStartDateJSONOptional
userStartDate (anyOf 1)stringAlternativeThe date on which work on this version is expected to start, expressed in the instance's *Day/Month/Year Format* date format.
Read only: true
userStartDate (anyOf 2)nullAlternative

Referenced models: Get version — response body — operations array item, Get version — response body — approvers array item, Get version — response body — issues Status For Fix Version Counts of the number of issues in various statuses

Get version — response body — approvers array item

FieldTypePresenceDescription and constraints
$objectRootContains details about a version approver.
Additional keys: allowed
accountIdJSONOptional
accountId (anyOf 1)stringAlternativeThe Atlassian account ID of the approver.
Read only: true
accountId (anyOf 2)nullAlternative
declineReasonJSONOptional
declineReason (anyOf 1)stringAlternativeA description of why the user is declining the approval.
Read only: true
declineReason (anyOf 2)nullAlternative
descriptionJSONOptional
description (anyOf 1)stringAlternativeA description of what the user is approving within the specified version.
Read only: true
description (anyOf 2)nullAlternative
statusJSONOptional
status (anyOf 1)stringAlternativeThe status of the approval, which can be *PENDING*, *APPROVED*, or *DECLINED*
Read only: true
status (anyOf 2)nullAlternative

Get version — response body — issues Status For Fix Version Counts of the number of issues in various statuses

FieldTypePresenceDescription and constraints
$objectRootCounts of the number of issues in various statuses.
Additional keys: allowed
doneJSONOptional
done (anyOf 1)JSONAlternative
done (anyOf 1) (anyOf 1)integerAlternativeCount of issues with status *done*.
Format: int64
Read only: true
done (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
done (anyOf 2)nullAlternative
inProgressJSONOptional
inProgress (anyOf 1)JSONAlternative
inProgress (anyOf 1) (anyOf 1)integerAlternativeCount of issues with status *in progress*.
Format: int64
Read only: true
inProgress (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
inProgress (anyOf 2)nullAlternative
toDoJSONOptional
toDo (anyOf 1)JSONAlternative
toDo (anyOf 1) (anyOf 1)integerAlternativeCount of issues with status *to do*.
Format: int64
Read only: true
toDo (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
toDo (anyOf 2)nullAlternative
unmappedJSONOptional
unmapped (anyOf 1)JSONAlternative
unmapped (anyOf 1) (anyOf 1)integerAlternativeCount of issues with a status other than *to do*, *in progress*, and *done*.
Format: int64
Read only: true
unmapped (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
unmapped (anyOf 2)nullAlternative

Get version — response body — operations array item

FieldTypePresenceDescription and constraints
$objectRootDetails about the operations available in this version.
hrefJSONOptional
href (anyOf 1)stringAlternative
href (anyOf 2)nullAlternative
iconClassJSONOptional
iconClass (anyOf 1)stringAlternative
iconClass (anyOf 2)nullAlternative
idJSONOptional
id (anyOf 1)stringAlternative
id (anyOf 2)nullAlternative
labelJSONOptional
label (anyOf 1)stringAlternative
label (anyOf 2)nullAlternative
styleClassJSONOptional
styleClass (anyOf 1)stringAlternative
styleClass (anyOf 2)nullAlternative
titleJSONOptional
title (anyOf 1)stringAlternative
title (anyOf 2)nullAlternative
weightJSONOptional
weight (anyOf 1)JSONAlternative
weight (anyOf 1) (anyOf 1)integerAlternativeFormat: int32
weight (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
weight (anyOf 2)nullAlternative

Get version's related issues count — response body

FieldTypePresenceDescription and constraints
$objectRootVarious counts of issues within a version.
customFieldUsageJSONOptional
customFieldUsage (anyOf 1)arrayAlternativeList of custom fields using the version.
Read only: true
customFieldUsage (anyOf 1)[]ModelEach itemExpand Get version's related issues count — response body — custom Field Usage List of custom fields using the version item
customFieldUsage (anyOf 2)nullAlternative
issueCountWithCustomFieldsShowingVersionJSONOptional
issueCountWithCustomFieldsShowingVersion (anyOf 1)JSONAlternative
issueCountWithCustomFieldsShowingVersion (anyOf 1) (anyOf 1)integerAlternativeCount of issues where a version custom field is set to the version.
Format: int64
Read only: true
issueCountWithCustomFieldsShowingVersion (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
issueCountWithCustomFieldsShowingVersion (anyOf 2)nullAlternative
issuesAffectedCountJSONOptional
issuesAffectedCount (anyOf 1)JSONAlternative
issuesAffectedCount (anyOf 1) (anyOf 1)integerAlternativeCount of issues where the `affectedVersion` is set to the version.
Format: int64
Read only: true
issuesAffectedCount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
issuesAffectedCount (anyOf 2)nullAlternative
issuesFixedCountJSONOptional
issuesFixedCount (anyOf 1)JSONAlternative
issuesFixedCount (anyOf 1) (anyOf 1)integerAlternativeCount of issues where the `fixVersion` is set to the version.
Format: int64
Read only: true
issuesFixedCount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
issuesFixedCount (anyOf 2)nullAlternative
selfJSONOptional
self (anyOf 1)stringAlternativeThe URL of these count details.
Format: uri
Read only: true
self (anyOf 2)nullAlternative

Referenced models: Get version's related issues count — response body — custom Field Usage List of custom fields using the version item

Get version's related issues count — response body — custom Field Usage List of custom fields using the version item

FieldTypePresenceDescription and constraints
$objectRootList of custom fields using the version.
customFieldIdJSONOptional
customFieldId (anyOf 1)JSONAlternative
customFieldId (anyOf 1) (anyOf 1)integerAlternativeThe ID of the custom field.
Format: int64
Read only: true
customFieldId (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
customFieldId (anyOf 2)nullAlternative
fieldNameJSONOptional
fieldName (anyOf 1)stringAlternativeThe name of the custom field.
Read only: true
fieldName (anyOf 2)nullAlternative
issueCountWithVersionInCustomFieldJSONOptional
issueCountWithVersionInCustomField (anyOf 1)JSONAlternative
issueCountWithVersionInCustomField (anyOf 1) (anyOf 1)integerAlternativeCount of the issues where the custom field contains the version.
Format: int64
Read only: true
issueCountWithVersionInCustomField (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
issueCountWithVersionInCustomField (anyOf 2)nullAlternative

Get version's unresolved issues count — response body

FieldTypePresenceDescription and constraints
$objectRootCount of a version's unresolved issues.
issuesCountJSONOptional
issuesCount (anyOf 1)JSONAlternative
issuesCount (anyOf 1) (anyOf 1)integerAlternativeCount of issues.
Format: int64
Read only: true
issuesCount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
issuesCount (anyOf 2)nullAlternative
issuesUnresolvedCountJSONOptional
issuesUnresolvedCount (anyOf 1)JSONAlternative
issuesUnresolvedCount (anyOf 1) (anyOf 1)integerAlternativeCount of unresolved issues.
Format: int64
Read only: true
issuesUnresolvedCount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
issuesUnresolvedCount (anyOf 2)nullAlternative
selfJSONOptional
self (anyOf 1)stringAlternativeThe URL of these count details.
Format: uri
Read only: true
self (anyOf 2)nullAlternative

Move version — request body — body

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
afterstringOptionalThe URL (self link) of the version after which to place the moved version. Cannot be used with `position`.
Format: uri
positionstringOptionalAn absolute position in which to place the moved version. Cannot be used with `after`.
One of: Earlier, Later, First, Last

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.