Hide Comments

The properties element is used within a resource or message to adapt the set of properties in the bound Data Structure for optimal use within the API context.  A Property Set may specify a subset of the bound properties, and may add context-specific Constraints to the included properties. Property Sets are one aspect of realization modeling.

Syntax

[~with] (all | only) properties

[~including]

(<property-name>[<cardinality-indicator>]

[<constraint-spec>]...

)...

[excluding

<property-name>...

]

Examples

// 1. Itemized

with only properties

id! // May include constraints as well.

ssn

firstName

lastName

// 2. Constraining

with all properties including

id! // Add cardinality override

ssn // Add regex contraint

matching regex '(?!000|666)[0-8][0-9]{2}-(?!00)[0-9]{2}-(?!0000)[0-9]{4}'

// 3. Excluding

with all properties excluding

id

// 4. Combination, constraining and excluding

with all properties

including

id!

excluding

addresses

Parameters

Field Name

Type

Description

all

keyword

Indicates that the Property Set will contain all properties except those that are explicitly excluded (if any).

only

keyword

Indicates that the Property Set will contain only those properties that are explicitly listed.  This is the default behavior, so the only keyword may be omitted.

excluding

keyword

Indicates the beginning of the excluding clause. Properties listed here will not be included in the Property Set.  The excluding clause MAY be used alone or in combination with an inclusive all properties list.  It MUST NOT be used in combination with an exclusive only properties list.

<property-name>

SName

The name of a Primitive Property or Reference Property to be included and/or constrained, or to be excluded. Multiple properties MAY be specified as a delimited list.

<cardinality-indicator>

Cardinality

Optional Cardinality indicator for an included property. May be used to narrow but not broaden Cardinality of the property as defined in its containing Data Structure.

<constraint-spec>

Constraint

A context-specific Constraint applied to the preceding property.  If the property already has (directly or indirectly) a Constraint of the same type, the Constraint specified in the Property Set overrides the inherited property Constraint.

Child Elements

Name

Topic

Description

<constraint-spec>

Constraints

Describes Constraints that apply to a particular property in this context.

Parent Elements

Collection Resource
Object Resource
Request
Response

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