complexType ReportOptions

diagram |
namespace | http://base.api.ec.n2.tibco.com
type | extension of BaseQueryOptions
properties |
base | BaseQueryOptions
children | getTotalCount numberOfItems populateAttributeNames startPosition advancedOption requireAllAttributes requiredAttribute sortOrder version
used by |
element | ReportOptions
complexTypes | CommentedReportOptions CommentReportOptions
annotation |
documentation
The options available when generating the report
source | <xs:complexType name="ReportOptions"> <xs:annotation> <xs:documentation>The options available when generating the report</xs:documentation> </xs:annotation> <xs:complexContent> <xs:extension base="BaseQueryOptions"> <xs:sequence> <xs:element name="requireAllAttributes" type="xs:boolean" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>Boolean value defining whether all attributes should be returned. This setting overrides any "requiredAttribute" elements.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="requiredAttribute" type="xs:string" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>List of attributes that should be returned for each event found by this query.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="sortOrder" type="SortElement" minOccurs="0" maxOccurs="unbounded"/> <xs:element name="version" type="Version" minOccurs="0" maxOccurs="1"/> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType>

element ReportOptions/requireAllAttributes

diagram |
type | xs:boolean
properties |
minOcc | 0
maxOcc | 1
content | simple
annotation |
documentation
Boolean value defining whether all attributes should be returned. This setting overrides any "requiredAttribute" elements.
source | <xs:element name="requireAllAttributes" type="xs:boolean" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>Boolean value defining whether all attributes should be returned. This setting overrides any "requiredAttribute" elements.</xs:documentation> </xs:annotation> </xs:element>

element ReportOptions/requiredAttribute

diagram |
type | xs:string
properties |
minOcc | 0
maxOcc | unbounded
content | simple
annotation |
documentation
List of attributes that should be returned for each event found by this query.
source | <xs:element name="requiredAttribute" type="xs:string" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>List of attributes that should be returned for each event found by this query.</xs:documentation> </xs:annotation> </xs:element>

element ReportOptions/sortOrder

diagram |
type | SortElement
properties |
minOcc | 0
maxOcc | unbounded
content | complex
children | attribute type
source | <xs:element name="sortOrder" type="SortElement" minOccurs="0" maxOccurs="unbounded"/>

element ReportOptions/version

diagram |
type | Version
properties |
minOcc | 0
maxOcc | 1
content | simple
facets |
Kind | Value | Annotation
enumeration | 2.2 |
documentation
&lt;Default&gt; 2.2 version of the API.
enumeration | 3.0 |
documentation
3.0 version of the API. Introduces the following: - All BaseEntryAttribute derived entities (such as IntegerEntryAttribute) can now return multiple "value" entities if the source Attribute is an array type - BaseEntryAttribute can return a label for an Attribute if one has been defined
enumeration | 4.1 |
source | <xs:element name="version" type="Version" minOccurs="0" maxOccurs="1"/>

XML Schema documentation generated by XMLSpy Schema Editor http://www.altova.com/xmlspy