Skip to content

Function: getRequestTypeById() ​

ts
function getRequestTypeById(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     self?: string;
  };
  canCreateRequest?: boolean;
  description?: string;
  fields?: {
   [key: string]: unknown;
     canAddRequestParticipants?: boolean;
     canRaiseOnBehalfOf?: boolean;
     requestTypeFields?: object[];
  };
  groupIds?: string[];
  helpText?: string;
  icon?: {
   [key: string]: unknown;
     _links?: {
      [key: string]: unknown;
        iconUrls?: Record<string, string>;
     };
     id?: string;
  };
  id?: string;
  issueTypeId?: string;
  name?: string;
  portalId?: string;
  practice?: string;
  restrictionStatus?: string & object | "OPEN" | "RESTRICTED";
  serviceDeskId?: string;
}>;

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

This method returns a customer request type from a service desk.

This operation can be accessed anonymously.

Permissions required: Permission to access the service desk.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ expand?: string[]; requestTypeId: string; serviceDeskId: string; }-
parameters.expand?string[]-
parameters.requestTypeId?stringThe ID of the customer request type to be returned.
parameters.serviceDeskId?stringThe ID of the service desk whose customer request type is to be returned. This can alternatively be a project identifier.
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; _expands?: string[]; _links?: { [key: string]: unknown; self?: string; }; canCreateRequest?: boolean; description?: string; fields?: { [key: string]: unknown; canAddRequestParticipants?: boolean; canRaiseOnBehalfOf?: boolean; requestTypeFields?: object[]; }; groupIds?: string[]; helpText?: string; icon?: { [key: string]: unknown; _links?: { [key: string]: unknown; iconUrls?: Record<string, string>; }; id?: string; }; id?: string; issueTypeId?: string; name?: string; portalId?: string; practice?: string; restrictionStatus?: string & object | "OPEN" | "RESTRICTED"; serviceDeskId?: string; }>