Function: getOptionsForContext()
ts
function getOptionsForContext(
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/issueCustomFieldOptions.ts:73
Returns a paginated list of all custom field option for a context. Options are returned first then cascading options, in the order they display in Jira.
This operation works for custom field options created in Jira or the operations from this resource. To work with issue field select list options created for Connect apps use the Issue custom field options (apps) operations.
Permissions required:Administer Jira global permission. Edit Workflow edit workflow permission
Parameters
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
parameters | { contextId: number; fieldId: string; maxResults?: number; onlyOptions?: boolean; optionId?: number; startAt?: number; } | - |
parameters.contextId | number | The ID of the context. |
parameters.fieldId? | string | The ID of the custom field. |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.onlyOptions? | boolean | Whether only options are returned. |
parameters.optionId? | number | The ID of the option. |
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[]; }>