SOAP API - getFolderContent

The table summarizes the SOAP API - getFolderContent.

Request Uses the GetFolderContentRequest element (from the DocumentService schema)
Parameter notes
  • caseReference - Can be obtained using getCaseReferencesForDataView.
  • folderReference - Can be obtained by a prior call to this API when subordinate folders have been added to the case folder in the CMS (see the example below).
Response Returns a GetFolderContentResponse element (from the DocumentService schema).
Example Request: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:doc="http://document.api.bds.tibco.com">
   <soapenv:Header/>
   <soapenv:Body>
      <doc:GetFolderContentRequest returnMetadata="true">
         <owner>
            <caseReference>BDS-1-com.example.ordermodel.Order-1-0</caseReference>
         </owner>
         <depth>2</depth>
      </doc:GetFolderContentRequest>
   </soapenv:Body>
</soapenv:Envelope>
Response: 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <GetFolderContentResponse xmlns="http://document.api.bds.tibco.com">
         <item xmlns="">
            <document>
               <reference>DocumentID-11026910-c011-423d-b320-ebaff5fa0d1f;1.0</reference>
               <metadata>
                  <specifier>
                     <id>11026910-c011-423d-b320-ebaff5fa0d1f;1.0</id>
                  </specifier>
                  <name>Personnel.txt</name>
                  <version>1.0</version>
                  <mimeType>text/plain</mimeType>
                  <createdDateTime>2014-10-01T15:54:31.119</createdDateTime>
                  <createdBy>admin</createdBy>
                  <lastModifiedDateTime>2014-10-01T15:54:58.156</lastModifiedDateTime>
                  <lastModifiedBy>admin</lastModifiedBy>
               </metadata>
            </document>
         </item>
           .
           .
           .
         <item xmlns="">
            <folder>
               <reference>FolderID-c9085f79-2efc-4835-a8f5-d43bcd892bbf</reference>
               <metadata>
                  <id>c9085f79-2efc-4835-a8f5-d43bcd892bbf</id>
                  <name>Contracts</name>
               </metadata>
            </folder>
            <content>
               <folder>
                  <reference>FolderID-0fd5c876-906d-43b3-9889-92e67933c5e3</reference>
                  <metadata>
                     <id>0fd5c876-906d-43b3-9889-92e67933c5e3</id>
                     <name>Contracts discussion</name>
                  </metadata>
               </folder>
            </content>
         </item>
      </GetFolderContentResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>