jira.js
    Preparing search index...

    Function getAgileIssue

    • 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?: string | string[];
            issueIdOrKey: string;
            updateHistory?: boolean;
        }
        • Optionalexpand?: string | string[]

          A comma-separated list of the parameters to expand.

        • Optionalfields?: string | string[]

          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?: {
                          active?: boolean;
                          avatarUrls?: Record<(...), (...)>;
                          displayName?: string;
                          emailAddress?: string;
                          key?: string;
                          name?: 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?: (...)
                          | (...);
                          fieldtype?: (...) | (...);
                          from?: (...) | (...);
                          fromString?: (...) | (...);
                          to?: (...) | (...);
                          toString?: (...) | (...);
                          [key: string]: unknown;
                      }[];
                      [key: string]: unknown;
                  }[];
                  maxResults?: number;
                  startAt?: number;
                  total?: number;
                  [key: string]: unknown;
              };
              editmeta?: {
                  fields?: Record<
                      string,
                      {
                          allowedValues?: Record<string, any>[];
                          autoCompleteUrl?: string;
                          defaultValue?: Record<string, any>;
                          fieldId?: string;
                          hasDefaultValue?: boolean;
                          name?: string;
                          operations?: string[];
                          required?: boolean;
                          schema?: {
                              custom?: string;
                              customId?: number;
                              items?: string;
                              system?: string;
                              type?: string;
                              [key: string]: unknown;
                          };
                          [key: string]: unknown;
                      },
                  >;
                  [key: string]: unknown;
              };
              fields?: Record<string, any>;
              fieldsToInclude?: { included?: string[]; [key: string]: unknown };
              id?: string;
              key?: string;
              names?: Record<string, string>;
              operations?: { linkGroups?: LinkGroup[]; [key: string]: unknown };
              properties?: {
                  properties?: Record<string, string>;
                  [key: string]: unknown;
              };
              renderedFields?: Record<string, any>
              | null;
              schema?: Record<
                  string,
                  {
                      custom?: string;
                      customId?: number;
                      items?: string;
                      system?: string;
                      type?: string;
                      [key: string]: unknown;
                  },
              >;
              self?: string;
              transitionBeans?: {
                  description?: string;
                  fields?: Record<
                      string,
                      {
                          allowedValues?: Record<(...), (...)>[];
                          autoCompleteUrl?: string;
                          defaultValue?: Record<string, any>;
                          fieldId?: string;
                          hasDefaultValue?: boolean;
                          name?: string;
                          operations?: string[];
                          required?: boolean;
                          schema?: {
                              custom?: (...) | (...);
                              customId?: (...) | (...);
                              items?: (...) | (...);
                              system?: (...) | (...);
                              type?: (...) | (...);
                              [key: string]: unknown;
                          };
                          [key: string]: unknown;
                      },
                  >;
                  id?: string;
                  name?: string;
                  opsbarSequence?: number;
                  to?: {
                      description?: string;
                      iconUrl?: string;
                      id?: string;
                      name?: string;
                      self?: string;
                      statusCategory?: {
                          colorName?: string;
                          id?: number;
                          key?: string;
                          name?: string;
                          self?: string;
                          [key: string]: unknown;
                      };
                      statusColor?: string;
                      [key: string]: unknown;
                  };
                  [key: string]: unknown;
              }[];
              transitions?: {
                  description?: string;
                  fields?: Record<
                      string,
                      {
                          allowedValues?: Record<(...), (...)>[];
                          autoCompleteUrl?: string;
                          defaultValue?: Record<string, any>;
                          fieldId?: string;
                          hasDefaultValue?: boolean;
                          name?: string;
                          operations?: string[];
                          required?: boolean;
                          schema?: {
                              custom?: (...) | (...);
                              customId?: (...) | (...);
                              items?: (...) | (...);
                              system?: (...) | (...);
                              type?: (...) | (...);
                              [key: string]: unknown;
                          };
                          [key: string]: unknown;
                      },
                  >;
                  id?: string;
                  name?: string;
                  opsbarSequence?: number;
                  to?: {
                      description?: string;
                      iconUrl?: string;
                      id?: string;
                      name?: string;
                      self?: string;
                      statusCategory?: {
                          colorName?: string;
                          id?: number;
                          key?: string;
                          name?: string;
                          self?: string;
                          [key: string]: unknown;
                      };
                      statusColor?: string;
                      [key: string]: unknown;
                  };
                  [key: string]: unknown;
              }[];
              versionedRepresentations?: Record<string, any>;
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility