Function: getReviewById()

function getReviewById(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  associations?: object[];
  createdDate: Date;
  description: string;
  id: string;
  lastUpdated: Date;
  reviews: string[];
  schemaVersion: string & object | "1.0";
  status:   | "unknown"
     | "completed"
     | string & object
     | "in progress"
     | "outstanding actions";
  summary: string;
  updateSequenceNumber: number;
  url: string;
}>;

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

Retrieve the currently stored Review 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	{ reviewId: string; }	-
parameters.reviewId	string	The ID of the Review to fetch.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; associations?: object[]; createdDate: Date; description: string; id: string; lastUpdated: Date; reviews: string[]; schemaVersion: string & object | "1.0"; status: | "unknown" | "completed" | string & object | "in progress" | "outstanding actions"; summary: string; updateSequenceNumber: number; url: string; }>