jira.js
    Preparing search index...

    Function getIssue

    • Returns a single issue, for a given issue ID or issue key. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic.

      Parameters

      • client: Client
      • parameters: {
            expand?: string | string[];
            fields?: Record<string, any>[];
            issueIdOrKey: string;
            updateHistory?: boolean;
        }
        • Optionalexpand?: string | string[]

          A comma-separated list of the parameters to expand.

        • Optionalfields?: Record<string, any>[]

          The list of fields to return for each issue. By default, all navigable and Agile fields are returned.

        • issueIdOrKey: string

          The ID or key of the requested issue.

        • OptionalupdateHistory?: boolean

          A boolean indicating whether the issue retrieved by this method should be added to the current user's issue history

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              changelog?: {
                  histories?: {
                      author?: {
                          accountId?: string;
                          accountType?: string;
                          active?: boolean;
                          avatarUrls?: {
                              "16x16"?: ...;
                              "24x24"?: ...;
                              "32x32"?: ...;
                              "48x48"?: ...;
                              [key: ...]: ...;
                          };
                          displayName?: string;
                          emailAddress?: string;
                          self?: string;
                          timeZone?: string;
                          [key: string]: unknown;
                      };
                      created?: Date;
                      historyMetadata?: {
                          activityDescription?: string;
                          activityDescriptionKey?: string;
                          actor?: {
                              avatarUrl?: ...;
                              displayName?: ...;
                              displayNameKey?: ...;
                              id?: ...;
                              type?: ...;
                              url?: ...;
                              [key: ...]: ...;
                          };
                          cause?: {
                              avatarUrl?: ...;
                              displayName?: ...;
                              displayNameKey?: ...;
                              id?: ...;
                              type?: ...;
                              url?: ...;
                              [key: ...]: ...;
                          };
                          description?: string;
                          descriptionKey?: string;
                          emailDescription?: string;
                          emailDescriptionKey?: string;
                          extraData?: Record<(...), (...)>;
                          generator?: {
                              avatarUrl?: ...;
                              displayName?: ...;
                              displayNameKey?: ...;
                              id?: ...;
                              type?: ...;
                              url?: ...;
                              [key: ...]: ...;
                          };
                          type?: string;
                          [key: string]: unknown;
                      };
                      id?: string;
                      items?: {
                          field?: (...)
                          | (...);
                          fieldId?: (...) | (...);
                          fieldtype?: (...) | (...);
                          from?: (...) | (...);
                          fromString?: (...) | (...);
                          to?: (...) | (...);
                          toString?: (...) | (...);
                          [key: string]: unknown;
                      }[];
                      [key: string]: unknown;
                  }[];
                  maxResults?: number;
                  startAt?: number;
                  total?: number;
                  [key: string]: unknown;
              };
              editmeta?: { fields?: Record<string, any>; [key: string]: unknown };
              expand?: string;
              fields?: Record<string, any>;
              fieldsToInclude?: {
                  actuallyIncluded?: string[];
                  excluded?: string[];
                  included?: string[];
                  [key: string]: unknown;
              };
              id: string;
              key: string;
              names?: Record<string, any>;
              operations?: { linkGroups?: LinkGroup[]; [key: string]: unknown };
              properties?: Record<string, any>;
              renderedFields?: Record<string, any>;
              schema?: Record<string, any>;
              self: string;
              transitions?: {
                  expand?: string;
                  fields?: Record<string, any>;
                  hasScreen?: boolean;
                  id?: string;
                  isAvailable?: boolean;
                  isConditional?: boolean;
                  isGlobal?: boolean;
                  isInitial?: boolean;
                  looped?: boolean;
                  name?: string;
                  to?: {
                      description?: string;
                      iconUrl?: string;
                      id?: string;
                      name?: string;
                      scope?: {
                          project?: {
                              avatarUrls?: ...;
                              id?: ...;
                              key?: ...;
                              name?: ...;
                              projectCategory?: ...;
                              projectTypeKey?: ...;
                              self?: ...;
                              simplified?: ...;
                              [key: ...]: ...;
                          };
                          type?: (...) & (...)
                          | "PROJECT"
                          | "TEMPLATE";
                          [key: string]: unknown;
                      };
                      self?: string;
                      statusCategory?: {
                          colorName?: string;
                          id?: number;
                          key?: string;
                          name?: string;
                          self?: string;
                          [key: string]: unknown;
                      };
                      [key: string]: unknown;
                  };
                  [key: string]: unknown;
              }[];
              versionedRepresentations?: Record<string, any>;
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility