Developer Portal for YouTrack and Hub Help

StateProjectCustomField

Represents project settings for a state field.

Extends BundleProjectCustomField

This table describes attributes of the StateProjectCustomField 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 state-type project custom field. Read-only.

bundle

StateBundle

The set of states that can be set as values for this custom field. Can be null.

defaultValues

Array of StateBundleElements

The values that are set in a new issue by default.

field

CustomField

The custom field in the project. Read-only. Can be null.

project

Project

The project where the custom field belongs. Read-only. Can be null.

canBeEmpty

Boolean

If true, the custom field can have empty value, otherwise false.

emptyFieldText

String

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

ordinal

Int

The position number of this field on the list of project custom fields.

isPublic

Boolean

If true, the basic Read Issue and Update Issue permissions are sufficient to access this field. If false, the Read Issue Private Fields and Update Issue Private Fields permissions are required.

hasRunningJob

Boolean

If true, there is a background job running for this field. In this case, some field operations may be temporary inaccessible. Read-only.

condition

CustomFieldCondition

The condition for showing the custom field. Can be null.

Last modified: 30 May 2022