Skip to content

Latest commit

 

History

History
222 lines (117 loc) · 6.91 KB

option.schema.md

File metadata and controls

222 lines (117 loc) · 6.91 KB
Raw

Decision Option Schema

https://ns.adobe.com/experience/decisioning/option

This class is used to capture minimum properties that are required to define the concept of a decision option. A decision option represents one of the possible selections or choices for a decision.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Stable No Forbidden Permitted adobe/experience/decisioning/option.schema.json

Schema Hierarchy

  • Decision Option https://ns.adobe.com/experience/decisioning/option

Decision Option Example

{
  "@id": "personalized-offer:e526a1503bf29e9",
  "https://ns.adobe.com/experience/decisioning/name": "Introduction to machine learning",
  "https://ns.adobe.com/experience/decisioning/characteristics": {
    "syllable": "ML001",
    "duration": "30",
    "durationUnit": "minutes",
    "level": "Beginner"
  }
}

Decision Option Properties

Property Type Required Defined by
@id string Optional Record Schema
https://ns.adobe.com/experience/decisioning/characteristics object Optional Decision Option (this schema)
https://ns.adobe.com/experience/decisioning/name string Optional Decision Option (this schema)
repo:etag string Optional Decision Option (this schema)
* any Additional this schema allows additional properties

@id

Identifier

A unique identifier for the record.

@id

@id Type

string

  • format: uri-reference – URI Reference (according to RFC3986)

https://ns.adobe.com/experience/decisioning/characteristics

Decision Option Characteristics

Additional properties or attributes belonging to this particular decision option. Different instances can have different characteristics (keys in the map). The characteristics are name value pairs used to distinguish one decision option from others. Characteristics are used as values in content that represents this decision option and as features to analyze and optimize the performance of an option. When every instance has the same attribute or property, that aspect should be modeled as an extension schema that derives from decision option detail.

https://ns.adobe.com/experience/decisioning/characteristics

  • is optional
  • type: object
  • defined in this schema

https://ns.adobe.com/experience/decisioning/characteristics Type

object with following properties:

Property Type Required

https://ns.adobe.com/experience/decisioning/name

Decision Option Name

Option name. The name is displayed in various user interfaces.

https://ns.adobe.com/experience/decisioning/name

  • is optional
  • type: string
  • defined in this schema

https://ns.adobe.com/experience/decisioning/name Type

string

repo:etag

Decision Option ETag

The revision that the decision option object was at when the snapshot was taken.

repo:etag

  • is optional
  • type: string
  • defined in this schema

repo:etag Type

string

Decision Option Definitions

Property Type Group
https://ns.adobe.com/experience/decisioning/optionID string https://ns.adobe.com/experience/decisioning/option#/definitions/option-snapshot-identifier
https://ns.adobe.com/experience/decisioning/propositionsProfile reference https://ns.adobe.com/experience/decisioning/option#/definitions/option-snapshot-measures
https://ns.adobe.com/experience/decisioning/propositionsTotal reference https://ns.adobe.com/experience/decisioning/option#/definitions/option-snapshot-measures
https://ns.adobe.com/experience/decisioning/tags string[] https://ns.adobe.com/experience/decisioning/option#/definitions/option-snapshot-tags

https://ns.adobe.com/experience/decisioning/optionID

Decision Option Identifier

A unique identifier for the decision option.

https://ns.adobe.com/experience/decisioning/optionID

  • is optional
  • type: string
  • defined in this schema

https://ns.adobe.com/experience/decisioning/optionID Type

string

  • format: uri-reference – URI Reference (according to RFC3986)

https://ns.adobe.com/experience/decisioning/propositionsProfile

The number of times a particular option was proposed so far to a particular profile. When this metric is present the record or time-series entity must include an IdentityMap the profile.

https://ns.adobe.com/experience/decisioning/propositionsProfile

  • is optional
  • type: reference
  • defined in this schema

https://ns.adobe.com/experience/decisioning/propositionsProfile Type

  • – https://ns.adobe.com/xdm/data/measure

https://ns.adobe.com/experience/decisioning/propositionsTotal

The total number a particular option was proposed so far across all profiles.

https://ns.adobe.com/experience/decisioning/propositionsTotal

  • is optional
  • type: reference
  • defined in this schema

https://ns.adobe.com/experience/decisioning/propositionsTotal Type

  • – https://ns.adobe.com/xdm/data/measure

https://ns.adobe.com/experience/decisioning/tags

Decision Option Tags

The set of tags associated with this option. The tags are used indicate catetoegies (dimensions) that the option belonged to at the time the proposition was made.

https://ns.adobe.com/experience/decisioning/tags

  • is optional

  • type: string[]

  • defined in this schema

https://ns.adobe.com/experience/decisioning/tags Type

Array type: string[]

All items must be of the type: string

  • format: uri-reference – URI Reference (according to RFC3986)

An identifier of a Tag object. The value is the @id of the Tag that is referenced. See Tag schema https://ns.adobe.com/experience/decisioning/tag