Get custom field contexts default values

GET

/rest/api/3/field/{fieldId}/context/defaultValue

Issue custom field contexts

Returns a paginated list of defaults for a custom field. The results can be filtered by contextId, otherwise all values are returned. If no defaults are set for a context, nothing is returned.
The returned object depends on type of the custom field:

CustomFieldContextDefaultValueDate (type datepicker) for date fields.

CustomFieldContextDefaultValueDateTime (type datetimepicker) for date-time fields.

CustomFieldContextDefaultValueSingleOption (type option.single) for single choice select lists and radio buttons.

CustomFieldContextDefaultValueMultipleOption (type option.multiple) for multiple choice select lists and checkboxes.

CustomFieldContextDefaultValueCascadingOption (type option.cascading) for cascading select lists.

CustomFieldContextSingleUserPickerDefaults (type single.user.select) for single users.

CustomFieldContextDefaultValueMultiUserPicker (type multi.user.select) for user lists.

CustomFieldContextDefaultValueSingleGroupPicker (type grouppicker.single) for single choice group pickers.

CustomFieldContextDefaultValueMultipleGroupPicker (type grouppicker.multiple) for multiple choice group pickers.

CustomFieldContextDefaultValueURL (type url) for URLs.

CustomFieldContextDefaultValueProject (type project) for project pickers.

CustomFieldContextDefaultValueFloat (type float) for floats (floating-point numbers).

CustomFieldContextDefaultValueLabels (type labels) for labels.

CustomFieldContextDefaultValueTextField (type textfield) for text fields.

CustomFieldContextDefaultValueTextArea (type textarea) for text area fields.

CustomFieldContextDefaultValueReadOnly (type readonly) for read only (text) fields.

CustomFieldContextDefaultValueMultipleVersion (type version.multiple) for single choice version pickers.

CustomFieldContextDefaultValueSingleVersion (type version.single) for multiple choice version pickers.

Forge custom fields types are also supported, returning:

CustomFieldContextDefaultValueForgeStringFieldBean (type forge.string) for Forge string fields.

CustomFieldContextDefaultValueForgeMultiStringFieldBean (type forge.string.list) for Forge string collection fields.

CustomFieldContextDefaultValueForgeObjectFieldBean (type forge.object) for Forge object fields.

CustomFieldContextDefaultValueForgeDateTimeFieldBean (type forge.datetime) for Forge date-time fields.

CustomFieldContextDefaultValueForgeGroupFieldBean (type forge.group) for Forge group fields.

CustomFieldContextDefaultValueForgeMultiGroupFieldBean (type forge.group.list) for Forge group collection fields.

CustomFieldContextDefaultValueForgeNumberFieldBean (type forge.number) for Forge number fields.

CustomFieldContextDefaultValueForgeUserFieldBean (type forge.user) for Forge user fields.

CustomFieldContextDefaultValueForgeMultiUserFieldBean (type forge.user.list) for Forge user collection fields.

Permissions required: Administer Jira global permission.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://jira.local:8080/jira/rest//rest/api/3/field//context/defaultValue'

Response Example

200 - Success

{
  "maxResults": 50,
  "startAt": 0,
  "total": 3,
  "isLast": true,
  "values": [
    {
      "type": "option.single",
      "contextId": "10100",
      "optionId": "10001"
    },
    {
      "type": "option.single",
      "contextId": "10101",
      "optionId": "10003"
    },
    {
      "type": "option.single",
      "contextId": "10103"
    }
  ]
}

Request

Path Params

fieldId

string

required

The ID of the custom field, for example customfield\_10000.

Query Params

contextId

array[string]

optional

The IDs of the contexts.

startAt

integer

optional

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

maxResults

integer

optional

The maximum number of items to return per page.

Responses

🟢200Returned if the request is successful.

application/json

Body

A page of items.

isLast

boolean

read-onlyoptional

Whether this is the last page.

maxResults

integer <int32>

read-onlyoptional

The maximum number of items that could be returned.

string <uri>

read-onlyoptional

If there is another page of results, the URL of the next page.

self

string <uri>

read-onlyoptional

The URL of the page.

startAt

integer <int64>

read-onlyoptional

The index of the first item returned.

total

integer <int64>

read-onlyoptional

The number of items returned.

values

array[null (CustomFieldContextDefaultValue) {27}]

read-onlyoptional

The list of items.

object

CustomFieldContextDefaultValueCascadingOption

optional

The default value for a cascading select custom field.

object

CustomFieldContextDefaultValueMultipleOption

optional

The default value for a multi-select custom field.

object

CustomFieldContextDefaultValueSingleOption

optional

The default value for a single select custom field.

object

CustomFieldContextSingleUserPickerDefaults

optional

Defaults for a User Picker (single) custom field.

object

CustomFieldContextDefaultValueMultiUserPicker

optional

The default value for a User Picker (multiple) custom field.

object

CustomFieldContextDefaultValueSingleGroupPicker

optional

The default value for a group picker custom field.

object

CustomFieldContextDefaultValueMultipleGroupPicker

optional

The default value for a multiple group picker custom field.

object

CustomFieldContextDefaultValueDate

optional

The default value for a Date custom field.

object

CustomFieldContextDefaultValueDateTime

optional

The default value for a date time custom field.

object

CustomFieldContextDefaultValueURL

optional

The default value for a URL custom field.

object

CustomFieldContextDefaultValueProject

optional

The default value for a project custom field.

object

CustomFieldContextDefaultValueFloat

optional

Default value for a float (number) custom field.

object

CustomFieldContextDefaultValueLabels

optional

Default value for a labels custom field.

object

CustomFieldContextDefaultValueTextField

optional

The default text for a text custom field.

object

CustomFieldContextDefaultValueTextArea

optional

The default text for a text area custom field.

object

CustomFieldContextDefaultValueReadOnly

optional

The default text for a read only custom field.

object

CustomFieldContextDefaultValueSingleVersionPicker

optional

The default value for a version picker custom field.

object

CustomFieldContextDefaultValueMultipleVersionPicker

optional

The default value for a multiple version picker custom field.

object

CustomFieldContextDefaultValueForgeStringField

optional

The default text for a Forge string custom field.

object

CustomFieldContextDefaultValueForgeMultiStringField

optional

The default text for a Forge collection of strings custom field.

object

CustomFieldContextDefaultValueForgeObjectField

optional

The default value for a Forge object custom field.

object

CustomFieldContextDefaultValueForgeDateTimeField

optional

The default value for a Forge date time custom field.

object

CustomFieldContextDefaultValueForgeGroupField

optional

The default value for a Forge group custom field.

object

CustomFieldContextDefaultValueForgeMultiGroupField

optional

The default value for a Forge collection of groups custom field.

object

CustomFieldContextDefaultValueForgeNumberField

optional

Default value for a Forge number custom field.

object

CustomFieldContextDefaultValueForgeUserField

optional

Defaults for a Forge user custom field.

object

CustomFieldContextDefaultValueForgeMultiUserField

optional

Defaults for a Forge collection of users custom field.

🟠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

Create custom field context

Set custom field contexts default values