Function addWorklog

addWorklog(
    client: Client,
    parameters: {
        adjustEstimate?: "auto" | "manual" | "new" | string & {} | "leave";
        author?: {
            accountId?: string;
            accountType?: string;
            active?: boolean;
            avatarUrls?: {
                "16x16"?: string;
                "24x24"?: string;
                "32x32"?: string;
                "48x48"?: string;
                [key: string]: unknown;
            };
            displayName?: string;
            emailAddress?: string;
            self?: string;
            timeZone?: string;
            [key: string]: unknown;
        };
        comment?: | string
        | {
            content: Record<string, any>[];
            type: string & {} | "doc";
            version: number;
            [key: string]: unknown;
        };
        created?: unknown;
        expand?: string
        | string[]
        | string & {}
        | ("properties" | string & {})[];
        id?: string;
        issueId?: string;
        issueIdOrKey: string;
        newEstimate?: string;
        notifyUsers?: boolean;
        overrideEditableFlag?: boolean;
        properties?: { key?: string; value?: unknown; [key: string]: unknown }[];
        reduceBy?: string;
        self?: string;
        started?: unknown;
        timeSpent?: string;
        timeSpentSeconds?: number;
        updateAuthor?: {
            accountId?: string;
            accountType?: string;
            active?: boolean;
            avatarUrls?: {
                "16x16"?: string;
                "24x24"?: string;
                "32x32"?: string;
                "48x48"?: string;
                [key: string]: unknown;
            };
            displayName?: string;
            emailAddress?: string;
            self?: string;
            timeZone?: string;
            [key: string]: unknown;
        };
        updated?: unknown;
        visibility?: {
            identifier?: string
            | null;
            type?: "role" | "group" | string & {};
            value?: string;
            [key: string]: unknown;
        };
    },
    options?: RequestOptions,
): Promise<
    {
        author?: {
            accountId?: string;
            accountType?: string;
            active?: boolean;
            avatarUrls?: {
                "16x16"?: string;
                "24x24"?: string;
                "32x32"?: string;
                "48x48"?: string;
                [key: string]: unknown;
            };
            displayName?: string;
            emailAddress?: string;
            self?: string;
            timeZone?: string;
            [key: string]: unknown;
        };
        comment?: {
            content: Record<string, any>[];
            type: string & {} | "doc";
            version: number;
            [key: string]: unknown;
        };
        created?: Date;
        id?: string;
        issueId?: string;
        properties?: { key?: string; value?: unknown; [key: string]: unknown }[];
        self?: string;
        started?: Date;
        timeSpent?: string;
        timeSpentSeconds?: number;
        updateAuthor?: {
            accountId?: string;
            accountType?: string;
            active?: boolean;
            avatarUrls?: {
                "16x16"?: string;
                "24x24"?: string;
                "32x32"?: string;
                "48x48"?: string;
                [key: string]: unknown;
            };
            displayName?: string;
            emailAddress?: string;
            self?: string;
            timeZone?: string;
            [key: string]: unknown;
        };
        updated?: Date;
        visibility?: {
            identifier?: string
            | null;
            type?: "role" | "group" | string & {};
            value?: string;
            [key: string]: unknown;
        };
        [key: string]: unknown;
    },
>
Adds a worklog to an issue.

Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking.

This operation can be accessed anonymously.

