Function: getCustomFieldConfiguration()

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

Defined in: src/cloud/api/issueCustomFieldConfigurationApps.ts:27

Returns a paginated list of configurations for a custom field of a type created by a Forge app.

The result can be filtered by one of these criteria:

• id.
• fieldContextId.
• issueId.
• projectKeyOrId and issueTypeId.

Otherwise, all configurations are returned.

Permissions required:Administer Jira global permission. Jira permissions are not required for the Forge app that provided the custom field type.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ fieldContextId?: number[]; fieldIdOrKey: string; id?: number[]; issueId?: number; issueTypeId?: string; maxResults?: number; projectKeyOrId?: string; startAt?: number; }	-
parameters.fieldContextId?	number[]	The list of field context IDs. To include multiple field contexts, separate IDs with an ampersand: fieldContextId=10000&fieldContextId=10001. Can't be provided with id, issueId, projectKeyOrId, or issueTypeId.
parameters.fieldIdOrKey?	string	The ID or key of the custom field, for example customfield_10000.
parameters.id?	number[]	The list of configuration IDs. To include multiple configurations, separate IDs with an ampersand: id=10000&id=10001. Can't be provided with fieldContextId, issueId, projectKeyOrId, or issueTypeId.
parameters.issueId?	number	The ID of the issue to filter results by. If the issue doesn't exist, an empty list is returned. Can't be provided with projectKeyOrId, or issueTypeId.
parameters.issueTypeId?	string	The ID of the issue type to filter results by. Must be provided with projectKeyOrId. Can't be provided with issueId.
parameters.maxResults?	number	The maximum number of items to return per page.
parameters.projectKeyOrId?	string	The ID or key of the project to filter results by. Must be provided with issueTypeId. Can't be provided with issueId.
parameters.startAt?	number	The index of the first item to return in a page of results (page offset).
options?	RequestOptions	-

Returns

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