Skip to content

Function: getWorklog() ​

ts
function getWorklog(
   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:1147

Returns a specific worklog. The work log won't be returned if the Log work field is hidden for the project.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ id: string; issueIdOrKey: string; }-
parameters.idstringWorklog id
parameters.issueIdOrKey?stringIssue id or key
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; }; }>