Function: updateRelatedWork()

function updateRelatedWork(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  category: string;
  issueId?: number;
  relatedWorkId?: string;
  title?: string;
  url?: string;
}>;

Defined in: src/cloud/api/projectVersions.ts:325

Updates the given related work. You can only update generic link related works via Rest APIs. Any archived version related works can't be edited.

This operation can be accessed anonymously.

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

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ category: string; id: string; issueId?: number; relatedWorkId?: string; title?: string; url?: string; }	-
parameters.category	string	The category of the related work
parameters.id?	string	The ID of the version to update the related work on. For the related work id, pass it to the input JSON.
parameters.issueId?	number	The ID of the issue associated with the related work (if there is one). Cannot be updated via the Rest API.
parameters.relatedWorkId?	string	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.
parameters.title?	string	The title of the related work
parameters.url?	string	The URL of the related work. Will be null for the native release note related work item, but is otherwise required.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; category: string; issueId?: number; relatedWorkId?: string; title?: string; url?: string; }>