https://ns.adobe.com/xdm/common/descriptors/descriptorOneToOne
Describes one to one relationship descriptor.
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Defined In |
|---|---|---|---|---|---|---|
| Can be instantiated | Yes | Stabilizing | No | Forbidden | Permitted | common/descriptors/relationship/descriptorOneToOne.schema.json |
- One to One Relationship Descriptor
https://ns.adobe.com/xdm/common/descriptors/descriptorOneToOne- Schema Descriptor
https://ns.adobe.com/xdm/common/descriptors/schemadescriptor - Relationship Descriptor
https://ns.adobe.com/xdm/common/descriptors/relationshipdescriptor
- Schema Descriptor
{
"@id": "https://ns.adobe.com/example/descriptorOneToOne/1",
"@type": "xdm:descriptorOneToOne",
"xdm:sourceSchema": "https://ns.adobe.com/experience/aem/user",
"xdm:sourceVersion": 1,
"xdm:destinationSchema": "https://ns.adobe.com/xdm/context/profile",
"xdm:destinationVersion": 1,
"xdm:label": "UserProfile"
}| Property | Type | Required | Defined by |
|---|---|---|---|
| @id | string |
Optional | Schema Descriptor |
| @type | const |
Optional | One to One Relationship Descriptor (this schema) |
| xdm:destinationItem | complex | Optional | Relationship Descriptor |
| xdm:destinationProperty | string |
Optional | Relationship Descriptor |
| xdm:destinationSchema | string |
Optional | Relationship Descriptor |
| xdm:destinationVersion | number |
Optional | Relationship Descriptor |
| xdm:label | string |
Optional | Relationship Descriptor |
| xdm:sourceItem | complex | Optional | Schema Descriptor |
| xdm:sourceProperty | string |
Optional | Schema Descriptor |
| xdm:sourceSchema | string |
Optional | Schema Descriptor |
| xdm:sourceValue | string |
Optional | Relationship Descriptor |
| xdm:sourceVersion | number |
Optional | Schema Descriptor |
* |
any | Additional | this schema allows additional properties |
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
- is optional
- type:
string - defined in Schema Descriptor
string
- format:
uri-reference– URI Reference (according to RFC3986)
@type
- is optional
- type:
const - defined in this schema
The value of this property must be equal to:
"xdm:descriptorOneToOne"When present, the selector used to match a specific item in the array pointed to by destProperty
xdm:destinationItem
- is optional
- type: complex
- defined in Relationship Descriptor
One of the following conditions need to be fulfilled.
When present, the property of the destination schema to which this descriptor applies. This value is a JSON Pointer, applied to an instance of an object described by 'xdm:destSchema'
xdm:destinationProperty
- is optional
- type:
string - defined in Relationship Descriptor
string
The destination schema this descriptor applies to
xdm:destinationSchema
- is optional
- type:
string - defined in Relationship Descriptor
string
- format:
uri– Uniformous Resource Identifier (according to RFC3986)
Major version being referenced.
xdm:destinationVersion
- is optional
- type:
number - defined in Relationship Descriptor
number
xdm:label
- is optional
- type:
string - defined in Relationship Descriptor
string
When present, the selector used to match a specific item in the array pointed to by sourceProperty.
xdm:sourceItem
- is optional
- type: complex
- defined in Schema Descriptor
One of the following conditions need to be fulfilled.
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
- is optional
- type:
string - defined in Schema Descriptor
string
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
- is optional
- type:
string - defined in Schema Descriptor
string
- format:
uri– Uniformous Resource Identifier (according to RFC3986)
When present, provides additional information about the values in that field. Descriptor producer and consumer should coordinate on how to use this field, e.g. defining rules on formats, values, and operations.
xdm:sourceValue
- is optional
- type:
string - defined in Relationship Descriptor
string
Major version being referenced.
xdm:sourceVersion
- is optional
- type:
number - defined in Schema Descriptor
number