Skip to content

Function: getProjectRole() ​

ts
function getProjectRole(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  actors?: object[];
  description?: string;
  id?: number;
  name?: string;
  self?: string;
}>;

Defined in: src/server/api/projects.ts:490

Returns the details for a given project role in a project.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ id: number; projectIdOrKey: string; }-
parameters.idnumberThe project role id
parameters.projectIdOrKey?stringThe project id or project key
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; actors?: object[]; description?: string; id?: number; name?: string; self?: string; }>