Function: addWorklog()

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

Defined in: src/server/api/issues.ts:1116

Adds a new worklog entry to an issue.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ adjustEstimate?: string; author?: { active?: boolean; avatarUrls?: Record<string, string>; displayName?: string; emailAddress?: string; key?: string; name?: string; self?: string; timeZone?: string; }; 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; }; updated?: string; visibility?: { type?: "role" | "group" | string & object; value?: string; }; }	-
parameters.adjustEstimate?	string	Allows you to provide specific instructions to update the remaining time estimate of the issue. Valid values are: new, leave, manual, auto
parameters.author?	{ active?: boolean; avatarUrls?: Record<string, string>; displayName?: string; emailAddress?: string; key?: string; name?: string; self?: string; timeZone?: string; }	-
parameters.author.active?	boolean	-
parameters.author.avatarUrls?	Record<string, string>	-
parameters.author.displayName?	string	-
parameters.author.emailAddress?	string	-
parameters.author.key?	string	-
parameters.author.name?	string	-
parameters.author.self?	string	-
parameters.author.timeZone?	string	-
parameters.comment?	string	-
parameters.created?	string	-
parameters.id?	string	-
parameters.issueId?	string	-
parameters.issueIdOrKey?	string	A string containing the issue id or key the worklog will be added to
parameters.newEstimate?	string	Required when 'new' is selected for adjustEstimate. e.g. "2d"
parameters.reduceBy?	string	Required when 'manual' is selected for adjustEstimate. e.g. "2d"
parameters.self?	string	-
parameters.started?	string	-
parameters.timeSpent?	string	-
parameters.timeSpentSeconds?	number	-
parameters.updateAuthor?	{ active?: boolean; avatarUrls?: Record<string, string>; displayName?: string; emailAddress?: string; key?: string; name?: string; self?: string; timeZone?: string; }	-
parameters.updateAuthor.active?	boolean	-
parameters.updateAuthor.avatarUrls?	Record<string, string>	-
parameters.updateAuthor.displayName?	string	-
parameters.updateAuthor.emailAddress?	string	-
parameters.updateAuthor.key?	string	-
parameters.updateAuthor.name?	string	-
parameters.updateAuthor.self?	string	-
parameters.updateAuthor.timeZone?	string	-
parameters.updated?	string	-
parameters.visibility?	{ type?: "role" | "group" | string & object; value?: string; }	-
parameters.visibility.type?	"role" | "group" | string & object	-
parameters.visibility.value?	string	-
options?	RequestOptions	-

Returns

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