GET /rest/api/2/field/{fieldKey}/option/suggestions/search
Returns a paginated list of options for a select list issue field that can be viewed by the user.
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.
Permissions required: Permission to access Jira.
Servers
- https://your-domain.atlassian.net
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
fieldKey |
String | Yes |
The field key is specified in the following format: $(app-key)__$(field-key). For example, example-add-on__example-issue-field. To determine the
|
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
projectId |
Integer | No |
Filters the results to options that are only available in the specified project. |
startAt |
Integer | No |
The index of the first item to return in a page of results (page offset). Default value: 0 |
maxResults |
Integer | No |
The maximum number of items to return per page. Default value: 50 |
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.