complexType GetFolderContentRequestType

diagram |
namespace | http://document.api.bds.tibco.com
children | owner folderReference depth
used by |
element | GetFolderContentRequest
attributes |
Name | Type | Use | Default | Fixed | Annotation
returnMetadata | xs:boolean |  |  |  |
documentation
The response will contain document/folder references. If this boolean attribute is set true, it will also include corresponding metadata. (Assumed false if omitted)
annotation |
documentation
Request for GetFolderContent
source | <xs:complexType name="GetFolderContentRequestType"> <xs:annotation> <xs:documentation>Request for GetFolderContent</xs:documentation> </xs:annotation> <xs:sequence> <xs:choice> <xs:annotation> <xs:documentation>Specify either an owner (case object) to start from its case folder, or any other folder (i.e. a sub-folder) to start from that point.</xs:documentation> </xs:annotation> <xs:element name="owner" type="OwnerReference"/> <xs:element name="folderReference" type="FolderReference"> <xs:annotation> <xs:documentation>A reference to a folder. Obtained via a prior call to this API.</xs:documentation> </xs:annotation> </xs:element> </xs:choice> <xs:element name="depth" type="xs:int"> <xs:annotation> <xs:documentation>How many layers of folder to read. 1 = top level items only. 2 = top level and one level below that (etc). -1 = unlimited. </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> <xs:attribute name="returnMetadata" type="xs:boolean"> <xs:annotation> <xs:documentation>The response will contain document/folder references. If this boolean attribute is set true, it will also include corresponding metadata. (Assumed false if omitted)</xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType>

attribute GetFolderContentRequestType/@returnMetadata

type | xs:boolean
annotation |
documentation
The response will contain document/folder references. If this boolean attribute is set true, it will also include corresponding metadata. (Assumed false if omitted)
source | <xs:attribute name="returnMetadata" type="xs:boolean"> <xs:annotation> <xs:documentation>The response will contain document/folder references. If this boolean attribute is set true, it will also include corresponding metadata. (Assumed false if omitted)</xs:documentation> </xs:annotation> </xs:attribute>

element GetFolderContentRequestType/owner

diagram |
type | OwnerReference
properties |
content | complex
children | caseReference
source | <xs:element name="owner" type="OwnerReference"/>

element GetFolderContentRequestType/folderReference

diagram |
type | FolderReference
properties |
content | simple
annotation |
documentation
A reference to a folder. Obtained via a prior call to this API.
source | <xs:element name="folderReference" type="FolderReference"> <xs:annotation> <xs:documentation>A reference to a folder. Obtained via a prior call to this API.</xs:documentation> </xs:annotation> </xs:element>

element GetFolderContentRequestType/depth

diagram |
type | xs:int
properties |
content | simple
annotation |
documentation
How many layers of folder to read. 1 = top level items only. 2 = top level and one level below that (etc). -1 = unlimited.
source | <xs:element name="depth" type="xs:int"> <xs:annotation> <xs:documentation>How many layers of folder to read. 1 = top level items only. 2 = top level and one level below that (etc). -1 = unlimited. </xs:documentation> </xs:annotation> </xs:element>

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