Skip to content

Latest commit

 

History

History
219 lines (112 loc) · 5.44 KB

eventRelationship.schema.md

File metadata and controls

219 lines (112 loc) · 5.44 KB

Event Relationship Descriptor Schema

https://ns.adobe.com/xdm/common/descriptors/eventRelationship

Used by the UPS system to assign the specific schema that will used for the timeSeriesEvents field which is part of the union view of a class. If not supplied, the system today will default to the unified ExperienceEvent.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Stabilizing No Forbidden Permitted common/descriptors/relationship/eventRelationship.schema.json

Schema Hierarchy

  • Event Relationship Descriptor https://ns.adobe.com/xdm/common/descriptors/eventRelationship

Event Relationship Descriptor Example

{
  "@type": "xdm:eventRelationship",
  "xdm:sourceSchema": "https://ns.adobe.com/xdm/context/profile__union",
  "xdm:sourceVersion": 1,
  "xdm:destinationSchema": "https://ns.adobe.com/xdm/context/experienceevent__union",
  "xdm:destinationVersion": 1
}

Event Relationship Descriptor Properties

Property Type Required Defined by
@id string Optional Schema Descriptor
@type const Optional Event Relationship Descriptor (this schema)
xdm:destinationSchema string Optional Event Relationship Descriptor (this schema)
xdm:destinationVersion number Optional Event Relationship Descriptor (this schema)
xdm:sourceItem complex Optional Schema Descriptor
xdm:sourceProperty string Optional Schema Descriptor
xdm:sourceSchema string Optional Schema Descriptor
xdm:sourceVersion number Optional Schema Descriptor
* any Additional this schema allows additional properties

@id

Identifier

The unique identifier for the schema descriptor. This property is required when the descriptor is defined outside of the applicable schema, but is optional when applied via 'meta:descriptors'.

@id

@id Type

string

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

@type

@type

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

The value of this property must be equal to:

"xdm:eventRelationship"

xdm:destinationSchema

Destination Schema

The destination schema this descriptor applies to

xdm:destinationSchema

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

xdm:destinationSchema Type

string

  • format: uri – Uniformous Resource Identifier (according to RFC3986)

xdm:destinationVersion

Destination Version

When present, major version being referenced.

xdm:destinationVersion

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

xdm:destinationVersion Type

number

xdm:sourceItem

Source Item

When present, the selector used to match a specific item in the array pointed to by sourceProperty.

xdm:sourceItem

xdm:sourceItem Type

One of the following conditions need to be fulfilled.

Condition 1

Condition 2

Condition 3

Condition 4

xdm:sourceProperty

Source Property

When present, the property of the source schema to which this descriptor applies. This value is a JSON Pointer, applied to an instance of an object described by xdm:sourceSchema.

xdm:sourceProperty

xdm:sourceProperty Type

string

xdm:sourceSchema

Source Schema

The source schema this descriptor applies to. This property is required when the descriptor is defined outside of the applicable schema, but is optional when applied via 'meta:descriptors'

xdm:sourceSchema

xdm:sourceSchema Type

string

  • format: uri – Uniformous Resource Identifier (according to RFC3986)

xdm:sourceVersion

Source Version

Major version being referenced.

xdm:sourceVersion

xdm:sourceVersion Type

number