Function: getComponentById()

function getComponentById(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  avatarUrl: string;
  componentType:   | string & object
     | "Service"
     | "Application"
     | "Library"
     | "Capability"
     | "Cloud resource"
     | "Data pipeline"
     | "Machine learning model"
     | "UI element"
     | "Website"
     | "Other";
  description: string;
  id: string;
  lastUpdated: Date;
  name: string;
  providerName?: string;
  schemaVersion: string & object | "1.0";
  tier: string & object | "Tier 1" | "Tier 2" | "Tier 3" | "Tier 4";
  updateSequenceNumber: number;
  url: string;
}>;

Defined in: src/agile/api/devopsComponents.ts:88

Retrieve the currently stored Component 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 jiraDevOpsComponentProvider module can access this resource. This resource requires the 'READ' scope for Connect apps.

Parameters

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

Returns

Promise<{ [key: string]: unknown; avatarUrl: string; componentType: | string & object | "Service" | "Application" | "Library" | "Capability" | "Cloud resource" | "Data pipeline" | "Machine learning model" | "UI element" | "Website" | "Other"; description: string; id: string; lastUpdated: Date; name: string; providerName?: string; schemaVersion: string & object | "1.0"; tier: string & object | "Tier 1" | "Tier 2" | "Tier 3" | "Tier 4"; updateSequenceNumber: number; url: string; }>