Developer Portal for YouTrack and Hub Help

IssueCustomField

Represents a custom field along with its value in the particular issue.

The IssueCustomField is an abstract ancestor for all types of custom fields in issues. The actual type of the custom field depends on field settings in the particular project.

Each IssueCustomField entity, regardless of its type, has the following attributes:

  • $type: the unique type of the issue custom field. You must provide this attribute when you update the custom field in an issue.

  • id: the entity ID of the issue custom field.

  • name: the string name of the custom field.

  • projectCustomField: the reference to the settings of the custom field in the project.

  • value: the value assigned to the custom field in the issue. Depending on the type of the field, this attribute can store a single value or an array of values.

Extended by:

This table describes attributes of the IssueCustomField 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 custom field in the issue. Read-only.

name

String

The name of the custom field. Read-only.

projectCustomField

ProjectCustomField

Reference to the custom field settings for the particular project. Read-only.

value

The value assigned to the custom field in the issue. Depending on the type of the field, this attribute can store a single value or an array of values. Read-only.

Last modified: 9 May 2022