Permissions required:
- Browse projects and Work on issues project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
Parameters
- client: Client
- parameters: {
      adjustEstimate?: "auto" | "manual" | "new" | string & {} | "leave";
      author?: {
          accountId?: string;
          accountType?: string;
          active?: boolean;
          avatarUrls?: {
              "16x16"?: string;
              "24x24"?: string;
              "32x32"?: string;
              "48x48"?: string;
              [key: string]: unknown;
          };
          displayName?: string;
          emailAddress?: string;
          self?: string;
          timeZone?: string;
          [key: string]: unknown;
      };
      comment?: | string
      | {
          content: Record<string, any>[];
          type: string & {} | "doc";
          version: number;
          [key: string]: unknown;
      };
      created?: unknown;
      expand?: string
      | string[]
      | string & {}
      | ("properties" | string & {})[];
      id?: string;
      issueId?: string;
      issueIdOrKey: string;
      newEstimate?: string;
      notifyUsers?: boolean;
      overrideEditableFlag?: boolean;
      properties?: { key?: string; value?: unknown; [key: string]: unknown }[];
      reduceBy?: string;
      self?: string;
      started?: unknown;
      timeSpent?: string;
      timeSpentSeconds?: number;
      updateAuthor?: {
          accountId?: string;
          accountType?: string;
          active?: boolean;
          avatarUrls?: {
              "16x16"?: string;
              "24x24"?: string;
              "32x32"?: string;
              "48x48"?: string;
              [key: string]: unknown;
          };
          displayName?: string;
          emailAddress?: string;
          self?: string;
          timeZone?: string;
          [key: string]: unknown;
      };
      updated?: unknown;
      visibility?: {
          identifier?: string
          | null;
          type?: "role" | "group" | string & {};
          value?: string;
          [key: string]: unknown;
      };
  }
  - OptionaladjustEstimate?: "auto" | "manual" | "new" | string & {} | "leave"
    
    Defines how to update the issue's time estimate, the options are:
    
    new Sets the estimate to a specific value, defined in newEstimate.
    
    leave Leaves the estimate unchanged.
    
    manual Reduces the estimate by amount specified in reduceBy.
    
    auto Reduces the estimate by the value of timeSpent in the worklog.
  - Optionalauthor?: {
        accountId?: string;
        accountType?: string;
        active?: boolean;
        avatarUrls?: {
            "16x16"?: string;
            "24x24"?: string;
            "32x32"?: string;
            "48x48"?: string;
            [key: string]: unknown;
        };
        displayName?: string;
        emailAddress?: string;
        self?: string;
        timeZone?: string;
        [key: string]: unknown;
    }
    
    OptionalaccountId?: string
    
    The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
    
    OptionalaccountType?: string
    
    The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)
    
    Optionalactive?: boolean
    
    Whether the user is active.
    
    OptionalavatarUrls?: {
        "16x16"?: string;
        "24x24"?: string;
        "32x32"?: string;
        "48x48"?: string;
        [key: string]: unknown;
    }
    
    Optional16x16?: string
    
    The URL of the item's 16x16 pixel avatar.
    
    Optional24x24?: string
    
    The URL of the item's 24x24 pixel avatar.
    
    Optional32x32?: string
    
    The URL of the item's 32x32 pixel avatar.
    
    Optional48x48?: string
    
    The URL of the item's 48x48 pixel avatar.
    
    OptionaldisplayName?: string
    
    The display name of the user. Depending on the user’s privacy settings, this may return an alternative value.
    
    OptionalemailAddress?: string
    
    The email address of the user. Depending on the user’s privacy settings, this may be returned as null.
    
    Optionalself?: string
    
    The URL of the user.
    
    OptionaltimeZone?: string
    
    The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.
  - Optionalcomment?:
        | string
        | {
            content: Record<string, any>[];
            type: string & {} | "doc";
            version: number;
            [key: string]: unknown;
        }
    
    A document in Atlassian Document Format, or a string of wiki markup — a string is sent to the v2 endpoint that parses it, and the result is read back as a document.
  - Optionalcreated?: unknown
    
    The datetime on which the worklog was created.
  - Optionalexpand?: string | string[] | string & {} | ("properties" | string & {})[]
    
    Use expand to include additional information about work logs in the response. This parameter accepts properties, which returns worklog properties.
  - Optionalid?: string
    
    The ID of the worklog record.
  - OptionalissueId?: string
    
    The ID of the issue this worklog is for.
  - issueIdOrKey: string
    
    The ID or key the issue.
  - OptionalnewEstimate?: string
    
    The value to set as the issue's remaining time estimate, as days (#d), hours (#h), or minutes (#m or #). For example, 2d. Required when adjustEstimate is new.
  - OptionalnotifyUsers?: boolean
    
    Whether users watching the issue are notified by email.
  - OptionaloverrideEditableFlag?: boolean
    
    Whether the worklog entry should be added to the issue even if the issue is not editable, because jira.issue.editable set to false or missing. For example, the issue is closed. Connect and Forge app users with Administer Jira global permission can use this flag.
  - Optionalproperties?: { key?: string; value?: unknown; [key: string]: unknown }[]
    
    Details of properties for the worklog. Optional when creating or updating a worklog.
  - OptionalreduceBy?: string
    
    The amount to reduce the issue's remaining estimate by, as days (#d), hours (#h), or minutes (#m). For example, 2d. Required when adjustEstimate is manual.
  - Optionalself?: string
    
    The URL of the worklog item.
  - Optionalstarted?: unknown
    
    The datetime on which the worklog effort was started. Required when creating a worklog. Optional when updating a worklog.
  - OptionaltimeSpent?: string
    
    The time spent working on the issue as days (#d), hours (#h), or minutes (#m or #). Required when creating a worklog if timeSpentSeconds isn't provided. Optional when updating a worklog. Cannot be provided if timeSpentSecond is provided.
  - OptionaltimeSpentSeconds?: number
    
    The time in seconds spent working on the issue. Required when creating a worklog if timeSpent isn't provided. Optional when updating a worklog. Cannot be provided if timeSpent is provided.
  - OptionalupdateAuthor?: {
        accountId?: string;
        accountType?: string;
        active?: boolean;
        avatarUrls?: {
            "16x16"?: string;
            "24x24"?: string;
            "32x32"?: string;
            "48x48"?: string;
            [key: string]: unknown;
        };
        displayName?: string;
        emailAddress?: string;
        self?: string;
        timeZone?: string;
        [key: string]: unknown;
    }
    
    OptionalaccountId?: string
    
    The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
    
    OptionalaccountType?: string
    
    The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)
    
    Optionalactive?: boolean
    
    Whether the user is active.
    
    OptionalavatarUrls?: {
        "16x16"?: string;
        "24x24"?: string;
        "32x32"?: string;
        "48x48"?: string;
        [key: string]: unknown;
    }
    
    Optional16x16?: string
    
    The URL of the item's 16x16 pixel avatar.
    
    Optional24x24?: string
    
    The URL of the item's 24x24 pixel avatar.
    
    Optional32x32?: string
    
    The URL of the item's 32x32 pixel avatar.
    
    Optional48x48?: string
    
    The URL of the item's 48x48 pixel avatar.
    
    OptionaldisplayName?: string
    
    The display name of the user. Depending on the user’s privacy settings, this may return an alternative value.
    
    OptionalemailAddress?: string
    
    The email address of the user. Depending on the user’s privacy settings, this may be returned as null.
    
    Optionalself?: string
    
    The URL of the user.
    
    OptionaltimeZone?: string
    
    The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.
  - Optionalupdated?: unknown
    
    The datetime on which the worklog was last updated.
  - Optionalvisibility?: {
        identifier?: string | null;
        type?: "role" | "group" | string & {};
        value?: string;
        [key: string]: unknown;
    }
    
    Optionalidentifier?: string | null
    
    The ID of the group or the name of the role that visibility of this item is restricted to.
    
    Optionaltype?: "role" | "group" | string & {}
    
    Whether visibility of this item is restricted to a group or role.
    
    Optionalvalue?: string
    
    The name of the group or role that visibility of this item is restricted to. Please note that the name of a group is mutable, to reliably identify a group use identifier.
