Hide Comments

The referenceEmbed element defines an embedded object representation as the realization of a Reference Property from the Data Structure bound to the containing resource.  The Reference Embed element can specify the properties of the referenced Data Structure to be included in the embedded object, and can recursively specify Reference Embed and Reference Link elements to define the realization of included reference properties.

Syntax

referenceEmbed > <reference-property-name>

[targetProperties <target-properties>]

[referenceEmbed <reference-embed>]...

[referenceLink <reference-link>]...

Examples

referenceEmbed > taxpayer

referenceEmbed > taxpayer

targetProperties

firstName

lastName

DOB

referenceEmbed > addresses

referenceLink > taxFilings

Parameters

Field Name

Type

Description

<reference-property-name>

SName(Reference Property)

The name of the Reference Property to be realized as an embedded object.

<target-properties>

List(Primitive Property or Reference Property)

 

A delimited list of Primitive Property and/or Reference Property names, each of which MUST be defined in the referenced Data Structure.

 

If a Reference Property is realized by a <reference-embed> or <reference-link> child element, it is implicitly included as a target property, but MAY still be specified in the target properties list for clarity and completeness.

Child Elements

Name

Topic

Description

<reference-embed>

Reference Embed (this topic)

Recursively specifies an embedded object realization of a Reference Property of the bound Data Structure.

<reference-link>

Reference Link

Specifies a hyperlink realization of a Reference Property of the bound Data Structure.

Parent Elements

Collection Resource
Object Resource
Reference Embed
Request
Response

Discussion

Reference Properties will be embedded by default if there is no other accessible default resource bound to the referenced Data Structure, and having the required multiplicity.  See Automatic Linking and Embedding for more information.

Created with Help & Manual 6 and styled with Premium Pack Version 2.51 © by EC Software