Stardust/Knowledge Base/Web Service API/DMS Operations

SOAP Request for createFolder method: 

The below request will create a folder at root level with name as “MyTestFolder”

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://infinity.com/bpm/ws/v2009a/api">
<soapenv:Header/>
<soapenv:Body>
<api:createFolder>
<api:parentFolderId>/</api:parentFolderId>
<api:folderInfo>
<api:name>MyTestFolder</api:name>
<api:description>This is MyTestFolder</api:description>
<api:owner>Rohit Gupta</api:owner>
<api:dateCreated>2011-11-25T15:44:28</api:dateCreated>
<api:dateLastModified>2011-11-25T15:44:28</api:dateLastModified>
<api:metaDataType xmlns:fol="http://www.infinity.com/bpm/model/Model/FolderMetaDataType">fol:FolderMetaDataType</api:metaDataType>
<api:metaData>
<fol:FolderMetaType xmlns:fol="http://www.infinity.com/bpm/model/Model/FolderMetaDataType" xmlns="http://www.infinity.com/bpm/model/Model/FolderMetaDataType">
<folderType>TAX_FOLDER</folderType>
</fol:FolderMetaType>
</api:metaData>
</api:folderInfo>
</api:createFolder>
</soapenv:Body>
</soapenv:Envelope>

Below is the SOAP Response for createFolder method:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<createFolderResponse xmlns="http://infinity.com/bpm/ws/v2009a/api" xmlns:ns2="http://infinity.com/bpm/ws/v2009a/api/query">
<folder>
<name>MyTestFolder</name>
<description>This is MyTestFolder</description>
<owner>Rohit Gupta</owner>
<dateCreated>2011-11-25T14:27:03.578+05:30</dateCreated>
<dateLastModified>2011-11-25T14:27:03.594+05:30</dateLastModified>
<id>{jcrUuid}d4b5ceee-1761-408f-a806-75be72aa95a0</id>
<path>/MyTestFolder</path>
<levelOfDetail>DirectMembers</levelOfDetail>
<documentCount>0</documentCount>
<folderCount>0</folderCount>
</folder>
</createFolderResponse>
</S:Body>
</S:Envelope>

SOAP Request for getFolder 

Below is the request to get a folder using its folderId.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://infinity.com/bpm/ws/v2009a/api">
<soapenv:Header/>
<soapenv:Body>
<api:getFolder>
<api:folderId>{jcrUuid}d4b5ceee-1761-408f-a806-75be72aa95a0</api:folderId>
</api:getFolder>
</soapenv:Body>
</soapenv:Envelope>

And below is the SOAP Response for getFolder

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<getFolderResponse xmlns="http://infinity.com/bpm/ws/v2009a/api" xmlns:ns2="http://infinity.com/bpm/ws/v2009a/api/query">
<folder>
<name>MyTestFolder</name>
<description>This is MyTestFolder</description>
<owner>Rohit Gupta</owner>
<dateCreated>2011-11-25T14:27:03.578+05:30</dateCreated>
<dateLastModified>2011-11-25T14:27:03.594+05:30</dateLastModified>
<id>{jcrUuid}d4b5ceee-1761-408f-a806-75be72aa95a0</id>
<path>/MyTestFolder</path>
<levelOfDetail>DirectMembers</levelOfDetail>
<documentCount>0</documentCount>
<folderCount>2</folderCount>
<folders>
<folder>
<name>TAX_Folder</name>
<description>This is TAX_Folder</description>
<owner>Rohit Gupta</owner>
<dateCreated>2011-11-25T14:40:09.020+05:30</dateCreated>
<dateLastModified>2011-11-25T14:40:09.020+05:30</dateLastModified>
<id>{jcrUuid}961b5919-a6ec-4a9b-ae54-cc783de7608a</id>
<path>/MyTestFolder/TAX_Folder</path>
<levelOfDetail>DirectMembers</levelOfDetail>
<documentCount>0</documentCount>
<folderCount>0</folderCount>
</folder>
<folder>
<name>Salary_Folder</name>
<description>This is SALARY_Folder</description>
<owner>Rohit Gupta</owner>
<dateCreated>2011-11-25T14:40:43.403+05:30</dateCreated>
<dateLastModified>2011-11-25T14:40:43.403+05:30</dateLastModified>
<id>{jcrUuid}c57f4ec0-c7c6-448e-8600-b98af4705f85</id>
<path>/MyTestFolder/Salary_Folder</path>
<levelOfDetail>DirectMembers</levelOfDetail>
<documentCount>0</documentCount>
<folderCount>0</folderCount>
</folder>
</folders>
</folder>
</getFolderResponse>
</S:Body>
</S:Envelope>

You may specify the folder path also in the folderId at the time of calling getFolder, as shown below in the SOAP Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://infinity.com/bpm/ws/v2009a/api">
<soapenv:Header/>
<soapenv:Body>
<api:getFolder>
<api:folderId>/MyTestFolder</api:folderId>
</api:getFolder>
</soapenv:Body>
</soapenv:Envelope>

SOAP Request for findFolders using NamePattern

In the below request, we are trying to find the folders which has ‘TestFol” in its name.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://infinity.com/bpm/ws/v2009a/api">
<soapenv:Header/>
<soapenv:Body>
<api:findFolders>
<api:folderQuery>
<api:namePattern>%TestFol%</api:namePattern>
</api:folderQuery>
</api:findFolders>
</soapenv:Body>
</soapenv:Envelope>

SOAP Request for findFolders using xpathQuery

The below query will return folders inside default partition

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://infinity.com/bpm/ws/v2009a/api">
<soapenv:Header/>
<soapenv:Body>
<api:findFolders>
<api:folderQuery> <api:xpathQuery>/jcr:root/ipp-repository/partitions/default//*</api:xpathQuery> </api:folderQuery>
</api:findFolders>
</soapenv:Body>
</soapenv:Envelope>

SOAP Request for findFolders using xpathQuery – here we are specifying that the name of the folder should contain TAX_Fol

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://infinity.com/bpm/ws/v2009a/api">
<soapenv:Header/>
<soapenv:Body>
<api:findFolders>
<api:folderQuery>
<api:xpathQuery>/jcr:root/ipp-repository/partitions/default//*[jcr:like(vfs:metaData/vfs:name, '%TAX_Fol%')]</api:xpathQuery>
</api:folderQuery>
</api:findFolders>
</soapenv:Body>
</soapenv:Envelope>