GET /rest/api/2/field/{fieldId}/context/{contextId}/option

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

Servers

Path parameters

Name Type Required Description
fieldId String Yes

The ID of the custom field.

contextId Integer Yes

The ID of the context.

Query parameters

Name Type Required Description
startAt Integer No

The index of the first item to return in a page of results (page offset).

Default value: 0

onlyOptions Boolean No

Whether only options are returned.

Default value: false

maxResults Integer No

The maximum number of items to return per page.

Default value: 100

optionId Integer No

The ID of the option.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.