- Optionaloptions: RequestOptions
Returns Promise<
    {
        author?: {
            accountId?: string;
            accountType?: string;
            active?: boolean;
            avatarUrls?: {
                "16x16"?: string;
                "24x24"?: string;
                "32x32"?: string;
                "48x48"?: string;
                [key: string]: unknown;
            };
            displayName?: string;
            emailAddress?: string;
            self?: string;
            timeZone?: string;
            [key: string]: unknown;
        };
        comment?: {
            content: Record<string, any>[];
            type: string & {} | "doc";
            version: number;
            [key: string]: unknown;
        };
        created?: Date;
        id?: string;
        issueId?: string;
        properties?: { key?: string; value?: unknown; [key: string]: unknown }[];
        self?: string;
        started?: Date;
        timeSpent?: string;
        timeSpentSeconds?: number;
        updateAuthor?: {
            accountId?: string;
            accountType?: string;
            active?: boolean;
            avatarUrls?: {
                "16x16"?: string;
                "24x24"?: string;
                "32x32"?: string;
                "48x48"?: string;
                [key: string]: unknown;
            };
            displayName?: string;
            emailAddress?: string;
            self?: string;
            timeZone?: string;
            [key: string]: unknown;
        };
        updated?: Date;
        visibility?: {
            identifier?: string
            | null;
            type?: "role" | "group" | string & {};
            value?: string;
            [key: string]: unknown;
        };
        [key: string]: unknown;
    },
>
- Defined in src/cloud/api/issueWorklogs.ts:70

Function addWorklog

Parameters

OptionaladjustEstimate?: "auto" | "manual" | "new" | string & {} | "leave"

Optionalauthor?: { accountId?: string; accountType?: string; active?: boolean; avatarUrls?: { "16x16"?: string; "24x24"?: string; "32x32"?: string; "48x48"?: string; [key: string]: unknown; }; displayName?: string; emailAddress?: string; self?: string; timeZone?: string; [key: string]: unknown;}

