Skip to content

Function: getRemoteLinkById() ​

ts
function getRemoteLinkById(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  actionIds?: string[];
  associations?: (
     | {
   [key: string]: unknown;
     associationType: string & object | "issueKeys" | "issueIdOrKeys";
     values: string[];
   }
     | {
   [key: string]: unknown;
     associationType: string & object | "serviceIdOrKeys";
     values: string[];
  })[];
  attributeMap?: Record<string, string>;
  description?: string;
  displayName: string;
  id: string;
  lastUpdated: Date;
  schemaVersion?: string & object | "1.0";
  status?: {
   [key: string]: unknown;
     appearance:   | "default"
        | "new"
        | "removed"
        | "success"
        | string & object
        | "prototype"
        | "inprogress"
        | "moved";
     label: string;
  };
  type:   | "other"
     | "document"
     | "alert"
     | string & object
     | "test"
     | "security"
     | "logFile"
     | "prototype"
     | "coverage"
     | "bugReport";
  updateSequenceNumber: number;
  url: string;
}>;

Defined in: src/agile/api/remoteLinks.ts:78

Retrieve the currently stored Remote Link data for the given ID.

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

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ remoteLinkId: string; }-
parameters.remoteLinkIdstringThe ID of the Remote Link to fetch.
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; actionIds?: string[]; associations?: ( | { [key: string]: unknown; associationType: string & object | "issueKeys" | "issueIdOrKeys"; values: string[]; } | { [key: string]: unknown; associationType: string & object | "serviceIdOrKeys"; values: string[]; })[]; attributeMap?: Record<string, string>; description?: string; displayName: string; id: string; lastUpdated: Date; schemaVersion?: string & object | "1.0"; status?: { [key: string]: unknown; appearance: | "default" | "new" | "removed" | "success" | string & object | "prototype" | "inprogress" | "moved"; label: string; }; type: | "other" | "document" | "alert" | string & object | "test" | "security" | "logFile" | "prototype" | "coverage" | "bugReport"; updateSequenceNumber: number; url: string; }>