Class IssueCustomFieldOptionsService

This resource represents custom issue field select list options created in Jira or using the REST API. This resource supports the following field types:

Checkboxes.
Radio Buttons.
Select List (single choice).
Select List (multiple choices).
Select List (cascading).

See Issue custom field options (apps) to manipulate custom issue field select list options created by a Connect app.

Use it to retrieve, create, update, order, and delete custom field options.

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options

Hierarchy

CommonHttpService
- IssueCustomFieldOptionsService

Index

Constructors

constructor

Methods

createCustomFieldOption deleteCustomFieldOption getCustomFieldOption getOptionsForContext reorderCustomFieldOptions replaceCustomFieldOption updateCustomFieldOption initialize

Constructors

constructor

new IssueCustomFieldOptionsService(getClientInstance): IssueCustomFieldOptionsService
Internal
Create a new instance of the service.
Parameters
- getClientInstance: (() => CommonHttpClient)
  - - (): CommonHttpClient
    - Returns CommonHttpClient
Returns IssueCustomFieldOptionsService
Inherited from CommonHttpService.constructor

Methods

createCustomFieldOption

createCustomFieldOption(params): Promise<CustomFieldCreatedContextOptionsList>
Creates options and, where the custom select field is of the type Select List (cascading), cascading options for a custom select field. The options are added to a context of the field.

The maximum number of options that can be created per request is 1000 and each field can have a maximum of 10000 options.

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.
Parameters
- params: {
      bulkCustomFieldOptionCreateRequest: BulkCustomFieldOptionCreateRequest;
      contextId: number;
      fieldId: string;
  }
  - bulkCustomFieldOptionCreateRequest: BulkCustomFieldOptionCreateRequest
    Example
  - contextId: number
    The ID of the context.
  - fieldId: string
    The ID of the custom field.
Returns Promise<CustomFieldCreatedContextOptionsList>
Returned if the request is successful.

example:
```
{
  "options": [
    {
      "disabled": false,
      "id": "10001",
      "value": "Scranton"
    },
    {
      "disabled": true,
      "id": "10002",
      "optionId": "10000",
      "value": "Manhattan"
    },
    {
      "disabled": false,
      "id": "10003",
      "value": "The Electric City"
    }
  ]
}
```
Path
POST /rest/api/3/field/{fieldId}/context/{contextId}/option @scopes-current manage:jira-configuration @scopes-beta read:field.option:jira, write:field.option:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options#api-rest-api-3-field-fieldid-context-contextid-option-post

deleteCustomFieldOption

deleteCustomFieldOption(params): Promise<void>
Deletes a custom field option.

Options with cascading options cannot be deleted without deleting the cascading options first.

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.
Parameters
- params: {
      contextId: number;
      fieldId: string;
      optionId: number;
  }
  - contextId: number
    The ID of the context from which an option should be deleted.
  - fieldId: string
    The ID of the custom field.
  - optionId: number
    The ID of the option to delete.
Returns Promise<void>
Path
DELETE /rest/api/3/field/{fieldId}/context/{contextId}/option/{optionId} @scopes-current manage:jira-configuration @scopes-beta delete:field.option:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options#api-rest-api-3-field-fieldid-context-contextid-option-optionid-delete

getCustomFieldOption

getCustomFieldOption(params): Promise<CustomFieldOption>
Returns a custom field option. For example, an option in a select list.

Note that this operation only works for issue field select list options created in Jira or using operations from the Issue custom field options resource, it cannot be used with issue field select list options created by Connect apps.

This operation can be accessed anonymously.

Permissions required: The custom field option is returned as follows:
- if the user has the Administer Jira global permission.
- if the user has the Browse projects project permission for at least one project the custom field is used in, and the field is visible in at least one layout the user has permission to view.
Parameters
- params: {
  id: string;
  }
  - id: string
    The ID of the custom field option.
Returns Promise<CustomFieldOption>
Returned if the request is successful.

example:
```
{
  "self": "https://your-domain.atlassian.net/rest/api/3/customFieldOption/10000",
  "value": "To Do"
}
```
Path
GET /rest/api/3/customFieldOption/{id} @scopes-current read:jira-work @scopes-beta read:field:jira, read:field.option:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options#api-rest-api-3-customfieldoption-id-get

getOptionsForContext

getOptionsForContext(params): Promise<PageBeanCustomFieldContextOption>
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.
Parameters
- params: {
      contextId: number;
      fieldId: string;
      maxResults?: number;
      onlyOptions?: boolean;
      optionId?: number;
      startAt?: number;
  }
  - contextId: number
    The ID of the context.
  - fieldId: string
    The ID of the custom field.
  - OptionalmaxResults?: number
    The maximum number of items to return per page.
  - OptionalonlyOptions?: boolean
    Whether only options are returned.
  - OptionaloptionId?: number
    The ID of the option.
  - OptionalstartAt?: number
    The index of the first item to return in a page of results (page offset).
Returns Promise<PageBeanCustomFieldContextOption>
Returned if the request is successful.

example:
```
{
  "isLast": true,
  "maxResults": 100,
  "startAt": 0,
  "total": 4,
  "values": [
    {
      "id": "10001",
      "value": "New York"
    },
    {
      "id": "10002",
      "value": "Boston",
      "disabled": true
    },
    {
      "id": "10004",
      "value": "Denver"
    },
    {
      "id": "10003",
      "value": "Brooklyn",
      "optionId": "10001"
    }
  ]
}
```
Path
GET /rest/api/3/field/{fieldId}/context/{contextId}/option @scopes-current manage:jira-configuration @scopes-beta read:field.option:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options#api-rest-api-3-field-fieldid-context-contextid-option-get

