Actuate Information Delivery API data types : FieldDefinition
 
FieldDefinition
A complex data type that describes a scalar parameter.
Schema
<xsd:complexType name="FieldDefinition">
<xsd:all>
<xsd:element name="Name" type="xsd:string"/>
<xsd:element name="DisplayName" type="xsd:string"
minOccurs="0"/>
<xsd:element name="DataType" type="typens:ScalarDataType"
minOccurs="0"/>
<xsd:element name="IsHidden" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="IsRequired" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="DefaultValue" type="xsd:string"
minOccurs="0"/>
<xsd:element name="SelectValueList"
type="typens:ArrayOfString"
minOccurs="0"/>
<xsd:element name="FieldControlType" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="ControlList"/>
<xsd:enumeration value="ControlListAllowNew"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="SelectNameValueList"
type="typens:ArrayOfNameValuePair" minOccurs="0" />
</xsd:all>
</xsd:complexType>
Elements
Name
The name of the parameter.
DisplayName
The display name of the parameter.
DataType
*The data type of the parameter. Valid values are:
*Currency
*Date
*Double
*Integer
*String
*Boolean
IsHidden
Specifies whether the parameter is hidden.
IsRequired
Specifies whether the parameter is required.
DefaultValue
The default value of the parameter.
SelectValueList
The list of available parameter values.
FieldControlType
*The type of control used to represent the parameter. Valid values are:
*ControlListAllowNew
A text box
*ControlList
A drop-down list
SelectNameValueList
A list of name-value pairs used within the field.