com.thingworx.metadata.annotations

Annotation Type ThingworxDataShapeDefinition

@Target(value=ANNOTATION_TYPE)
 @Retention(value=RUNTIME)
 @ThingworxExtensionApiAnnotation(since={6,6})
public @interface ThingworxDataShapeDefinition

Defines a data shape describing the contents of the parent annotation. The annotation may be used to refer to a data shape entity (not all usages of this annotation support data shape entities) or to define an in-line data shape. In-line data shapes are stored with the parent entity and do not generate data shape entities.

See Also:

DataShapeDefinition

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
ThingworxFieldDefinition[]	fields Optional parameter: a collection of field definitions belonging to the in-lined data shape.
java.lang.String	name Optional parameter: a reference to the name of a data shape entity.

Element Detail

name

public abstract java.lang.String name

Optional parameter: a reference to the name of a data shape entity. Most usages of this annotation do not support references to data shape entities.

Default:

""

fields

public abstract ThingworxFieldDefinition[] fields

Optional parameter: a collection of field definitions belonging to the in-lined data shape.

Default:

{}