Project versions

Create related work

Changed on

Creates a related work for the given version. You can only create a generic link type of related works via this API. relatedWorkId will be auto-generated UUID, that does not need to be provided.

This operation can be accessed anonymously.

Permissions required: Resolve issues: and Edit issues Managing project permissions for the project that contains the version.

post/rest/api/3/version/{id}/relatedwork

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/rest/api/3/version/{id}/relatedwork
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: write:jira-work
    • or none

Path parameters

idstring required

Request body

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.

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

  • 6abe311e7b55Revision changes
    • info

      the request optional property became not read-only

    • info

      the request optional property became not read-only

    • info

      the request required property became not read-only

    • info

      the response optional property became not read-only for the status

    • info

      the response optional property became not read-only for the status

    • info

      the response required property became not read-only for the status