complexType CategorySearchDetails

diagram |
namespace | http://api.bds.tibco.com
children | name childDepth childrenOnly
used by |
elements | CategorySearchDetailsArrayType/category GetDataViewCategoriesRequestType/category GetDataViewDetailsRequestType/category
annotation |
documentation
Parameters for searching for category(s)
source | <xs:complexType name="CategorySearchDetails"> <xs:annotation> <xs:documentation>Parameters for searching for category(s)</xs:documentation> </xs:annotation> <xs:sequence> <xs:element name="name" type="xs:string" minOccurs="0"> <xs:annotation> <xs:documentation>Slash-separated path to the category in the hierarchy. If omitted, will match all top-level categories</xs:documentation> </xs:annotation> </xs:element> <xs:element name="childDepth" type="xs:int" default="0" minOccurs="0"> <xs:annotation> <xs:documentation>Number of levels of child categories to get beneath the matching category(s). -1 for unlimited depth. Omit to get no children.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="childrenOnly" type="xs:boolean" default="false" minOccurs="0"> <xs:annotation> <xs:documentation>In conjunction with childDepth, if set true, this omits the category itself and only obtains children.</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType>

element CategorySearchDetails/name

diagram |
type | xs:string
properties |
minOcc | 0
maxOcc | 1
content | simple
annotation |
documentation
Slash-separated path to the category in the hierarchy. If omitted, will match all top-level categories
source | <xs:element name="name" type="xs:string" minOccurs="0"> <xs:annotation> <xs:documentation>Slash-separated path to the category in the hierarchy. If omitted, will match all top-level categories</xs:documentation> </xs:annotation> </xs:element>

element CategorySearchDetails/childDepth

diagram |
type | xs:int
properties |
minOcc | 0
maxOcc | 1
content | simple
default | 0
annotation |
documentation
Number of levels of child categories to get beneath the matching category(s). -1 for unlimited depth. Omit to get no children.
source | <xs:element name="childDepth" type="xs:int" default="0" minOccurs="0"> <xs:annotation> <xs:documentation>Number of levels of child categories to get beneath the matching category(s). -1 for unlimited depth. Omit to get no children.</xs:documentation> </xs:annotation> </xs:element>

element CategorySearchDetails/childrenOnly

diagram |
type | xs:boolean
properties |
minOcc | 0
maxOcc | 1
content | simple
default | false
annotation |
documentation
In conjunction with childDepth, if set true, this omits the category itself and only obtains children.
source | <xs:element name="childrenOnly" type="xs:boolean" default="false" minOccurs="0"> <xs:annotation> <xs:documentation>In conjunction with childDepth, if set true, this omits the category itself and only obtains children.</xs:documentation> </xs:annotation> </xs:element>

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