DocRule
APIs for the DocRule (Rule Manager) feature.
A DocRule defines a commercial rule applied to documents. Rules are grouped in DocRuleGroups and carry a RuleDefinition decision tree (condition groups with conditions, effect definitions and range groups carrying per-tier thresholds and effect values), touchpoints (apps, marketplaces, doc-type-groups), exclusions and audiences/baskets resolved through PerimeterSets.
This reference area exposes the enumerations and the condition/effect type lookup tables used when building a RuleDefinition.
listDocRuleConditionEvaluationModes
Returns the collection of available DocRule condition evaluation modes. The reference data values are
createDocRuleSubCondition
Creates a sub-condition in the RuleDefinition of the DocRule. The parent condition is referenced by
updateDocRuleSubCondition
Updates the sub-condition identified by `elementId` in the RuleDefinition of the DocRule. Returns the
deleteDocRuleSubCondition
Deletes the sub-condition identified by `elementId` from the RuleDefinition of the DocRule.
upsertAudience
Creates or updates the user OR customer audience of the DocRule through its linked PerimeterSet
deleteAudience
Deletes the audience relation of the DocRule. If the linked perimeter is **Released**, the relation
upsertItemBasket
Creates or updates the Item basket attached to a Condition or Effect of the DocRule through its
deleteItemBasket
Deletes the Item basket attached to a Condition or Effect of the DocRule. If the linked perimeter is
getDocRuleDefinition
Returns the full serialized RuleDefinition of the DocRule: the schema version and the list of
createDocRuleConditionGroup
Creates a top-level condition group in the RuleDefinition of the DocRule. As a top-level element it
updateDocRuleConditionGroup
Updates the condition group identified by `elementId` in the RuleDefinition of the DocRule. Returns the
deleteDocRuleConditionGroup
Deletes the condition group identified by `elementId` from the RuleDefinition of the DocRule.
cloneDocRuleConditionGroup
Duplicates the condition group identified by `elementId` within the RuleDefinition of the DocRule,
createDocRuleCondition
Creates a condition in the RuleDefinition of the DocRule. The parent condition group is referenced by
updateDocRuleCondition
Updates the condition identified by `elementId` in the RuleDefinition of the DocRule. Returns the full
deleteDocRuleCondition
Deletes the condition identified by `elementId` from the RuleDefinition of the DocRule.
createDocRuleRangeGroup
Creates a range group (tier) in the RuleDefinition of the DocRule. The parent condition group is
updateDocRuleRangeGroup
Updates the range group identified by `elementId` in the RuleDefinition of the DocRule. Returns the
deleteDocRuleRangeGroup
Deletes the range group identified by `elementId` from the RuleDefinition of the DocRule.
updateDocRuleRangeSubCondition
Updates the per-tier threshold of the sub-condition `subConditionId` within the range group
updateDocRuleRangeEffect
Updates the per-tier value of the effect `effectId` within the range group `rangeGroupId` (the
createDocRuleEffect
Creates an effect definition in the RuleDefinition of the DocRule. The parent condition group is
updateDocRuleEffect
Updates the effect identified by `elementId` in the RuleDefinition of the DocRule. Returns the full
deleteDocRuleEffect
Deletes the effect definition identified by `elementId` from the RuleDefinition of the DocRule.
replaceDocRuleEffectPrices
Replaces the currency and the net-price item structure (which items receive a net price and in which
addDocRuleExclusions
Adds one or more mutual-exclusion rules to the DocRule: the ids in the request body are added to the
deleteDocRuleExclusion
Removes a single rule from the DocRule mutual exclusions.
canUseDocRuleCode
Checks whether the given `code` is available for the DocRule, i.e. not already used by another
canDraftDocRuleOwnershipChange
Invoke this service to find out if the draft owner of the DocRule can be changed.
changeDraftDocRuleOwnership
The draft of a DocRule relates to two user profiles:
listEligibleActiveDocRules
Returns the DocRules eligible to be added as mutual exclusions of the given DocRule. The result
replaceDocRuleDocTypeGroups
Fully replaces the document type groups associated to the DocRule with the set provided in the
listDocTypeGroupsForDocRule
Returns all the document type groups that can be linked to the given DocRule (the
replaceDocRuleMarketplaces
Fully replaces the set of marketplaces on which the DocRule is active with the set provided in the
listDocRuleGroup
Returns a list of `DocRuleGroup`s.
createDocRuleGroup
Creates a `DocRuleGroup` resource.
getDocRuleGroup
Returns a single `DocRuleGroup`.
updateDocRuleGroup
Updates a `DocRuleGroup` resource.
deleteDocRuleGroup
Deletes the `DocRuleGroup` with the given `id`.
listDocRule
Returns a list of `DocRule`s.
createDocRule
Creates a `DocRule` resource. Only `organizationId` and `docRuleGroupId` are required; everything
getDocRule
Returns a single `DocRule` header, including the resolved audiences and the touchpoint
updateDocRule
Updates a draft `DocRule` header. Only the following fields can be updated: `code`, `title`,
deleteDocRule
Deletes the draft `DocRule` with the given `id`.
editDocRule
Creates an edit draft of a published `DocRule`.
publishDocRule
Publishes a draft `DocRule`.
cloneDocRule
Clones a `DocRule`. Creates a brand new draft rule, copying the cloned one and applying the
replaceDocRuleTags
Replace the tags associated to the given `DocRule` id.
listDocRuleConditionTypes
Returns the collection of available DocRule condition types.
listDocRuleEffectTypes
Returns the collection of available DocRule effect types.