complexType GetDataViewDetailsRequestType

diagram |
namespace | http://api.bds.tibco.com
children | viewID viewName appDetails caseClassDetails category uncategorized viewDetailsRequirement includeAppDetails includeCategories
used by |
element | GetDataViewDetailsRequest
annotation |
documentation
Details required to retrieve Data View(s)
source | <xs:complexType name="GetDataViewDetailsRequestType"> <xs:annotation> <xs:documentation>Details required to retrieve Data View(s)</xs:documentation> </xs:annotation> <xs:sequence> <xs:choice> <xs:annotation> <xs:documentation>Identify a single view either by id or name, or include wildcards in the name to match many. Alternatively, specify an app, case class, or category to get all associated views, or uncategorized to get all views that do not belong to any category.</xs:documentation> </xs:annotation> <xs:element name="viewID" type="xs:long"/> <xs:element name="viewName" type="xs:string"> <xs:annotation> <xs:documentation>May use the %_*? wildcard characters (escape with '\'), so can match multiple views</xs:documentation> </xs:annotation> </xs:element> <xs:element name="appDetails" type="AppDetails"/> <xs:element name="caseClassDetails" type="CaseClassDetails"/> <xs:element name="category" type="CategorySearchDetails" maxOccurs="unbounded"/> <xs:element name="uncategorized" type="Uncategorized"> <xs:annotation> <xs:documentation>Empty element indicates that views that do NOT belong to any category should be matched.</xs:documentation> </xs:annotation> </xs:element> </xs:choice> <xs:element name="viewDetailsRequirement" type="ViewDetailsRequirementEnum" minOccurs="0"> <xs:annotation> <xs:documentation>Determines which elements are required for each view in the response: Either NAME, NAME_AND_DESCRIPTION, NAME_AND_PARAMETERS or NAME_DESCRIPTION_AND_PARAMETERS. If this element is omitted, then all details will be returned (except parameters as they are present in the condition tree itself)</xs:documentation> </xs:annotation> </xs:element> <xs:element name="includeAppDetails" type="xs:boolean" default="false" minOccurs="0"> <xs:annotation> <xs:documentation>If present and set true, this will cause inclusion of an 'appDetails' element within each 'result' element of the response.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="includeCategories" type="xs:boolean" minOccurs="0"> <xs:annotation> <xs:documentation>If present and set true, this will cause inclusion of which category or categories each view belongs to (default: false). If the caller intends to subsequently update a view via the editDataView API, then this information will be required.</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType>

element GetDataViewDetailsRequestType/viewID

diagram |
type | xs:long
properties |
content | simple
source | <xs:element name="viewID" type="xs:long"/>

element GetDataViewDetailsRequestType/viewName

diagram |
type | xs:string
properties |
content | simple
annotation |
documentation
May use the %_*? wildcard characters (escape with '\'), so can match multiple views
source | <xs:element name="viewName" type="xs:string"> <xs:annotation> <xs:documentation>May use the %_*? wildcard characters (escape with '\'), so can match multiple views</xs:documentation> </xs:annotation> </xs:element>

element GetDataViewDetailsRequestType/appDetails

diagram |
type | AppDetails
properties |
content | complex
children | name majorVersion
source | <xs:element name="appDetails" type="AppDetails"/>

element GetDataViewDetailsRequestType/caseClassDetails

diagram |
type | CaseClassDetails
properties |
content | complex
children | caseClass majorVersion
source | <xs:element name="caseClassDetails" type="CaseClassDetails"/>

element GetDataViewDetailsRequestType/category

diagram |
type | CategorySearchDetails
properties |
minOcc | 1
maxOcc | unbounded
content | complex
children | name childDepth childrenOnly
source | <xs:element name="category" type="CategorySearchDetails" maxOccurs="unbounded"/>

element GetDataViewDetailsRequestType/uncategorized

diagram |
type | Uncategorized
properties |
content | complex
annotation |
documentation
Empty element indicates that views that do NOT belong to any category should be matched.
source | <xs:element name="uncategorized" type="Uncategorized"> <xs:annotation> <xs:documentation>Empty element indicates that views that do NOT belong to any category should be matched.</xs:documentation> </xs:annotation> </xs:element>

element GetDataViewDetailsRequestType/viewDetailsRequirement

diagram |
type | ViewDetailsRequirementEnum
properties |
minOcc | 0
maxOcc | 1
content | simple
facets |
Kind | Value | Annotation
enumeration | NAME |
enumeration | NAME_AND_DESCRIPTION |
enumeration | NAME_AND_PARAMETERS |
enumeration | NAME_DESCRIPTION_AND_PARAMETERS |
annotation |
documentation
Determines which elements are required for each view in the response: Either NAME, NAME_AND_DESCRIPTION, NAME_AND_PARAMETERS or NAME_DESCRIPTION_AND_PARAMETERS. If this element is omitted, then all details will be returned (except parameters as they are present in the condition tree itself)
source | <xs:element name="viewDetailsRequirement" type="ViewDetailsRequirementEnum" minOccurs="0"> <xs:annotation> <xs:documentation>Determines which elements are required for each view in the response: Either NAME, NAME_AND_DESCRIPTION, NAME_AND_PARAMETERS or NAME_DESCRIPTION_AND_PARAMETERS. If this element is omitted, then all details will be returned (except parameters as they are present in the condition tree itself)</xs:documentation> </xs:annotation> </xs:element>

element GetDataViewDetailsRequestType/includeAppDetails

diagram |
type | xs:boolean
properties |
minOcc | 0
maxOcc | 1
content | simple
default | false
annotation |
documentation
If present and set true, this will cause inclusion of an 'appDetails' element within each 'result' element of the response.
source | <xs:element name="includeAppDetails" type="xs:boolean" default="false" minOccurs="0"> <xs:annotation> <xs:documentation>If present and set true, this will cause inclusion of an 'appDetails' element within each 'result' element of the response.</xs:documentation> </xs:annotation> </xs:element>

element GetDataViewDetailsRequestType/includeCategories

diagram |
type | xs:boolean
properties |
minOcc | 0
maxOcc | 1
content | simple
annotation |
documentation
If present and set true, this will cause inclusion of which category or categories each view belongs to (default: false). If the caller intends to subsequently update a view via the editDataView API, then this information will be required.
source | <xs:element name="includeCategories" type="xs:boolean" minOccurs="0"> <xs:annotation> <xs:documentation>If present and set true, this will cause inclusion of which category or categories each view belongs to (default: false). If the caller intends to subsequently update a view via the editDataView API, then this information will be required.</xs:documentation> </xs:annotation> </xs:element>

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