jira.js
    Preparing search index...

    Function updateRelatedWork

    • 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

      • client: Client
      • parameters: {
            category: string;
            id: string;
            issueId?: number;
            relatedWorkId?: string;
            title?: string;
            url?: string;
        }
        • category: string

          The category of the related work

        • id: string

          The ID of the version to update the related work on. For the related work id, pass it to the input JSON.

        • OptionalissueId?: number

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

        • OptionalrelatedWorkId?: 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.

        • Optionaltitle?: string

          The title of the related work

        • Optionalurl?: string

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

      • Optionaloptions: RequestOptions

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

    Settings
    Member Visibility