Function: getIncidentById()

function getIncidentById(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  affectedComponents: string[];
  associations?: object[];
  createdDate: Date;
  description: string;
  id: string;
  lastUpdated: Date;
  schemaVersion: string & object | "1.0";
  severity?: {
   [key: string]: unknown;
     level: "unknown" | string & object | "P1" | "P2" | "P3" | "P4" | "P5";
  };
  status: "unknown" | "open" | string & object | "resolved";
  summary: string;
  updateSequenceNumber: number;
  url: string;
}>;

Defined in: src/agile/api/operations.ts:176

Retrieve the currently stored Incident data for the given ID.

The result will be what is currently stored, ignoring any pending updates or deletes.

Only Connect apps that define the jiraOperationsInfoProvider module can access this resource. This resource requires the 'READ' scope for Connect apps.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ incidentId: string; }	-
parameters.incidentId	string	The ID of the Incident to fetch.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; affectedComponents: string[]; associations?: object[]; createdDate: Date; description: string; id: string; lastUpdated: Date; schemaVersion: string & object | "1.0"; severity?: { [key: string]: unknown; level: "unknown" | string & object | "P1" | "P2" | "P3" | "P4" | "P5"; }; status: "unknown" | "open" | string & object | "resolved"; summary: string; updateSequenceNumber: number; url: string; }>