Function: getIssue()

function getIssue(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  changelog?: {
   [key: string]: unknown;
     histories?: object[];
     maxResults?: number;
     startAt?: number;
     total?: number;
  };
  editmeta?: {
   [key: string]: unknown;
     fields?: Record<string, {
      [key: string]: unknown;
        allowedValues?: unknown[];
        autoCompleteUrl?: string;
        configuration?: Record<string, any>;
        defaultValue?: unknown;
        hasDefaultValue?: boolean;
        key: string;
        name: string;
        operations: string[];
        required: boolean;
        schema?: {
         [key: string]: unknown;
           configuration?: Record<..., ...>;
           custom?: string;
           customId?: number;
           items?: string;
           system?: string;
           type: string;
        };
     }>;
  };
  expand?: string;
  fields?: Record<string, any>;
  fieldsToInclude?: {
   [key: string]: unknown;
     actuallyIncluded?: string[];
     excluded?: string[];
     included?: string[];
  };
  id: string;
  key: string;
  names?: Record<string, string>;
  operations?: {
   [key: string]: unknown;
     linkGroups?: LinkGroup[];
  };
  properties?: Record<string, any>;
  renderedFields?: Record<string, any>;
  schema?: Record<string, {
   [key: string]: unknown;
     configuration?: Record<string, any>;
     custom?: string;
     customId?: number;
     items?: string;
     system?: string;
     type: string;
  }>;
  self: string;
  transitions?: object[];
  versionedRepresentations?: Record<string, any>;
}>;

Defined in: src/agile/api/issue.ts:41

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

Parameter	Type	Description
client	Client	-
parameters	{ expand?: string | string[]; fields?: Record<string, any>[]; issueIdOrKey: string; updateHistory?: boolean; }	-
parameters.expand?	string | string[]	A comma-separated list of the parameters to expand.
parameters.fields?	Record<string, any>[]	The list of fields to return for each issue. By default, all navigable and Agile fields are returned.
parameters.issueIdOrKey?	string	The ID or key of the requested issue.
parameters.updateHistory?	boolean	A boolean indicating whether the issue retrieved by this method should be added to the current user's issue history
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; changelog?: { [key: string]: unknown; histories?: object[]; maxResults?: number; startAt?: number; total?: number; }; editmeta?: { [key: string]: unknown; fields?: Record<string, { [key: string]: unknown; allowedValues?: unknown[]; autoCompleteUrl?: string; configuration?: Record<string, any>; defaultValue?: unknown; hasDefaultValue?: boolean; key: string; name: string; operations: string[]; required: boolean; schema?: { [key: string]: unknown; configuration?: Record<..., ...>; custom?: string; customId?: number; items?: string; system?: string; type: string; }; }>; }; expand?: string; fields?: Record<string, any>; fieldsToInclude?: { [key: string]: unknown; actuallyIncluded?: string[]; excluded?: string[]; included?: string[]; }; id: string; key: string; names?: Record<string, string>; operations?: { [key: string]: unknown; linkGroups?: LinkGroup[]; }; properties?: Record<string, any>; renderedFields?: Record<string, any>; schema?: Record<string, { [key: string]: unknown; configuration?: Record<string, any>; custom?: string; customId?: number; items?: string; system?: string; type: string; }>; self: string; transitions?: object[]; versionedRepresentations?: Record<string, any>; }>