Function: getCustomFieldOptions()

function getCustomFieldOptions(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  options?: object[];
  total?: number;
}>;

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

Returns custom field's options defined in a given context composed of projects and issue types.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ customFieldId: string; issueTypeIds?: string; maxResults?: string; page?: string; projectIds?: string; query?: string; sortByOptionName?: string; useAllContexts?: string; }	-
parameters.customFieldId	string	The ID of the custom field.
parameters.issueTypeIds?	string	A list of issue type IDs in a context.
parameters.maxResults?	string	The maximum number of results to return.
parameters.page?	string	The page of options to return.
parameters.projectIds?	string	A list of project IDs in a context.
parameters.query?	string	A string used to filter options.
parameters.sortByOptionName?	string	Flag to sort options by their names.
parameters.useAllContexts?	string	Flag to fetch all options regardless of context, project IDs, or issue type IDs.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; options?: object[]; total?: number; }>