Skip to content

Function: deleteWorklog() ​

ts
function deleteWorklog(
   client, 
   parameters, 
   options?
): Promise<void>;

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

Deletes an existing worklog entry.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ adjustEstimate?: string; id: string; increaseBy?: string; issueIdOrKey: string; newEstimate?: string; }-
parameters.adjustEstimate?stringAllows you to provide specific instructions to update the remaining time estimate of the issue. Valid values are: new, leave, manual, auto
parameters.id?stringId of the worklog to be deleted
parameters.increaseBy?stringRequired when 'manual' is selected for adjustEstimate. e.g. "2d"
parameters.issueIdOrKey?stringA string containing the issue id or key the worklog belongs to
parameters.newEstimate?stringRequired when 'new' is selected for adjustEstimate. e.g. "2d"
options?RequestOptions-

Returns ​

Promise<void>