Skip to content

Latest commit

 

History

History
173 lines (88 loc) · 4.76 KB

decision-scope.schema.md

File metadata and controls

173 lines (88 loc) · 4.76 KB
Raw

Decision Scope Schema

https://ns.adobe.com/experience/decisioning/decision-scope

A Scope is basically a pair consisting of an offer activity id and an offer placement id. They are used to encapsulate a specific decisioning request.

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

Schema Hierarchy

  • Decision Scope https://ns.adobe.com/experience/decisioning/decision-scope

Decision Scope Properties

Property Type Required Defined by
@id string Optional Record Schema
https://ns.adobe.com/experience/decisioning/activity string Required Decision Scope (this schema)
https://ns.adobe.com/experience/decisioning/description string Optional Decision Scope (this schema)
https://ns.adobe.com/experience/decisioning/itemCount integer Optional Decision Scope (this schema)
https://ns.adobe.com/experience/decisioning/name string Required Decision Scope (this schema)
https://ns.adobe.com/experience/decisioning/placement string Required Decision Scope (this schema)
repo:etag string Optional Decision Scope (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/activity

Activity Id

@id of offer-activity (part of activity-placement pair defining scope).

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

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

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

string

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

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

Scope Description

Scope description. It is used to convey human readable intentions on the context of the decision being requested.

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

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

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

string

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

Item Count

Count of max number of responses.

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

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

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

integer

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

Scope Name

The Scope's external human-readable representation to clients. Property has the semantic of schema.org's 'name' property defined on http://schema.org/Thing

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

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

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

string

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

Placement Id

@id of placement name (part of activity-placement pair defining scope).

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

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

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

string

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

repo:etag

Decision Scope ETag

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

repo:etag

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

repo:etag Type

string