jira.js
    Preparing search index...

    Function getCustomFields

    • Returns a list of Custom Fields in the given range.

      Parameters

      • client: Client
      • Optionalparameters: {
            lastValueUpdate?: string;
            maxResults?: string;
            projectIds?: string;
            screenIds?: string;
            search?: string;
            sortColumn?: string;
            sortOrder?: string;
            startAt?: string;
            types?: string;
        }
        • OptionallastValueUpdate?: string

          The last value update to filter the custom fields.

        • OptionalmaxResults?: string

          The maximum number of custom fields to return.

        • OptionalprojectIds?: string

          A list of project IDs to filter the custom fields.

        • OptionalscreenIds?: string

          A list of screen IDs to filter the custom fields.

        • Optionalsearch?: string

          A query string used to search custom fields.

        • OptionalsortColumn?: string

          The column by which to sort the returned custom fields.

        • OptionalsortOrder?: string

          The order in which to sort the returned custom fields.

        • OptionalstartAt?: string

          The starting index of the returned custom fields.

        • Optionaltypes?: string

          A list of custom field types to filter the custom fields.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              isLast: boolean;
              maxResults: number;
              startAt: number;
              total?: number;
              values: {
                  description?: string;
                  id?: string;
                  isAllProjects?: boolean;
                  isLocked?: boolean;
                  isManaged?: boolean;
                  issuesWithValue?: number;
                  issueTypeIds?: string[];
                  isTrusted?: boolean;
                  lastValueUpdate?: Date;
                  name?: string;
                  numericId?: number;
                  projectIds?: number[];
                  projectsCount?: number;
                  screensCount?: number;
                  searcherKey?: string;
                  self?: string;
                  type?: string;
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          },
      >