Package com.thingworx.metadata.annotations

Annotation Interface ThingworxPropertyDefinition

@Target(ANNOTATION_TYPE) @Retention(RUNTIME) @ThingworxExtensionApiAnnotation(since={6,6}) public @interface ThingworxPropertyDefinition
Defines a property that belongs to a thing, thing template, or thing shape.
See Also:

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    baseType


    Required parameter: the base type for the property.
    String
    name


    Required parameter: the name of the property.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    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.
    String
    category


    Optional parameter: a category that conceptually groups together related properties.
    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 Details

    • name

      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.

    • description

      String description


      Optional parameter: a short description for the property.
      Default:
      ""

    • category

      String category


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

    • baseType

      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.

    • aspects

      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:
      Default:
      {}

    • isLocalOnly

      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 ThingworxDataShapeDefinition localDataShape
      Deprecated.
      This parameter is not examined by the Platform.


      Default:
      @com.thingworx.metadata.annotations.ThingworxDataShapeDefinition