Developer Portal for YouTrack and Hub Help

Custom Field Defaults

This resource lets you read and update default settings of a custom field in a project.

Resource

/api/admin/customFieldSettings/customFields/{fieldID}/fieldDefaults

Returned entity

CustomFieldDefaults. For the description of the entity attributes, see Supported Fields section.

CustomFieldDefaults attributes

Represents default project-related settings of the custom field. These settings are applied at the moment when the custom field is attached to a project. After that, any changes in default settings do not affect the field settings for this project.

This table describes attributes of the CustomFieldDefaults entity.

  • To receive an attribute in the response from the server, specify it explicitly in the fields request parameter.

  • To update an attribute, provide it in the body of a POST request.

Field

Type

Description

id

String

The ID of the default custom field settings. Read-only.

canBeEmpty

Boolean

Indicates whether this field can have empty value in the issue.

emptyFieldText

String

The text that is shown as a placeholder when the field is empty. Can be null.

isPublic

Boolean

If `true`, then a user needs Read Issue and Update Issue permissions to access this field. Otherwise, the field is considered private, and Read Issue Private Fields and Update Issue Private Fields permissions are required.

parent

CustomField

Reference to the custom field. Read-only.

Last modified: 9 May 2022