Atlassian: Update version

← Project versions operations · Get started

Operation atlassian.updateversion

Provider route: PUT /{cloudId}/rest/api/3/version/{id}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/atlassian with npm, or alter-sdk-atlassian with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { AtlassianIntegration } from "@alter-ai/atlassian";

async function execute(input: Parameters<AtlassianIntegration["projectVersions"]["updateVersion"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new AtlassianIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.projectVersions.updateVersion(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_atlassian import AtlassianIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = AtlassianIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.project_versions.update_version(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.cloudId	string	Required within parent	Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
path.id	string	Required within parent
body	Model	Required within parent	Expand Create version — request body — body

Referenced models: Create version — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Get version — response body

Referenced models: Get version — response body

Schemas

5 more schemas are linked from the tables above, on the schema pages.

Get version — response body

Field	Type	Presence	Description and constraints
$	object	Root	Details about a project version.
approvers	JSON	Optional
approvers (anyOf 1)	array	Alternative	If the expand option `approvers` is used, returns a list containing the approvers for this version. Read only: true
approvers (anyOf 1)[]	Model	Each item	Expand Get version — response body — approvers array item
approvers (anyOf 2)	null	Alternative
archived	JSON	Optional
archived (anyOf 1)	boolean	Alternative	Indicates that the version is archived. Optional when creating or updating a version.
archived (anyOf 2)	null	Alternative
description	JSON	Optional
description (anyOf 1)	string	Alternative	The description of the version. Optional when creating or updating a version. The maximum size is 16,384 bytes.
description (anyOf 2)	null	Alternative
driver	JSON	Optional
driver (anyOf 1)	string	Alternative	The 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)	null	Alternative
expand	JSON	Optional
expand (anyOf 1)	string	Alternative	Use [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)	null	Alternative
id	JSON	Optional
id (anyOf 1)	string	Alternative	The ID of the version. Read only: true
id (anyOf 2)	null	Alternative
issuesStatusForFixVersion	JSON	Optional
issuesStatusForFixVersion (anyOf 1)	Model	Alternative	Expand 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)	null	Alternative
moveUnfixedIssuesTo	JSON	Optional
moveUnfixedIssuesTo (anyOf 1)	string	Alternative	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. Format: uri
moveUnfixedIssuesTo (anyOf 2)	null	Alternative
name	JSON	Optional
name (anyOf 1)	string	Alternative	The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters.
name (anyOf 2)	null	Alternative
operations	JSON	Optional
operations (anyOf 1)	array	Alternative	If the expand option `operations` is used, returns the list of operations available for this version. Read only: true
operations (anyOf 1)[]	Model	Each item	Expand Get version — response body — operations array item
operations (anyOf 2)	null	Alternative
overdue	JSON	Optional
overdue (anyOf 1)	boolean	Alternative	Indicates that the version is overdue. Read only: true
overdue (anyOf 2)	null	Alternative
project	JSON	Optional
project (anyOf 1)	string	Alternative	Deprecated. Use `projectId`.
project (anyOf 2)	null	Alternative
projectId	JSON	Optional
projectId (anyOf 1)	JSON	Alternative
projectId (anyOf 1) (anyOf 1)	integer	Alternative	The 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)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
projectId (anyOf 2)	null	Alternative
releaseDate	JSON	Optional
releaseDate (anyOf 1)	JSON	Alternative
releaseDate (anyOf 1) (anyOf 1)	string	Alternative	The 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)	integer	Alternative
releaseDate (anyOf 2)	null	Alternative
released	JSON	Optional
released (anyOf 1)	boolean	Alternative	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.
released (anyOf 2)	null	Alternative
self	JSON	Optional
self (anyOf 1)	string	Alternative	The URL of the version. Format: uri Read only: true
self (anyOf 2)	null	Alternative
startDate	JSON	Optional
startDate (anyOf 1)	JSON	Alternative
startDate (anyOf 1) (anyOf 1)	string	Alternative	The 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)	integer	Alternative
startDate (anyOf 2)	null	Alternative
userReleaseDate	JSON	Optional
userReleaseDate (anyOf 1)	string	Alternative	The 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)	null	Alternative
userStartDate	JSON	Optional
userStartDate (anyOf 1)	string	Alternative	The 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)	null	Alternative

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 — operations array item

Field	Type	Presence	Description and constraints
$	object	Root	Details about the operations available in this version.
href	JSON	Optional
href (anyOf 1)	string	Alternative
href (anyOf 2)	null	Alternative
iconClass	JSON	Optional
iconClass (anyOf 1)	string	Alternative
iconClass (anyOf 2)	null	Alternative
id	JSON	Optional
id (anyOf 1)	string	Alternative
id (anyOf 2)	null	Alternative
label	JSON	Optional
label (anyOf 1)	string	Alternative
label (anyOf 2)	null	Alternative
styleClass	JSON	Optional
styleClass (anyOf 1)	string	Alternative
styleClass (anyOf 2)	null	Alternative
title	JSON	Optional
title (anyOf 1)	string	Alternative
title (anyOf 2)	null	Alternative
weight	JSON	Optional
weight (anyOf 1)	JSON	Alternative
weight (anyOf 1) (anyOf 1)	integer	Alternative	Format: int32
weight (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
weight (anyOf 2)	null	Alternative

Get version — response body — approvers array item

Field	Type	Presence	Description and constraints
$	object	Root	Contains details about a version approver. Additional keys: allowed
accountId	JSON	Optional
accountId (anyOf 1)	string	Alternative	The Atlassian account ID of the approver. Read only: true
accountId (anyOf 2)	null	Alternative
declineReason	JSON	Optional
declineReason (anyOf 1)	string	Alternative	A description of why the user is declining the approval. Read only: true
declineReason (anyOf 2)	null	Alternative
description	JSON	Optional
description (anyOf 1)	string	Alternative	A description of what the user is approving within the specified version. Read only: true
description (anyOf 2)	null	Alternative
status	JSON	Optional
status (anyOf 1)	string	Alternative	The status of the approval, which can be *PENDING*, *APPROVED*, or *DECLINED* Read only: true
status (anyOf 2)	null	Alternative

Policy, approvals and errors

SDK function policy ID: atlassian.updateversion. Catalog operation: updateversion. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["manage:jira-project"]

Official provider source