Developer Portal for YouTrack and Hub Help

StateMachineIssueCustomField

Represents the issue custom field that is managed by a state-machine rule in workflow.

Extends SingleValueIssueCustomField

This table describes attributes of the StateMachineIssueCustomField 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 issue custom field regulated by a state-machine rule. Read-only.

value

The value assigned to the custom field in the issue. Can be null.

event

Event

The name of the transition that is used to set a value for the StateMachineIssueCustomField. The names of transitions are set in the state-machine script. For more details, see State-machine Rules.

Use this property for updating StateMachineIssueCustomField. When you read a StateMachineIssueCustomField entity, this property is always null.

Read-only.

possibleEvents

Array of Events

The list of possible events that you can send to update the StateMachineIssueCustomField. It's the list of transitions available in the current state according to the state-machine rule. For more details, see State-machine Rules. 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.

Last modified: 29 September 2022