Atlassian: Update related work

Atlassian projectVersions.updateRelatedWork: arguments, response, policy and SDK examples.

← Project versions operations · Get started

Operation atlassian.updaterelatedwork

Provider route: PUT /{cloudId}/rest/api/3/version/{id}/relatedwork. 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"]["updateRelatedWork"]>[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.updateRelatedWork(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_related_work(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 related work — request body — body

Referenced models: Create related work — 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 Create related work — response body

Referenced models: Create related work — response body

Schemas

Create related work — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Associated related work to a version
`category`	JSON	Optional
`category (anyOf 1)`	string	Alternative	The category of the related work
`category (anyOf 2)`	null	Alternative
`issueId`	JSON	Optional
`issueId (anyOf 1)`	JSON	Alternative
`issueId (anyOf 1) (anyOf 1)`	integer	Alternative	The 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)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`issueId (anyOf 2)`	null	Alternative
`relatedWorkId`	JSON	Optional
`relatedWorkId (anyOf 1)`	string	Alternative	The 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)`	null	Alternative
`title`	JSON	Optional
`title (anyOf 1)`	string	Alternative	The title of the related work
`title (anyOf 2)`	null	Alternative
`url`	JSON	Optional
`url (anyOf 1)`	string	Alternative	The 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)`	null	Alternative

Create related work — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Associated related work to a version Additional keys: not allowed
`category`	string	Required within parent	The category of the related work
`issueId`	integer	Optional	The 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
`relatedWorkId`	string	Optional	The 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
`title`	string	Optional	The title of the related work
`url`	string	Optional	The URL of the related work. Will be null for the native release note related work item, but is otherwise required. Format: uri

Policy, approvals and errors

SDK function policy ID: atlassian.updaterelatedwork. Catalog operation: updaterelatedwork. 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: ["write:jira-work"]

Official provider source

Report an issue with this page