Skip to content

Function: getRequestTypeFields() ​

ts
function getRequestTypeFields(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  canAddRequestParticipants?: boolean;
  canRaiseOnBehalfOf?: boolean;
  requestTypeFields?: object[];
}>;

Defined in: src/serviceDesk/api/servicedesk.ts:356

This method returns the fields for a service desk's customer request type.

Also, the following information about the user's permissions for the request type is returned:

  • canRaiseOnBehalfOf returns true if the user has permission to raise customer requests on behalf of other customers. Otherwise, returns false.
  • canAddRequestParticipants returns true if the user can add customer request participants. Otherwise, returns false.

Permissions required: Permission to view the Service Desk. However, hidden fields would be visible to only Service desk's Administrator.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ expand?: string[]; requestTypeId: number; serviceDeskId: string; }-
parameters.expand?string[]Use expand to include additional information in the response. This parameter accepts hiddenFields that returns hidden fields associated with the request type.
parameters.requestTypeId?numberThe ID of the request types whose fields are to be returned.
parameters.serviceDeskId?stringThe ID of the service desk containing the request types whose fields are to be returned. This can alternatively be a project identifier.
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; canAddRequestParticipants?: boolean; canRaiseOnBehalfOf?: boolean; requestTypeFields?: object[]; }>