com.thingworx.metadata.annotations

Annotation Type ThingworxPropertyDefinition

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

Defines a property that belongs to a thing, thing template, or thing shape.

See Also:

PropertyDefinition

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	baseType Required parameter: the base type for the property.
java.lang.String	name Required parameter: the name of the property.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String[]	aspects Optional parameter: an array of key-value pairs associated with colons (e.g., "aspect1:value1", "aspect2:value2", …) describing aspects applicable to the field definition.
java.lang.String	category Optional parameter: a category that conceptually groups together related properties.
java.lang.String	description Optional parameter: a short description for the property.
boolean	isLocalOnly Optional parameter: specifies whether the property definition should be reflected in metadata when external-only metadata is requested.
ThingworxDataShapeDefinition	localDataShape Deprecated. This parameter is not examined by the Platform.

Element Detail

name

public abstract java.lang.String name

Required parameter: the name of the property. Property names should follow ThingWorx entity naming conventions. The property name must be unique in the effective thing shape for the final thing instance.

baseType

public abstract java.lang.String baseType

Required parameter: the base type for the property. The base type should be identical to one of the enumerations in the BaseTypes class. The base type must be specified in all caps.

description

public abstract java.lang.String description

Optional parameter: a short description for the property.

Default:

""

category

public abstract java.lang.String category

Optional parameter: a category that conceptually groups together related properties.

Default:

""

aspects

public abstract java.lang.String[] aspects

Optional parameter: an array of key-value pairs associated with colons (e.g., "aspect1:value1", "aspect2:value2", …) describing aspects applicable to the field definition.

See Also:

Aspects

Default:

{}

isLocalOnly

public abstract boolean isLocalOnly

Optional parameter: specifies whether the property definition should be reflected in metadata when external-only metadata is requested. Typically this should be set to true if the property should not be reflected across federated servers.

Default:

false

localDataShape

@Deprecated
public abstract ThingworxDataShapeDefinition localDataShape

Deprecated. This parameter is not examined by the Platform.

Default:

@com.thingworx.metadata.annotations.ThingworxDataShapeDefinition