getDefaultValues method

Future<PageBeanCustomFieldContextDefaultValue> getDefaultValues({ required String fieldId, List<int>? contextId, int? startAt, int? maxResults, })

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.

Implementation

Future<PageBeanCustomFieldContextDefaultValue> getDefaultValues(
    {required String fieldId,
    List<int>? contextId,
    int? startAt,
    int? maxResults}) async {
  return PageBeanCustomFieldContextDefaultValue.fromJson(await _client.send(
    'get',
    'rest/api/3/field/{fieldId}/context/defaultValue',
    pathParameters: {
      'fieldId': fieldId,
    },
    queryParameters: {
      if (contextId != null)
        'contextId': contextId.map((e) => '$e').join(','),
      if (startAt != null) 'startAt': '$startAt',
      if (maxResults != null) 'maxResults': '$maxResults',
    },
  ));
}