Brief Description of the API
Copy
The Configurator Services API consists of several methods. This section describes the purpose of these methods.
Configurator Services works with any custom business model. The Scope Builder method takes the customer data and translates it into a Scope object that is used by the Configurator Services API. The Scope object is used by the Configurator Services API to solve the appropriate task.
The following API methods use a scope object:
cfg_GetScopeStucture. This method creates a representation of the Scope object: it uses scope_builder to build the Scope object, which is then serialized into either AML or JSON. The method can be used to:
- display a list of available choices
- get actual data inside implementation of new server methods
- for debugging purposes
cfg_GetValidCombinations. This method is designed to find a list of valid combinations. Valid Combination is a set of variables with assigned values to them, which leads to valid solution. It can be used to:
- find all valid combinations
- find at least one valid combination
- validate the current scope
- validate values selected for Variables
- validate an expression
cfg_ValidateScope. This method is designed to validate the Scope. The method has two validations:
- if Scope has at least one valid combination
if each value can be assigned to a Variable for at least one valid combination
The method can be used to:
- find out if the specified Scope is solvable
- determine if unreachable values exist
- cfg_GetIntersectingExpressions. This method is designed to find the intersections of expressions. Expressions are intersecting if the Scope has at least one valid combination with specified expressions applied.
- cfg_GetConflicts. This method is designed to find the reason why the current Scope is unsolvable. The method can be used to:
- get data that describes reasons
- debug why you have no solutions