v4

OpenAPI 3.0.1Apache 2.02026-08-016169702.3 MB
Issue custom field options (apps)

Create issue field option

Creates an option for a select list issue field.

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

Each field can have a maximum of 10000 options, and each option can have a maximum of 10000 scopes.

Permissions required: Administer Jira global permission. Jira permissions are not required for the app providing the field.

post/rest/api/3/field/{fieldKey}/option

Path parameters

fieldKeystring required

The field key is specified in the following format: $(app-key)__$(field-key). For example, example-add-on__example-issue-field. To determine the fieldKey value, do one of the following:

  • open the app's plugin descriptor, then app-key is the key at the top and field-key is the key in the jiraIssueFields module. app-key can also be found in the app listing in the Atlassian Universal Plugin Manager.
  • run Get fields and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field"

Request body

propertiesobject

The properties of the option as arbitrary key-value pairs. These properties can be searched using JQL, if the extractions (see https://developer.atlassian.com/cloud/jira/platform/modules/issue-field-option-property-index/) are defined in the descriptor for the issue field module.

valuestring required

The option's name, which is displayed in Jira.

Response

Returned if the request is successful.

idinteger required

The unique identifier for the option. This is only unique within the select field's set of options.

propertiesobject

The properties of the object, as arbitrary key-value pairs. These properties can be searched using JQL, if the extractions (see Issue Field Option Property Index) are defined in the descriptor for the issue field module.

valuestring required

The option's name, which is displayed in Jira.