Field: _id
Title: Identifier
Description: A unique identifier for the record.
Type: string

Field: _experience
Type: object

Field: decisioning
Type: object

Field: criteria
Title: Criteria
Description: Defines a set of decision criteria where each contains a set of constraints.
Type: array

Field: description
Title: Description
Description: Criterion description. It is used to convey human readable intentions on how or why this criterion was constructed and how it is affecting the decision.
Type: string

Field: optionSelection
Title: Option Selection
Description: The option selection defines the validity/applicability of options in this context.
Type: object

• Description

  Field: description
  Title: Description
  Description: Option selection description. It is used to convey human readable intentions on how or why this option selection was constructed and/or what option will match.
  Type: string

• Option Filter

  Field: filter
  Title: Option Filter
  Description: The reference to a collection qualifier (previously known as “tag”) based filter that matches options from an inventory using their attached collection qualifiers. The value is the URI (@id) of the decision rule that is referenced. See schema https://ns.adobe.com/experience/decisioning/filter.
  Type: string

• Profile Constraint Type

  Field: optionSelectionType
  Title: Profile Constraint Type
  Description: Determines if any constraints are currently set and how the constraints are expressed. It could be through a filter query or through one or more audience memberships.
  Type: string
  Possible values: “none” (default), “directList”, “filter”

• Option List

  Field: options
  Title: Option List
  Description: A list that directly specifies the options without evaluating a filter query. Either an option list or an option filter rule can be specified.
  Type: array

Field: placements
Title: Placement Restrictions
Description: The placement constraint states that this criterion is only applicable for the listed placements. Only when the targeted placement is in the xdm:placements list is the option selection considered. Otherwise the entire decision criteria is skipped. When the ‘xdm:placements’ list is omitted or empty, the criterion is considered for any targeted placement. The placements listed here impose implicit criteria for the option selection. An option to be considered must have a representation for the targeted placement.
Type: array

• Placement Identifier

  Title: Placement Identifier
  Description: A reference to a placement entity. The value is the URI (@id) of the placement that is referenced. See schema https://ns.adobe.com/experience/decisioning/placement.
  Type: string

Field: profileConstraints
Title: Profile Constraint
Description: The profile constraint decides if an option selection is eligible for this profile identity at this moment, in this context. If the profile constraint does not need to consider values of each of the option, i.e. it is invariant of the options from the option selection, the profile constraint that evaluates to ‘false’ cancels out the entire option selection. On the other hand, a profile constraint rule that takes an option as a parameter is evaluated for each qualifying option of the option selection.
Type: object

Field: description
Title: Description
Description: Profile constraint description. It is used to convey human readable intentions on how or why this profile constraint was constructed and/or what option will be included or excluded by it.
Type: string

Field: eligibilityRule
Title: Eligibility Rule
Description: A reference to a decision rule that evaluates to true or false for a given profile and/or other given contextual XDM objects. The rule is used to decide if the option qualifies for a given profile. The value is the URI (@id) of the decision rule that is referenced. See schema https://ns.adobe.com/experience/decisioning/rule.
Type: string

Field: profileConstraintType
Title: Profile Constraint Type
Description: Determines if any constraints are currently set and how the constraints are expressed. It could be through a rule or through one or more audience memberships.
Type: string
Possible values:

• “none” (default)
• “eligibilityRule”: “The profile constraint is expressed as a single rule that must evaluate to true before the constrained action is allowed.”
• “anySegments”: “The profile constraint is expressed as one or more audiences and the profile must be a member of at least one of them before the constrained action is allowed.”
• “allSegments”: “The profile constraint is expressed as one or more audiences and the profile must be a member of all of them before the constrained action is allowed.”
• “rules”: “The profile constraint is expressed as a number of different rules, e.g. eligibility, applicability, suitability, which all must evaluate to true before the constrained action is allowed.”

Field: segmentIdentities
Title: Segment Identifiers
Description: Identifiers of the audience.
Type: array

• Identifier

  Field: _id
  Title: Identifier
  Description: Identity of the audience in the related namespace.
  Type: string

• namespace

  Field: namespace
  Title: Namespace
  Description: The namespace associated with the xid attribute.
  Type: object
  Required: “code”

  • Code

    Field: code
    Title: Code
    Description: The code is a human readable identifier for the namespace and can be used to request the technical namespace id which is used for identity graph processing.
    Type: string

• Experience identifier

  Field: xid
  Title: Experience identifier
  Description: When present, this value represents a cross-namespace identifier that is unique across all namespace-scoped identifiers in all namespaces.
  Type: string

Field: ranking
Title: Ranking Details
Description: Rank (priority). Defines how the “best option” is determined given the context of the decision criterion. Among all the selected options that meet the profile constraints, the ranking will decide the top (or top N) option(s) to be proposed.
Type: object

Field: order
Title: Order Evaluation
Description: Evaluation of a relative order of one or more decision options. Options with higher ordinal values are selected over any options with lower ordinal values. The values determined by this method can be ordered but distances between them cannot be measured and neither can sums nor products be calculated. The median and the mode are the only measures of central tendency that can be used for ordinal data.
Type: object

• Scoring Function

  Field: function
  Title: Scoring Function
  Description: A reference to a function that computes a numerical score for this decision option. Decision options will then be ordered (ranked) by that score. The value of this property is the URI (@id) of the function to be invoked with on option at a time. See schema https://ns.adobe.com/experience/decisioning/function.
  Type: string

• Order Evaluation Type**

  Field: orderEvaluationType
  Title: Order Evaluation Type
  Description: Specifies which order evaluation mechanism is used, static priority of the decision options, a scoring function that calculates a numeric value for every option or an AI model that receives a list to order it.
  Type: string
  Possible values: “static”, “scoringFunction”, “rankingStrategy”

• Ranking Strategy

  Field: rankingStrategy
  Title: Ranking Strategy
  Description: A reference to a strategy that ranks a list of decision option. Decision options will be returned in an ordered list. The value of this property is the URI (@id) of the function to be invoked with on option at a time. See schema https://ns.adobe.com/experience/decisioning/rankingStrategy.
  Type: string

Field: priority
Title: Priority
Description: The priority of a single decision option relative to all other options. Options for which no order function is given are prioritized using this property. Options with higher priority values are selected before any lower priority options. If two or more qualifying options share the highest priority value, one is chosen at uniform random and used for the decision proposition.
Type: integer
Minimum value: 0
Default value: 0

Field: endTime
Title: Activity End Date and Time
Description: Decision (formerly known as activity) end date and end time. The property has the semantic of schema.org’s ‘endTime’ property defined on https://schema.org/Action.
Type: string

Field: fallback
Title: Fallback Option
Description: The reference to a fallback option that is used when decisioning in the context of this decision does not qualify any of the regular options (this typically happens when hard constraints are applied). The value is the URI (@id) of the fallback option that is referenced.
Type: string

Field: name
Title: Activity Name
Description: Decision (formerly known as activity) name that is displayed in various user interfaces.
Type: string

Field: startTime
Title: Activity Start Date and Time
Description: Decision (formerly known as activity) start date and end time. The property has the semantic of schema.org’s ‘startTime’ property defined on https://schema.org/Action.
Type: string

Field: _repo
Type: object

Field: etag
Title: Activity ETag
Description: The revision that the decision (formerly known as activity) object was at when the snapshot was taken.
Type: string