Project versions

Get related work

Returns related work items for the given version id.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission for the project containing the version.

get/rest/api/2/version/{id}/relatedwork

Request

  • Base URL: https://your-domain.atlassian.net
  • URL: https://your-domain.atlassian.net/rest/api/2/version/{id}/relatedwork
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://auth.atlassian.com/authorize, token URL https://auth.atlassian.com/oauth/token, scopes: read:jira-work)
    • none

Path parameters

idstring required

The ID of the version.

Response

Returned if the request is successful.

categorystring required

The category of the related work

issueIdinteger

The ID of the issue associated with the related work (if there is one). Cannot be updated via the Rest API.

relatedWorkIdstring

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.

titlestring

The title of the related work

urlstring uri

The URL of the related work. Will be null for the native release note related work item, but is otherwise required.

Changes

No recorded changes to this operation across all 26 revisions of this API.