Function: getComponent()

function getComponent(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  archived?: boolean;
  assigneeType?:   | string & object
     | "PROJECT_DEFAULT"
     | "COMPONENT_LEAD"
     | "PROJECT_LEAD"
     | "UNASSIGNED";
  deleted?: boolean;
  description?: string;
  id?: string;
  lead?: {
   [key: string]: unknown;
     active?: boolean;
     applicationRoles?: {
      [key: string]: unknown;
        callback?: {
         [key: string]: unknown;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: string]: unknown;
        };
        size?: number;
     };
     avatarUrls?: Record<string, string>;
     deleted?: boolean;
     displayName?: string;
     emailAddress?: string;
     expand?: string;
     groups?: {
      [key: string]: unknown;
        callback?: {
         [key: string]: unknown;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: string]: unknown;
        };
        size?: number;
     };
     key?: string;
     lastLoginTime?: string;
     locale?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  leadUserName?: string;
  name?: string;
  project?: string;
  self?: string;
}>;

Defined in: src/server/api/projectComponents.ts:63

Returns a project component.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ id: string; }	-
parameters.id	string	A String containing the component key
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; archived?: boolean; assigneeType?: | string & object | "PROJECT_DEFAULT" | "COMPONENT_LEAD" | "PROJECT_LEAD" | "UNASSIGNED"; deleted?: boolean; description?: string; id?: string; lead?: { [key: string]: unknown; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: string]: unknown; }; maxResults?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; }; avatarUrls?: Record<string, string>; deleted?: boolean; displayName?: string; emailAddress?: string; expand?: string; groups?: { [key: string]: unknown; callback?: { [key: string]: unknown; }; maxResults?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; }; key?: string; lastLoginTime?: string; locale?: string; name?: string; self?: string; timeZone?: string; }; leadUserName?: string; name?: string; project?: string; self?: string; }>