jira.js
    Preparing search index...

    Function updateRemoteIssueLink

    • Updates a remote issue link for an issue.

      Note: Fields without values in the request are set to null.

      This operation requires issue linking to be active.

      This operation can be accessed anonymously.

      Permissions required:

      Parameters

      • client: Client
      • parameters: {
            application?: { name?: string; type?: string; [key: string]: unknown };
            globalId?: string;
            issueIdOrKey: string;
            linkId: string;
            object?: {
                icon?: {
                    link?: string;
                    title?: string;
                    url16x16?: string;
                    [key: string]: unknown;
                };
                status?: {
                    icon?: {
                        link?: string;
                        title?: string;
                        url16x16?: string;
                        [key: string]: unknown;
                    };
                    resolved?: boolean;
                    [key: string]: unknown;
                };
                summary?: string;
                title: string;
                url: string;
                [key: string]: unknown;
            };
            relationship?: string;
        }
        • Optionalapplication?: { name?: string; type?: string; [key: string]: unknown }
          • Optionalname?: string

            The name of the application. Used in conjunction with the (remote) object icon title to display a tooltip for the link's icon. The tooltip takes the format "[application name] icon title". Blank items are excluded from the tooltip title. If both items are blank, the icon tooltop displays as "Web Link". Grouping and sorting of links may place links without an application name last.

          • Optionaltype?: string

            The name-spaced type of the application, used by registered rendering apps.

        • OptionalglobalId?: string

          An identifier for the remote item in the remote system. For example, the global ID for a remote item in Confluence would consist of the app ID and page ID, like this: appId=456&pageId=123.

          Setting this field enables the remote issue link details to be updated or deleted using remote system and item details as the record identifier, rather than using the record's Jira ID.

          The maximum length is 255 characters.

        • issueIdOrKey: string

          The ID or key of the issue.

        • linkId: string

          The ID of the remote issue link.

        • Optionalobject?: {
              icon?: {
                  link?: string;
                  title?: string;
                  url16x16?: string;
                  [key: string]: unknown;
              };
              status?: {
                  icon?: {
                      link?: string;
                      title?: string;
                      url16x16?: string;
                      [key: string]: unknown;
                  };
                  resolved?: boolean;
                  [key: string]: unknown;
              };
              summary?: string;
              title: string;
              url: string;
              [key: string]: unknown;
          }
          • Optionalicon?: { link?: string; title?: string; url16x16?: string; [key: string]: unknown }
            • Optionallink?: string

              The URL of the tooltip, used only for a status icon. If not set, the status icon in Jira is not clickable.

            • Optionaltitle?: string

              The title of the icon. This is used as follows:

              • For a status icon it is used as a tooltip on the icon. If not set, the status icon doesn't display a tooltip in Jira.
              • For the remote object icon it is used in conjunction with the application name to display a tooltip for the link's icon. The tooltip takes the format "[application name] icon title". Blank itemsare excluded from the tooltip title. If both items are blank, the icon tooltop displays as "Web Link".
            • Optionalurl16x16?: string

              The URL of an icon that displays at 16x16 pixel in Jira.

          • Optionalstatus?: {
                icon?: {
                    link?: string;
                    title?: string;
                    url16x16?: string;
                    [key: string]: unknown;
                };
                resolved?: boolean;
                [key: string]: unknown;
            }
            • Optionalicon?: { link?: string; title?: string; url16x16?: string; [key: string]: unknown }
              • Optionallink?: string

                The URL of the tooltip, used only for a status icon. If not set, the status icon in Jira is not clickable.

              • Optionaltitle?: string

                The title of the icon. This is used as follows:

                • For a status icon it is used as a tooltip on the icon. If not set, the status icon doesn't display a tooltip in Jira.
                • For the remote object icon it is used in conjunction with the application name to display a tooltip for the link's icon. The tooltip takes the format "[application name] icon title". Blank itemsare excluded from the tooltip title. If both items are blank, the icon tooltop displays as "Web Link".
              • Optionalurl16x16?: string

                The URL of an icon that displays at 16x16 pixel in Jira.

            • Optionalresolved?: boolean

              Whether the item is resolved. If set to "true", the link to the issue is displayed in a strikethrough font, otherwise the link displays in normal font.

          • Optionalsummary?: string

            The summary details of the item.

          • title: string

            The title of the item.

          • url: string

            The URL of the item.

        • Optionalrelationship?: string

          Description of the relationship between the issue and the linked item. If not set, the relationship description "links to" is used in Jira.

      • Optionaloptions: RequestOptions

      Returns Promise<void>