jira.js
    Preparing search index...

    Function getRequestTypeFields

    • 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

      • client: Client
      • parameters: { expand?: string[]; requestTypeId: number; serviceDeskId: string }
        • Optionalexpand?: string[]

          Use expand to include additional information in the response. This parameter accepts hiddenFields that returns hidden fields associated with the request type.

        • requestTypeId: number

          The ID of the request types whose fields are to be returned.

        • 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.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              canAddRequestParticipants?: boolean;
              canRaiseOnBehalfOf?: boolean;
              requestTypeFields?: {
                  defaultValues?: RequestTypeFieldValue[];
                  description?: string;
                  fieldId?: string;
                  jiraSchema?: {
                      configuration?: Record<string, any>;
                      custom?: string;
                      customId?: number;
                      items?: string;
                      system?: string;
                      type: string;
                      [key: string]: unknown;
                  };
                  name?: string;
                  presetValues?: string[];
                  required?: boolean;
                  validValues?: RequestTypeFieldValue[];
                  visible?: boolean;
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility