Skip to content

Function: getAccessibleProjectTypeByKey() ​

ts
function getAccessibleProjectTypeByKey(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  color?: string;
  descriptionI18nKey?: string;
  formattedKey?: string;
  icon?: string;
  key?: string;
}>;

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

Returns the project type with the given key, if it is accessible to the logged in user. This takes into account whether the user is licensed on the Application that defines the project type.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ projectTypeKey: string; }-
parameters.projectTypeKeystringThe key of the project type
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; color?: string; descriptionI18nKey?: string; formattedKey?: string; icon?: string; key?: string; }>