Skip to main content

businessRuleFieldDefinitions

Retrieve field definitions for business rule input and output mapping by group name.

Returns the complete field definition group containing all available fields, their types, paths, and validation rules. Used for building business rule expressions, input validation, and output formatting.

Possible errors:

  • BUSINESS_DEFINITIONS_NOT_FOUND: Field definition group with the specified name does not exist
businessRuleFieldDefinitions(
  name: String!
): BusinessRuleFieldDefinitionGroup!

Arguments​

businessRuleFieldDefinitions.name ● String! non-null scalar​

Name of the field definition group to retrieve (e.g., 'order', 'customer', 'product')

Type​

BusinessRuleFieldDefinitionGroup object​

Collection of related field definitions organized by domain context for business rule mapping.

Groups field definitions by logical domains (e.g., order, customer, product) to provide organized access to available fields. Supports hierarchical organization with root groups and nested structures for complex data modeling.