reorderCustomFieldOptions

reorderCustomFieldOptions(params): Promise<void>
Changes the order of custom field options or cascading options in a context.

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.
Parameters
- params: {
      contextId: number;
      fieldId: string;
      orderOfCustomFieldOptions: OrderOfCustomFieldOptions;
  }
  - contextId: number
    The ID of the context.
  - fieldId: string
    The ID of the custom field.
  - orderOfCustomFieldOptions: OrderOfCustomFieldOptions
    Example
Returns Promise<void>
Returned if options are reordered.

Path
PUT /rest/api/3/field/{fieldId}/context/{contextId}/option/move @scopes-current manage:jira-configuration @scopes-beta write:field.option:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options#api-rest-api-3-field-fieldid-context-contextid-option-move-put

replaceCustomFieldOption

replaceCustomFieldOption(params): Promise<void>
Replaces the options of a custom field.

Note that this operation only works for issue field select list options created in Jira or using operations from the Issue custom field options resource, it cannot be used with issue field select list options created by Connect or Forge apps.

Permissions required: Administer Jira global permission.
Parameters
- params: {
      contextId: number;
      fieldId: string;
      jql?: string;
      optionId: number;
      replaceWith?: number;
  }
  - contextId: number
    The ID of the context.
  - fieldId: string
    The ID of the custom field.
  - Optionaljql?: string
    A JQL query that specifies the issues to be updated. For example, project=10000.
  - optionId: number
    The ID of the option to be deselected.
  - OptionalreplaceWith?: number
    The ID of the option that will replace the currently selected option.
Returns Promise<void>
Path
DELETE /rest/api/3/field/{fieldId}/context/{contextId}/option/{optionId}/issue @scopes-current manage:jira-configuration @scopes-beta read:field.option:jira, write:field.option:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options#api-rest-api-3-field-fieldid-context-contextid-option-optionid-issue-delete

updateCustomFieldOption

updateCustomFieldOption(params): Promise<CustomFieldUpdatedContextOptionsList>
Updates the options of a custom field.

If any of the options are not found, no options are updated. Options where the values in the request match the current values aren't updated and aren't reported in the response.

Note that this operation only works for issue field select list options created in Jira or using operations from the Issue custom field options resource, it cannot be used with issue field select list options created by Connect apps.

Permissions required: Administer Jira global permission.
Parameters
- params: {
      bulkCustomFieldOptionUpdateRequest: BulkCustomFieldOptionUpdateRequest;
      contextId: number;
      fieldId: string;
  }
  - bulkCustomFieldOptionUpdateRequest: BulkCustomFieldOptionUpdateRequest
    Example
  - contextId: number
    The ID of the context.
  - fieldId: string
    The ID of the custom field.
Returns Promise<CustomFieldUpdatedContextOptionsList>
Returned if the request is successful.

example:
```
{
  "options": [
    {
      "disabled": false,
      "id": "10001",
      "value": "Scranton"
    },
    {
      "disabled": true,
      "id": "10002",
      "value": "Manhattan"
    },
    {
      "disabled": false,
      "id": "10003",
      "value": "The Electric City"
    }
  ]
}
```
Path
PUT /rest/api/3/field/{fieldId}/context/{contextId}/option @scopes-current manage:jira-configuration @scopes-beta read:field.option:jira, write:field.option:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options#api-rest-api-3-field-fieldid-context-contextid-option-put

`Protected` `Static`initialize

initialize(): void
Method to initialize the class. Normally used to set up validation rules.

Returns void
Overrides CommonHttpService.initialize

Class IssueCustomFieldOptionsService

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns IssueCustomFieldOptionsService

Methods

createCustomFieldOption

Parameters

bulkCustomFieldOptionCreateRequest: BulkCustomFieldOptionCreateRequest

Example

contextId: number

fieldId: string

Returns Promise<CustomFieldCreatedContextOptionsList>

Path

See

deleteCustomFieldOption

Parameters

contextId: number

fieldId: string

optionId: number

Returns Promise<void>

Path

See

getCustomFieldOption

Parameters

id: string

Returns Promise<CustomFieldOption>

Path

See

getOptionsForContext

Parameters

contextId: number

fieldId: string

OptionalmaxResults?: number

OptionalonlyOptions?: boolean

OptionaloptionId?: number

OptionalstartAt?: number

Returns Promise<PageBeanCustomFieldContextOption>

Path

See

reorderCustomFieldOptions

Parameters

contextId: number

fieldId: string

orderOfCustomFieldOptions: OrderOfCustomFieldOptions

Example

Returns Promise<void>

Path

See

replaceCustomFieldOption

Parameters

contextId: number

fieldId: string

Optionaljql?: string

optionId: number

OptionalreplaceWith?: number

Returns Promise<void>

Path

See

updateCustomFieldOption

Parameters

bulkCustomFieldOptionUpdateRequest: BulkCustomFieldOptionUpdateRequest

Example

contextId: number

fieldId: string

Returns Promise<CustomFieldUpdatedContextOptionsList>

Path

See

Protected Staticinitialize

Returns void

Settings

On This Page

`Optional`maxResults?: number

`Optional`onlyOptions?: boolean

`Optional`optionId?: number

`Optional`startAt?: number

`Optional`jql?: string

`Optional`replaceWith?: number

`Protected` `Static`initialize