jira.js
    Preparing search index...

    Function addWorklog

    • Adds a new worklog entry to an issue.

      Parameters

      • client: Client
      • parameters: {
            adjustEstimate?: string;
            author?: {
                active?: boolean;
                avatarUrls?: Record<string, string>;
                displayName?: string;
                emailAddress?: string;
                key?: string;
                name?: string;
                self?: string;
                timeZone?: string;
                [key: string]: unknown;
            };
            comment?: string;
            created?: string;
            id?: string;
            issueId?: string;
            issueIdOrKey: string;
            newEstimate?: string;
            reduceBy?: string;
            self?: string;
            started?: string;
            timeSpent?: string;
            timeSpentSeconds?: number;
            updateAuthor?: {
                active?: boolean;
                avatarUrls?: Record<string, string>;
                displayName?: string;
                emailAddress?: string;
                key?: string;
                name?: string;
                self?: string;
                timeZone?: string;
                [key: string]: unknown;
            };
            updated?: string;
            visibility?: {
                type?: "role"
                | "group"
                | string & {};
                value?: string;
                [key: string]: unknown;
            };
        }
        • OptionaladjustEstimate?: string

          Allows you to provide specific instructions to update the remaining time estimate of the issue. Valid values are: new, leave, manual, auto

        • Optionalauthor?: {
              active?: boolean;
              avatarUrls?: Record<string, string>;
              displayName?: string;
              emailAddress?: string;
              key?: string;
              name?: string;
              self?: string;
              timeZone?: string;
              [key: string]: unknown;
          }
        • Optionalcomment?: string
        • Optionalcreated?: string
        • Optionalid?: string
        • OptionalissueId?: string
        • issueIdOrKey: string

          A string containing the issue id or key the worklog will be added to

        • OptionalnewEstimate?: string

          Required when 'new' is selected for adjustEstimate. e.g. "2d"

        • OptionalreduceBy?: string

          Required when 'manual' is selected for adjustEstimate. e.g. "2d"

        • Optionalself?: string
        • Optionalstarted?: string
        • OptionaltimeSpent?: string
        • OptionaltimeSpentSeconds?: number
        • OptionalupdateAuthor?: {
              active?: boolean;
              avatarUrls?: Record<string, string>;
              displayName?: string;
              emailAddress?: string;
              key?: string;
              name?: string;
              self?: string;
              timeZone?: string;
              [key: string]: unknown;
          }
        • Optionalupdated?: string
        • Optionalvisibility?: {
              type?: "role" | "group" | string & {};
              value?: string;
              [key: string]: unknown;
          }
      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              author?: {
                  active?: boolean;
                  avatarUrls?: Record<string, string>;
                  displayName?: string;
                  emailAddress?: string;
                  key?: string;
                  name?: string;
                  self?: string;
                  timeZone?: string;
                  [key: string]: unknown;
              };
              comment?: string;
              created?: string;
              id?: string;
              issueId?: string;
              self?: string;
              started?: string;
              timeSpent?: string;
              timeSpentSeconds?: number;
              updateAuthor?: {
                  active?: boolean;
                  avatarUrls?: Record<string, string>;
                  displayName?: string;
                  emailAddress?: string;
                  key?: string;
                  name?: string;
                  self?: string;
                  timeZone?: string;
                  [key: string]: unknown;
              };
              updated?: string;
              visibility?: {
                  type?: "role"
                  | "group"
                  | string & {};
                  value?: string;
                  [key: string]: unknown;
              };
              [key: string]: unknown;
          },
      >