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:
canRaiseOnBehalfOfreturnstrueif the user has permission to raise customer requests on behalf of other customers. Otherwise, returnsfalse.canAddRequestParticipantsreturnstrueif the user can add customer request participants. Otherwise, returnsfalse.
Permissions required: Permission to view the Service Desk. However, hidden fields would be visible to only Service desk's Administrator.
Parameters
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
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? | number | The ID of the request types whose fields are to be returned. |
parameters.serviceDeskId? | string | The 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[]; }>