DecisionTreeField | nice-cxone-acd-agent-apps

Represents a single question or input field in the decision tree.

Hierarchy

DecisionTreeField

Index

Properties

Optional choiceSetOptions

choiceSetOptions?: { title: string; value: string }[]

Optional choices

choices?: { title: string; value: string }[]

dataType

dataType: string

Optional description

description?: string

Optional description shown as an info-icon tooltip next to the field label.

Optional errorMessage

errorMessage?: string

Optional custom error message to display when validation fails.

Optional fieldId

fieldId?: string

Unique identifier for the field within the decision tree.

Optional isRequired

isRequired?: boolean

Whether the field is required (real API key: 'isRequired').

Optional label

label?: string

Legacy label field retained for backward compatibility with mock configs.

Optional mandatory

mandatory?: boolean

Legacy mandatory field retained for backward compatibility with mock configs.

Optional multiChoiceSetOptions

multiChoiceSetOptions?: { title: string; value: string }[]

Optional name

name?: string

Short display name for the field as configured in the admin UI (real API key: 'name').

Optional options

options?: string[]

Optional placeholderText

placeholderText?: string

Optional placeholder text shown inside the input when empty.

Optional preCondition

preCondition?: SectionPreCondition

Pre-condition controlling field-level visibility.

Optional questionId

questionId?: string

Runtime identifier used by the API. Typically matches CapturedQuestion.questionId from backend responses.

Optional questionText

questionText?: string

Full question text for this field (real API key: 'questionText'). Matches the WS capturedResponses.questionText used in Interview Mode. Preferred label source; falls back to name, then label.

Optional value

value?: DecisionTreeInputValue