Function: getCustomFields()

function getCustomFields(
   client, 
   parameters?, 
   options?
): Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  startAt: number;
  total?: number;
  values: object[];
}>;

Defined in: src/server/api/issueFields.ts:15

Returns a list of Custom Fields in the given range.

Parameters

Parameter	Type	Description
client	Client	-
parameters?	{ lastValueUpdate?: string; maxResults?: string; projectIds?: string; screenIds?: string; search?: string; sortColumn?: string; sortOrder?: string; startAt?: string; types?: string; }	-
parameters.lastValueUpdate?	string	The last value update to filter the custom fields.
parameters.maxResults?	string	The maximum number of custom fields to return.
parameters.projectIds?	string	A list of project IDs to filter the custom fields.
parameters.screenIds?	string	A list of screen IDs to filter the custom fields.
parameters.search?	string	A query string used to search custom fields.
parameters.sortColumn?	string	The column by which to sort the returned custom fields.
parameters.sortOrder?	string	The order in which to sort the returned custom fields.
parameters.startAt?	string	The starting index of the returned custom fields.
parameters.types?	string	A list of custom field types to filter the custom fields.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; startAt: number; total?: number; values: object[]; }>