jira.js
    Preparing search index...

    Function getIssueWorklog

    • Returns worklogs for an issue (ordered by created time), starting from the oldest worklog or from the worklog started on or after a date and time.

      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: Workloads are only returned where the user has:

      • Browse projects project permission for the project that the issue is in.
      • If issue-level security is configured, issue-level security permission to view the issue.
      • If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.

      Parameters

      • client: Client
      • parameters: {
            expand?:
                | string
                | string[]
                | string & {}
                | ("properties" | string & {})[];
            issueIdOrKey: string;
            maxResults?: number;
            startAt?: number;
            startedAfter?: number;
            startedBefore?: number;
        }
        • Optionalexpand?: string | string[] | string & {} | ("properties" | string & {})[]

          Use expand to include additional information about worklogs in the response. This parameter acceptsproperties, which returns worklog properties.

        • issueIdOrKey: string

          The ID or key of the issue.

        • OptionalmaxResults?: number

          The maximum number of items to return per page.

        • OptionalstartAt?: number

          The index of the first item to return in a page of results (page offset).

        • OptionalstartedAfter?: number

          The worklog start date and time, as a UNIX timestamp in milliseconds, after which worklogs are returned.

        • OptionalstartedBefore?: number

          The worklog start date and time, as a UNIX timestamp in milliseconds, before which worklogs are returned.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              maxResults?: number;
              startAt?: number;
              total?: number;
              worklogs?: {
                  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;
              }[];
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility