SOAP API - findDocuments

The table summarizes the SOAP API - findDocuments.

Request Uses the FindDocumentsRequest element (from the DocumentService schema)
Parameter notes
  • caseReference - Can be obtained using getCaseReferencesForDataView.
  • name - Used for a simple search for a document by its name.
  • query / string - The specific constructs allowed in the query string depend on the CMS you are using. Consult your CMS documentation for more information. Also see the following topic for information about typical query constructs and examples: Queries for findDocuments.
Response Returns a FindDocumentsResponse element (from the DocumentService schema).
Example - using the name parameter Request: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:doc="http://document.api.bds.tibco.com">
   <soapenv:Header/>
   <soapenv:Body>
      <doc:FindDocumentsRequest returnMetadata="true">
         <owner>
            <caseReference>BDS-1-com.example.ordermodel.Order-1-0</caseReference>
         </owner>
         <name>Proposal.docx</name>
      </doc:FindDocumentsRequest>
   </soapenv:Body>
</soapenv:Envelope>
Response: 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <FindDocumentsResponse xmlns="http://document.api.bds.tibco.com">
         <result xmlns="">
            <reference>DocumentID-e50c2653-0fd7-4fef-ad6f-2ee460ba52cf;1.0</reference>
            <metadata>
               <specifier>
                  <id>e50c2653-0fd7-4fef-ad6f-2ee460ba52cf;1.0</id>
               </specifier>
               <name>Proposal.docx</name>
               <version>1.0</version>
               <mimeType>application/vnd.openxmlformats-officedocument.wordprocessingml.document</mimeType>
               <createdDateTime>2014-10-03T12:12:54.809</createdDateTime>
               <createdBy>admin</createdBy>
               <lastModifiedDateTime>2014-10-07T11:07:55.630</lastModifiedDateTime>
               <lastModifiedBy>admin</lastModifiedBy>
               <byteSize>24008</byteSize>
            </metadata>
         </result>
      </FindDocumentsResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Example - using a query string Request: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:doc="http://document.api.bds.tibco.com">
   <soapenv:Header/>
   <soapenv:Body>
      <doc:FindDocumentsRequest returnMetadata="true">
         <owner>
            <caseReference>BDS-1-com.example.ordermodel.Order-1-0</caseReference>
         </owner>
         <query>
            <string>cmis:name LIKE 'P%'</string>
         </query>
      </doc:FindDocumentsRequest>
   </soapenv:Body>
</soapenv:Envelope>
Response: 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <FindDocumentsResponse xmlns="http://document.api.bds.tibco.com">
         <result xmlns="">
            <reference>DocumentID-e50c2653-0fd7-4fef-ad6f-2ee460ba52cf;1.0</reference>
            <metadata>
               <specifier>
                  <id>e50c2653-0fd7-4fef-ad6f-2ee460ba52cf;1.0</id>
               </specifier>
               <name>Proposal.docx</name>
               <version>1.0</version>
               <mimeType>application/vnd.openxmlformats-officedocument.wordprocessingml.document</mimeType>
               <createdDateTime>2014-10-03T12:12:54.809</createdDateTime>
               <createdBy>admin</createdBy>
               <lastModifiedDateTime>2014-10-07T11:07:55.630</lastModifiedDateTime>
               <lastModifiedBy>admin</lastModifiedBy>
               <byteSize>24008</byteSize>
            </metadata>
         </result>
      </FindDocumentsResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>