POST /rest/api/2/version/{id}/relatedwork
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.
Servers
- https://your-domain.atlassian.net
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
category |
String | Yes |
The category of the related work |
relatedWorkId |
String | No |
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. |
url |
String | No |
The URL of the related work. Will be null for the native release note related work item, but is otherwise required. |
title |
String | No |
The title of the related work |
issueId |
Integer | No |
The ID of the issue associated with the related work (if there is one). Cannot be updated via the Rest API. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.