Annotation Interface ThingworxServiceParameter
@Target(PARAMETER)
@Retention(RUNTIME)
@ThingworxExtensionApiAnnotation(since={6,6})
public @interface ThingworxServiceParameter
Specifies the configuration for a parameter in a service method. Every parameter in a ThingWorx service must include this annotation.
-
Required Element Summary
-
Optional Element Summary
Modifier and TypeOptional ElementDescriptionString[]
Optional parameter: an array of key-value pairs associated with colons (e.g., "aspect1:value1", "aspect2:value2", …) describing aspects applicable to the field definition.
Optional parameter: a short description of the parameter and its use.Deprecated.This parameter is not examined by the Platform.
-
Element Details
-
name
String name
Required parameter: the name of the parameter as it should be referenced by other services when invoked via the REST API or via the processServiceRequest methods. By convention, the name should be identical to the name of the parameter. The name must not be empty. -
description
String description
Optional parameter: a short description of the parameter and its use.- Default:
""
-
baseType
String baseType
Required parameter: the base type for the parameter. When defining the base type for the parameter, it is important that the matching Java type is used for the parameter itself. The base type may be assigned any legal value except for NOTHING.- See Also:
-
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:
{}
-
localDataShape
Deprecated.This parameter is not examined by the Platform.- Default:
@com.thingworx.metadata.annotations.ThingworxDataShapeDefinition
-