Skip to content

Function: createRequestType() ​

ts
function createRequestType(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  _links?: {
   [key: string]: unknown;
     self?: string;
  };
  description?: string;
  groupIds?: string[];
  helpText?: string;
  icon?: {
   [key: string]: unknown;
     _links?: {
      [key: string]: unknown;
        iconUrls?: Record<string, any>;
     };
     id?: string;
  };
  id?: string;
  name?: string;
  restrictionStatus?: string & object | "OPEN" | "RESTRICTED";
  serviceDeskId?: string;
}>;

Defined in: src/serviceDeskServer/api/requestTypes.ts:104

Creates a new request type for a given service project. Certain fields cannot be specified on creation. These fields are given default values instead, as shown below.

Request Type icon - Question mark icon

Request Type groups - Empty, i.e. this request type will be hidden by default and not visible on the customer portal

Request Type status mapping - Empty, i.e. no custom status mapping

Request Type field mapping - Show the required fields as specified by the issue type

These fields can be updated after creation by a project administrator using the Agent view.

Permissions:

The calling user must be a project administrator for the service project project.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ description?: string; helpText?: string; issueTypeId?: string; name?: string; serviceDeskId: string; }-
parameters.description?string-
parameters.helpText?string-
parameters.issueTypeId?string-
parameters.name?string-
parameters.serviceDeskId?stringThe id of the service desk.
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; _links?: { [key: string]: unknown; self?: string; }; description?: string; groupIds?: string[]; helpText?: string; icon?: { [key: string]: unknown; _links?: { [key: string]: unknown; iconUrls?: Record<string, any>; }; id?: string; }; id?: string; name?: string; restrictionStatus?: string & object | "OPEN" | "RESTRICTED"; serviceDeskId?: string; }>