Skip to content
Settings

EntityCriteriaCalculationRequest

Schema definition for EntityCriteriaCalculationRequest

EntityCriteriaCalculationRequest

requestIdstringrequired
Request ID.
entityIdstringrequired
Entity ID.
criteriaIdstringrequired
Criteria ID.
criteriaNamestringrequired
Criteria name.
targetstringrequired
Target to which this condition is attached. NA is reserved for future cases.
Allowed values: NA, WORKFLOW, PROCESSOR, TRANSITION
workflowWorkflowInfo
Workflow information, available for targets WORKFLOW, PROCESSOR, TRANSITION.
processorProcessorInfo
Processor information, available for targets PROCESSOR.
transitionTransitionInfo
Transition information, available for targets TRANSITION and PROCESSOR.
transactionIdstring
Transaction ID.
parametersany
Configured parameters, if any.

This schema defines the structure and validation rules for EntityCriteriaCalculationRequest.

  • requestId (string, required): Request ID.
  • entityId (string, required): Entity ID.
  • criteriaId (string, required): Criteria ID.
  • criteriaName (string, required): Criteria name.
  • target (string, required): Target to which this condition is attached. NA is reserved for future cases.
  • workflow (object): Workflow information, available for targets WORKFLOW, PROCESSOR, TRANSITION.
  • processor (object): Processor information, available for targets PROCESSOR.
  • transition (object): Transition information, available for targets TRANSITION and PROCESSOR.
  • transactionId (string): Transaction ID.
  • parameters (any): Configured parameters, if any.
  • payload (object):

See other schemas in the processing category.