com.thingworx.metadata.annotations

Annotation Type ThingworxServiceParameter

@Target(value=PARAMETER)
 @Retention(value=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

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	baseType Required parameter: the base type for the parameter.
java.lang.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.

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	description Optional parameter: a short description of the parameter and its use.
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 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.

baseType

public abstract java.lang.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:

BaseTypes

description

public abstract java.lang.String description

Optional parameter: a short description of the parameter and its use.

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:

{}

localDataShape

@Deprecated
public abstract ThingworxDataShapeDefinition localDataShape

Deprecated. This parameter is not examined by the Platform.

Default:

@com.thingworx.metadata.annotations.ThingworxDataShapeDefinition