Function: getAgileIssue()

function getAgileIssue(
   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?: Record<string, any>[];
        autoCompleteUrl?: string;
        defaultValue?: Record<string, any>;
        fieldId?: string;
        hasDefaultValue?: boolean;
        name?: string;
        operations?: string[];
        required?: boolean;
        schema?: {
         [key: string]: unknown;
           custom?: string;
           customId?: number;
           items?: string;
           system?: string;
           type?: string;
        };
     }>;
  };
  fields?: Record<string, any>;
  fieldsToInclude?: {
   [key: string]: unknown;
     included?: string[];
  };
  id?: string;
  key?: string;
  names?: Record<string, string>;
  operations?: {
   [key: string]: unknown;
     linkGroups?: LinkGroup[];
  };
  properties?: {
   [key: string]: unknown;
     properties?: Record<string, string>;
  };
  renderedFields?: Record<string, any> | null;
  schema?: Record<string, {
   [key: string]: unknown;
     custom?: string;
     customId?: number;
     items?: string;
     system?: string;
     type?: string;
  }>;
  self?: string;
  transitionBeans?: object[];
  transitions?: object[];
  versionedRepresentations?: Record<string, any>;
}>;

Defined in: src/server/api/issues.ts:120

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?: string | string[]; issueIdOrKey: string; updateHistory?: boolean; }	-
parameters.expand?	string | string[]	A comma-separated list of the parameters to expand.
parameters.fields?	string | string[]	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?: Record<string, any>[]; autoCompleteUrl?: string; defaultValue?: Record<string, any>; fieldId?: string; hasDefaultValue?: boolean; name?: string; operations?: string[]; required?: boolean; schema?: { [key: string]: unknown; custom?: string; customId?: number; items?: string; system?: string; type?: string; }; }>; }; fields?: Record<string, any>; fieldsToInclude?: { [key: string]: unknown; included?: string[]; }; id?: string; key?: string; names?: Record<string, string>; operations?: { [key: string]: unknown; linkGroups?: LinkGroup[]; }; properties?: { [key: string]: unknown; properties?: Record<string, string>; }; renderedFields?: Record<string, any> | null; schema?: Record<string, { [key: string]: unknown; custom?: string; customId?: number; items?: string; system?: string; type?: string; }>; self?: string; transitionBeans?: object[]; transitions?: object[]; versionedRepresentations?: Record<string, any>; }>