Custom field options (Enabled/Disabled)
- Technical Communications
- Tuncay Senturk
- Marie Rosema
This page is about JEP for Jira DC. Using Cloud? Click here.
Jira’s REST API does not provide details on whether custom field options are enabled or disabled or their sequence order. JEP extends this functionality by offering a REST endpoint to:
Retrieve custom field options with their enabled/disabled status.
Get sequence details for better field management.
GET custom field options
Endpoint
URL:
{JIRA_BASE_URL}/rest/jep-api/latest/customfield/{customfieldId}/options?projectKey=NP&issueTypeId=1&onlyEnabled=trueMethod: GET
Example response
[
{
"optionId": 10100,
"optionValue": "Red",
"sequence": 0,
"disabled": false
},
{
"optionId": 10101,
"optionValue": "Green",
"sequence": 1,
"disabled": false
},
{
"optionId": 10102,
"optionValue": "Blue",
"sequence": 2,
"disabled": false
},
{
"optionId": 10103,
"optionValue": "Yellow",
"sequence": 3,
"disabled": true
}
]
Request parameters
Parameter | Optional/Required | Description |
|---|---|---|
| Required (Path Parameter) | The ID of the custom field whose options will be retrieved. |
| Required (Query Parameter) | The project key for which the custom field options should be listed (for example, |
| Required (Query Parameter) | The issue type ID for which the custom field options should be listed (for example, |
| Optional (Query Parameter) | Default: |
Need support? Create a request with our support team.