complexType FindDocumentsRequestType

diagram |
namespace | http://document.api.bds.tibco.com
children | owner name query
used by |
element | FindDocumentsRequest
attributes |
Name | Type | Use | Default | Fixed | Annotation
returnMetadata | xs:boolean |  |  |  |
documentation
The response will contain zero or more document references. If this boolean attribute is set true, it will also include document metadata. (Assumed false if omitted)
annotation |
documentation
Request for FindDocuments
source | <xs:complexType name="FindDocumentsRequestType"> <xs:annotation> <xs:documentation>Request for FindDocuments </xs:documentation> </xs:annotation> <xs:sequence> <xs:element name="owner" type="OwnerReference"/> <xs:choice> <xs:annotation> <xs:documentation>Specify either a document name to search for documents by name, or a query string for a more sophisticated search</xs:documentation> </xs:annotation> <xs:element name="name" type="xs:string"> <xs:annotation> <xs:documentation>Specify the name of the document to match</xs:documentation> </xs:annotation> </xs:element> <xs:element name="query" type="QueryAndDocumentType"/> </xs:choice> </xs:sequence> <xs:attribute name="returnMetadata" type="xs:boolean"> <xs:annotation> <xs:documentation>The response will contain zero or more document references. If this boolean attribute is set true, it will also include document metadata. (Assumed false if omitted)</xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType>

attribute FindDocumentsRequestType/@returnMetadata

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

element FindDocumentsRequestType/owner

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

element FindDocumentsRequestType/name

diagram |
type | xs:string
properties |
content | simple
annotation |
documentation
Specify the name of the document to match
source | <xs:element name="name" type="xs:string"> <xs:annotation> <xs:documentation>Specify the name of the document to match</xs:documentation> </xs:annotation> </xs:element>

element FindDocumentsRequestType/query

diagram |
type | QueryAndDocumentType
properties |
content | complex
children | string documentType
source | <xs:element name="query" type="QueryAndDocumentType"/>

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