Function getCustomFieldOptions

getCustomFieldOptions(
    client: Client,
    parameters: {
        customFieldId: string;
        issueTypeIds?: string;
        maxResults?: string;
        page?: string;
        projectIds?: string;
        query?: string;
        sortByOptionName?: string;
        useAllContexts?: string;
    },
    options?: RequestOptions,
): Promise<
    {
        options?: {
            childrenIds?: number[];
            disabled?: boolean;
            id?: number;
            self?: string;
            value?: string;
            [key: string]: unknown;
        }[];
        total?: number;
        [key: string]: unknown;
    },
>
Returns custom field's options defined in a given context composed of projects and issue types.
Parameters
- client: Client
- parameters: {
      customFieldId: string;
      issueTypeIds?: string;
      maxResults?: string;
      page?: string;
      projectIds?: string;
      query?: string;
      sortByOptionName?: string;
      useAllContexts?: string;
  }
  - customFieldId: string
    
    The ID of the custom field.
  - OptionalissueTypeIds?: string
    
    A list of issue type IDs in a context.
  - OptionalmaxResults?: string
    
    The maximum number of results to return.
  - Optionalpage?: string
    
    The page of options to return.
  - OptionalprojectIds?: string
    
    A list of project IDs in a context.
  - Optionalquery?: string
    
    A string used to filter options.
  - OptionalsortByOptionName?: string
    
    Flag to sort options by their names.
  - OptionaluseAllContexts?: string
    
    Flag to fetch all options regardless of context, project IDs, or issue type IDs.
- Optionaloptions: RequestOptions
Returns Promise<
    {
        options?: {
            childrenIds?: number[];
            disabled?: boolean;
            id?: number;
            self?: string;
            value?: string;
            [key: string]: unknown;
        }[];
        total?: number;
        [key: string]: unknown;
    },
>
- Defined in src/server/api/issueFields.ts:61

Function getCustomFieldOptions

Parameters

customFieldId: string

`Optional`issueTypeIds?: string

`Optional`maxResults?: string

`Optional`page?: string

`Optional`projectIds?: string

`Optional`query?: string

`Optional`sortByOptionName?: string

`Optional`useAllContexts?: string

Settings

Function getCustomFieldOptions

Parameters

customFieldId: string

OptionalissueTypeIds?: string

OptionalmaxResults?: string

Optionalpage?: string

OptionalprojectIds?: string

Optionalquery?: string

OptionalsortByOptionName?: string

OptionaluseAllContexts?: string

Returns Promise< { options?: { childrenIds?: number[]; disabled?: boolean; id?: number; self?: string; value?: string; [key: string]: unknown; }[]; total?: number; [key: string]: unknown; },>

Settings

`Optional`issueTypeIds?: string

`Optional`maxResults?: string

`Optional`page?: string

`Optional`projectIds?: string

`Optional`query?: string

`Optional`sortByOptionName?: string

`Optional`useAllContexts?: string

Returns Promise<
{
options?: {
childrenIds?: number[];
disabled?: boolean;
id?: number;
self?: string;
value?: string;
[key: string]: unknown;
}[];
total?: number;
[key: string]: unknown;
},
>