- Announcement banner
- Issue custom field values (apps)
- Issue custom field configuration (apps)
- Jira settings
- Application roles
- Issue attachments
- Audit records
- Avatars
- Issue comments
- Issue comment properties
- Project components
- Time tracking
- Issue custom field options
- Dashboards
- Get all dashboards
- Create dashboard
- Get available gadgets
- Search for dashboards
- Get gadgets
- Add gadget to dashboard
- Update gadget on dashboard
- Remove gadget from dashboard
- Get dashboard item property keys
- Get dashboard item property
- Set dashboard item property
- Delete dashboard item property
- Get dashboard
- Update dashboard
- Delete dashboard
- Copy dashboard
- Issues
- Jira expressions
- Issue fields
- Issue custom field contexts
- Get custom field contexts
- Create custom field context
- Get custom field contexts default values
- Set custom field contexts default values
- Get issue types for custom field context
- Get custom field contexts for projects and issue types
- Get project mappings for custom field context
- Update custom field context
- Delete custom field context
- Add issue types to context
- Remove issue types from context
- Assign custom field context to projects
- Remove custom field context from projects
- Screens
- Issue custom field options (apps)
- Issue field configurations
- Get all field configurations
- Create field configuration
- Update field configuration
- Delete field configuration
- Get field configuration items
- Update field configuration items
- Get all field configuration schemes
- Create field configuration scheme
- Get field configuration issue type items
- Get field configuration schemes for projects
- Assign field configuration scheme to project
- Update field configuration scheme
- Delete field configuration scheme
- Assign issue types to field configurations
- Remove issue types from field configuration scheme
- Filters
- Filter sharing
- Groups
- Group and user picker
- License metrics
- Issue search
- Issue properties
- Issue watchers
- Issue remote links
- Issue votes
- Issue worklogs
- Issue worklog properties
- Issue links
- Issue link types
- Issue security schemes
- Get issue security schemes
- Create issue security scheme
- Get issue security levels
- Set default issue security levels
- Get issue security level members
- Get projects using issue security schemes
- Associate security scheme to project
- Search issue security schemes
- Get issue security scheme
- Update issue security scheme
- Delete issue security scheme
- Add issue security levels
- Update issue security level
- Remove issue security level
- Add issue security level members
- Remove member from issue security level
- Issue security level
- Issue types
- Issue type properties
- Issue type schemes
- Issue type screen schemes
- Get issue type screen schemes
- Create issue type screen scheme
- Get issue type screen scheme items
- Get issue type screen schemes for projects
- Assign issue type screen scheme to project
- Update issue type screen scheme
- Delete issue type screen scheme
- Append mappings to issue type screen scheme
- Update issue type screen scheme default screen scheme
- Remove mappings from issue type screen scheme
- Get issue type screen scheme projects
- JQL
- JQL functions (apps)
- Labels
- Permissions
- Myself
- Issue notification schemes
- Permission schemes
- Issue priorities
- Projects
- Project types
- Project avatars
- Project features
- Project properties
- Project roles
- Project role actors
- Project versions
- Project email
- Project permission schemes
- Project categories
- Project key and name validation
- Issue resolutions
- Screen tabs
- Screen tab fields
- Screen schemes
- Server info
- Issue navigator settings
- Workflow statuses
- Workflow status categories
- Status
- Tasks
- UI modifications (apps)
- Users
- User search
- User properties
- Webhooks
- Workflows
- Workflow transition rules
- Workflow transition properties
- Workflow schemes
- Get all workflow schemes
- Create workflow scheme
- Get workflow scheme
- Update workflow scheme
- Delete workflow scheme
- Get default workflow
- Update default workflow
- Delete default workflow
- Get workflow for issue type in workflow scheme
- Set workflow for issue type in workflow scheme
- Delete workflow for issue type in workflow scheme
- Get issue types for workflows in workflow scheme
- Set issue types for workflow in workflow scheme
- Delete issue types for workflow in workflow scheme
- Workflow scheme project associations
- Workflow scheme drafts
- Create draft workflow scheme
- Get draft workflow scheme
- Update draft workflow scheme
- Delete draft workflow scheme
- Get draft default workflow
- Update draft default workflow
- Delete draft default workflow
- Get workflow for issue type in draft workflow scheme
- Set workflow for issue type in draft workflow scheme
- Delete workflow for issue type in draft workflow scheme
- Publish draft workflow scheme
- Get issue types for workflows in draft workflow scheme
- Set issue types for workflow in workflow scheme
- Delete issue types for workflow in draft workflow scheme
- App properties
- Dynamic modules
- App migration
Update custom field
PUT
/rest/api/3/field/{fieldId}
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'http://jira.local:8080/jira/rest//rest/api/3/field/' \
--header 'Content-Type: application/json' \
--data-raw '{
"description": "Select the manager and the corresponding employee.",
"name": "Managers and employees list",
"searcherKey": "com.atlassian.jira.plugin.system.customfieldtypes:cascadingselectsearcher"
}'Response Response Example
204 - Example 1
nullRequest
Path Params
fieldId
stringÂ
required
Body Params application/json
Details of a custom field.
description
stringÂ
optional
name
stringÂ
optional
searcherKey
enum<string>Â
optional
null, otherwise you must specify the valid searcher for the field type, as listed below (abbreviated values shown):cascadingselect: cascadingselectsearcherdatepicker: daterangedatetime: datetimerangefloat: exactnumber or numberrangegrouppicker: grouppickersearcherimportid: exactnumber or numberrangelabels: labelsearchermulticheckboxes: multiselectsearchermultigrouppicker: multiselectsearchermultiselect: multiselectsearchermultiuserpicker: userpickergroupsearchermultiversion: versionsearcherproject: projectsearcherradiobuttons: multiselectsearcherreadonlyfield: textsearcherselect: multiselectsearchertextarea: textsearchertextfield: textsearcherurl: exacttextsearcheruserpicker: userpickergroupsearcherversion: versionsearcherAllowed values:
com.atlassian.jira.plugin.system.customfieldtypes:cascadingselectsearchercom.atlassian.jira.plugin.system.customfieldtypes:daterangecom.atlassian.jira.plugin.system.customfieldtypes:datetimerangecom.atlassian.jira.plugin.system.customfieldtypes:exactnumbercom.atlassian.jira.plugin.system.customfieldtypes:exacttextsearchercom.atlassian.jira.plugin.system.customfieldtypes:grouppickersearchercom.atlassian.jira.plugin.system.customfieldtypes:labelsearchercom.atlassian.jira.plugin.system.customfieldtypes:multiselectsearchercom.atlassian.jira.plugin.system.customfieldtypes:numberrangecom.atlassian.jira.plugin.system.customfieldtypes:projectsearchercom.atlassian.jira.plugin.system.customfieldtypes:textsearchercom.atlassian.jira.plugin.system.customfieldtypes:userpickergroupsearchercom.atlassian.jira.plugin.system.customfieldtypes:versionsearcher
Examples
Responses
🟢204Returned if the request is successful.
application/json
Body
No schema defined
🟠400Returned if the request is not valid.
🟠401Returned if the authentication credentials are incorrect or missing.
🟠403Returned if the user does not have the required permissions.
🟠404Returned if the custom field is not found.
Modified at 2023-07-13 03:27:27