Skip to main content

BusinessRuleFieldDefinition

Field definition template for business rule input and output mapping.

Defines the structure, data type, and validation rules for fields that can be used in business rule expressions. Supports hierarchical field organization with nested sub-fields and complex data structures for comprehensive rule modeling.

type BusinessRuleFieldDefinition {
id: ID!
name: [LocalizedString!]!
path: String!
type: BusinessRuleExpressionTypes!
fields: [BusinessRuleActionField!]
expressions: [BusinessRuleFieldDefinition!]
}

Fields

BusinessRuleFieldDefinition.id ● ID! non-null scalar

Unique identifier for this field definition within the system

BusinessRuleFieldDefinition.name ● [LocalizedString!]! non-null object

Human-readable name of the field in multiple languages for international support

BusinessRuleFieldDefinition.path ● String! non-null scalar

JSONPath expression defining the location of this field within the data structure (e.g., 'order.customer.email')

BusinessRuleFieldDefinition.type ● BusinessRuleExpressionTypes! non-null enum

Data type of the field determining available operations and validation rules

BusinessRuleFieldDefinition.fields ● [BusinessRuleActionField!] list object

Available action fields for complex types that support nested operations and transformations

BusinessRuleFieldDefinition.expressions ● [BusinessRuleFieldDefinition!] list object

Nested field definitions for complex types enabling hierarchical data structure modeling

Member Of

BusinessRuleFieldDefinition object ● BusinessRuleFieldDefinitionGroup object