complexType GetCaseReferencesForDataViewRequestType
diagram bds_rest_all_diagrams/bds_rest_all_p251.png
namespace http://api.bds.tibco.com
children viewID viewName viewDetails namedParameterAssignment sortAttribute paginationOptions
used by
element GetCaseReferencesForDataViewRequest
annotation
documentation
Details required to perform a search/view
source <xs:complexType name="GetCaseReferencesForDataViewRequestType">
 
<xs:annotation>
   
<xs:documentation>Details required to perform a search/view</xs:documentation>
 
</xs:annotation>
 
<xs:sequence>
   
<xs:choice>
     
<xs:annotation>
       
<xs:documentation>Specify either a view ID or name to evaluate a previously saved view, or a number of conditions on a case class that define an ad-hoc view for immediate evluation</xs:documentation>
     
</xs:annotation>
     
<xs:element name="viewID" type="xs:long"/>
     
<xs:element name="viewName" type="xs:string">
       
<xs:annotation>
         
<xs:documentation>Globally-unique view name</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="viewDetails" type="ViewDetails"/>
   
</xs:choice>
   
<xs:element name="namedParameterAssignment" type="NamedParameterAssignment" minOccurs="0" maxOccurs="unbounded">
     
<xs:annotation>
       
<xs:documentation>For each condition that has an associated named parameter, a value must be specified here, except where that condition has a default value for the parameter, in which case overriding it here is optional. This capability would not generally be used for ad-hoc views, but it is allowed.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="sortAttribute" type="SortAttribute" minOccurs="0" maxOccurs="unbounded">
     
<xs:annotation>
       
<xs:documentation>Allows sorting behaviour to be defined for ad-hoc views, or overridden for saved views. If omitted for an ad-hoc view, default (GORef) sorting will occur; For a saved view, sorting specified at the time of view creation will be used.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
   
<xs:element name="paginationOptions" type="PaginationOptions" minOccurs="0"/>
 
</xs:sequence>
</xs:complexType>

element GetCaseReferencesForDataViewRequestType/viewID
diagram bds_rest_all_diagrams/bds_rest_all_p252.png
type xs:long
properties
content simple
source <xs:element name="viewID" type="xs:long"/>

element GetCaseReferencesForDataViewRequestType/viewName
diagram bds_rest_all_diagrams/bds_rest_all_p253.png
type xs:string
properties
content simple
annotation
documentation
Globally-unique view name
source <xs:element name="viewName" type="xs:string">
 
<xs:annotation>
   
<xs:documentation>Globally-unique view name</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetCaseReferencesForDataViewRequestType/viewDetails
diagram bds_rest_all_diagrams/bds_rest_all_p254.png
type ViewDetails
properties
content complex
children caseClassDetails condition
source <xs:element name="viewDetails" type="ViewDetails"/>

element GetCaseReferencesForDataViewRequestType/namedParameterAssignment
diagram bds_rest_all_diagrams/bds_rest_all_p255.png
type NamedParameterAssignment
properties
minOcc 0
maxOcc unbounded
content complex
children name value
annotation
documentation
For each condition that has an associated named parameter, a value must be specified here, except where that condition has a default value for the parameter, in which case overriding it here is optional. This capability would not generally be used for ad-hoc views, but it is allowed.
source <xs:element name="namedParameterAssignment" type="NamedParameterAssignment" minOccurs="0" maxOccurs="unbounded">
 
<xs:annotation>
   
<xs:documentation>For each condition that has an associated named parameter, a value must be specified here, except where that condition has a default value for the parameter, in which case overriding it here is optional. This capability would not generally be used for ad-hoc views, but it is allowed.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetCaseReferencesForDataViewRequestType/sortAttribute
diagram bds_rest_all_diagrams/bds_rest_all_p256.png
type SortAttribute
properties
minOcc 0
maxOcc unbounded
content complex
children attrPath order
annotation
documentation
Allows sorting behaviour to be defined for ad-hoc views, or overridden for saved views. If omitted for an ad-hoc view, default (GORef) sorting will occur; For a saved view, sorting specified at the time of view creation will be used.
source <xs:element name="sortAttribute" type="SortAttribute" minOccurs="0" maxOccurs="unbounded">
 
<xs:annotation>
   
<xs:documentation>Allows sorting behaviour to be defined for ad-hoc views, or overridden for saved views. If omitted for an ad-hoc view, default (GORef) sorting will occur; For a saved view, sorting specified at the time of view creation will be used.</xs:documentation>
 
</xs:annotation>
</xs:element>

element GetCaseReferencesForDataViewRequestType/paginationOptions
diagram bds_rest_all_diagrams/bds_rest_all_p257.png
type PaginationOptions
properties
minOcc 0
maxOcc 1
content complex
children startPosition maxResults
source <xs:element name="paginationOptions" type="PaginationOptions" minOccurs="0"/>


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