OptionalaccountId?: string

OptionalaccountType?: string

Optionalactive?: boolean

OptionalavatarUrls?: { "16x16"?: string; "24x24"?: string; "32x32"?: string; "48x48"?: string; [key: string]: unknown;}

Optional16x16?: string

Optional24x24?: string

Optional32x32?: string

Optional48x48?: string

OptionaldisplayName?: string

OptionalemailAddress?: string

Optionalself?: string

OptionaltimeZone?: string

Optionalcomment?: | string | { content: Record<string, any>[]; type: string & {} | "doc"; version: number; [key: string]: unknown; }

Optionalcreated?: unknown

Optionalexpand?: string | string[] | string & {} | ("properties" | string & {})[]

Optionalid?: string

OptionalissueId?: string

issueIdOrKey: string

OptionalnewEstimate?: string

OptionalnotifyUsers?: boolean

OptionaloverrideEditableFlag?: boolean

Optionalproperties?: { key?: string; value?: unknown; [key: string]: unknown }[]

OptionalreduceBy?: string

Optionalself?: string

Optionalstarted?: unknown

OptionaltimeSpent?: string

OptionaltimeSpentSeconds?: number

OptionalaccountId?: string

OptionalaccountType?: string

Optionalactive?: boolean

OptionalavatarUrls?: { "16x16"?: string; "24x24"?: string; "32x32"?: string; "48x48"?: string; [key: string]: unknown;}

Optional16x16?: string

Optional24x24?: string

Optional32x32?: string

Optional48x48?: string

OptionaldisplayName?: string

OptionalemailAddress?: string

Optionalself?: string

OptionaltimeZone?: string

Optionalupdated?: unknown

Optionalvisibility?: { identifier?: string | null; type?: "role" | "group" | string & {}; value?: string; [key: string]: unknown;}

Optionalidentifier?: string | null

Optionaltype?: "role" | "group" | string & {}

Optionalvalue?: string

Settings

`Optional`adjustEstimate?: "auto" | "manual" | "new" | string & {} | "leave"

`Optional`author?: {
accountId?: string;
accountType?: string;
active?: boolean;
avatarUrls?: {
"16x16"?: string;
"24x24"?: string;
"32x32"?: string;
"48x48"?: string;
[key: string]: unknown;
};
displayName?: string;
emailAddress?: string;
self?: string;
timeZone?: string;
[key: string]: unknown;
}

`Optional`accountId?: string

`Optional`accountType?: string

`Optional`active?: boolean

`Optional`avatarUrls?: {
"16x16"?: string;
"24x24"?: string;
"32x32"?: string;
"48x48"?: string;
[key: string]: unknown;
}

`Optional`16x16?: string

`Optional`24x24?: string

`Optional`32x32?: string

`Optional`48x48?: string

`Optional`displayName?: string

`Optional`emailAddress?: string

`Optional`self?: string

`Optional`timeZone?: string

`Optional`comment?:
| string
| {
content: Record<string, any>[];
type: string & {} | "doc";
version: number;
[key: string]: unknown;
}

`Optional`created?: unknown

`Optional`expand?: string | string[] | string & {} | ("properties" | string & {})[]

`Optional`id?: string

`Optional`issueId?: string

`Optional`newEstimate?: string

`Optional`notifyUsers?: boolean

`Optional`overrideEditableFlag?: boolean

`Optional`properties?: { key?: string; value?: unknown; [key: string]: unknown }[]

`Optional`reduceBy?: string

`Optional`self?: string

`Optional`started?: unknown

`Optional`timeSpent?: string

`Optional`timeSpentSeconds?: number

`Optional`accountId?: string

`Optional`accountType?: string

`Optional`active?: boolean

`Optional`avatarUrls?: {
"16x16"?: string;
"24x24"?: string;
"32x32"?: string;
"48x48"?: string;
[key: string]: unknown;
}

`Optional`16x16?: string

`Optional`24x24?: string

`Optional`32x32?: string

`Optional`48x48?: string

`Optional`displayName?: string

`Optional`emailAddress?: string

`Optional`self?: string

`Optional`timeZone?: string

`Optional`updated?: unknown

`Optional`visibility?: {
identifier?: string | null;
type?: "role" | "group" | string & {};
value?: string;
[key: string]: unknown;
}

`Optional`identifier?: string | null

`Optional`type?: "role" | "group" | string & {}

`Optional`value?: string