Loading...

ObjectStore API Reference

The ObjectStore APIs provide an interface between the ObjectStore and the user. These APIs are meant to address a specific functionality, such as to create, move, rename or delete objects in the ObjectStore.

Before using the APIs, make sure the user is associated to the ObjectStore client configured in the CommCell.

The following table lists the available ObjectStore APIs:

Operation Description XML Template
Create an ObjectStore Creates an ObjectStore for a specific user.  

Create Folder

Create a Folder Using ID Create a new folder in an ObjectStore based on the GUID of the parent folder. <App_FileResourceInfo name=""/>
Create a Folder Using Path Create a new folder in an ObjectStore based on the path to the parent folder. <App_FileResourceInfo name="" parentPath=""/>
Create a Folder in a Share Using ID Create a new folder within a shared folder in the ObjectStore based on the GUID of the parent folder. <App_FileResourceInfo name=""/>
Create a Folder in a Share Using Path Create a new folder within a shared folder in the ObjectStore based on the shared parent folder path name. <App_FileResourceInfo name="" parentPath=""/>

Share Folder

Share a File or Folder Using ID Share a specific file or folder in an ObjectStore based on the file or folder GUID. <App_ShareInfo status="0" sharedToOperationType="2" userPermission="2">
    <shareFolder syncWebFolderName=""/>
    <browseInfo>
        <emailInfo dontSendEmail="1" emailMessage=""/>
    </browseInfo>
    <sharedTo permission="1" userType="1">
        <user userName=""/>
    </sharedTo>
</App_ShareInfo>
Share a File or Folder Using Path Share a specific file or folder in an ObjectStore based on the file or folder path. <App_ShareInfo status="0" sharedToOperationType="2" userPermission="2">
    <shareFolder syncWebFolderName=""/>
    <browseInfo>
        <paths path="" />
        <emailInfo dontSendEmail="1" emailMessage=""/>
    </browseInfo>
    <sharedTo permission="1" userType="1"> <user userName=""/> </sharedTo>
</App_ShareInfo>

Upload File

Upload a File to ObjectStore Upload a single file to the ObjectStore.  
Upload a File in Chunks Upload a large file in multiple data chunks to the ObjectStore.  
    Initiate an Upload Session Initiate the upload session for uploading multiple file chunks to the ObjectStore.  
    Upload a File Data Chunk Upload a chunk or portion of the file data to the ObjectStore.  

View File/Folder Properties

View File or Folder Properties Using ID Returns the properties associated with a file or folder in an ObjectStore based on the file or folder GUID.  
View File or Folder Properties Using Path Returns the properties associated with a file or folder in an ObjectStore based on the file/folder path.  
View File or Folder Properties in a Share Using ID Returns the properties associated with a file or folder within a shared folder in the ObjectStore based on the file or folder GUID.  
View File or Folder Properties in a Share Using Path Returns the properties associated with a file or folder within a shared folder in the ObjectStore based on the file/folder path.  
View File or Folder Properties in a Public Share Returns the properties associated with an ObjectStore file or folder in a public share based on the file or folder path.  

Move File/Folder

Move a File or Folder Using ID Move a file or folder, based on the file or folder GUID, to another folder within the ObjectStore. <App_FileResourceInfo parentGuid="" />
Move a File or Folder Using Path Move a file or folder, based on the file/folder path, to another folder within the ObjectStore. <App_FileResourceInfo path=”” parentPath=””/>
Move a File or Folder in a Share Using ID Move a file or folder to another location within a shared folder in the ObjectStore, based on the GUID of the file or folder. <App_FileResourceInfo parentGuid="" />
Move a File or Folder in a Share Using Path Move a file or folder to another location within a shared folder in the ObjectStore, based on the file or folder path. <App_FileResourceInfo path=”” parentPath=””/>

Rename File/Folder

Rename a File or Folder Using ID Renames a file or a folder in the ObjectStore based on the file or folder GUID. <App_FileResourceInfo name="" />
Rename a File or Folder Using Path Rename a file or folder, based on the file/folder path, to another folder within the ObjectStore. <App_FileResourceInfo path=”” name="" />
Rename a File or Folder in a Share Using ID Rename a file or a folder within a shared folder in the ObjectStore, based on the GUID of the file or folder. <App_FileResourceInfo name="" />
Rename a File or Folder in a Share Using Path Rename a file or a folder within a shared folder in the ObjectStore, based on the  file or folder path. <App_FileResourceInfo path=”” name="" />

Download File/Folder

Download a File Using ID Download a file in an ObjectStore based on the GUID of the file.  
Download a File Using Path Download a file in an ObjectStore based on the file path.  
Download a File in a Share Using ID Download a shared file in the ObjectStore based on the GUID of the file.  
Download a File in a Share Using Path Download a shared file in an ObjectStore based on the file path.  
Download a File in a Public Share Using ID Download a file in the ObjectStore public share based on the GUID of the file.  
Download a File in a Public Share Using Path Download a file from the ObjectStore public share based on the file path.  

Delete File/Folder

Delete a File or Folder Using ID Deletes a file or a folder in an ObjectStore.  
Delete a File or Folder Using Path Deletes a file or a folder in an ObjectStore based on the file/folder path. <App_FileResourceInfo path=””/>
Delete a File or Folder in a Share Using ID Deletes a shared file or folder in the ObjectStore, using the file or folder GUID.  
Delete a File or Folder in a Share Using Path Deletes a shared file or folder in the ObjectStore, using the file or folder path. <App_FileResourceInfo path=””/>

Share Operations

View Shared Files and Folders View the list of shared files and folders in an ObjectStore.  
Remove Share for a File or Folder Remove the sharing on a file or folder.  
Change Share Settings Change the user permissions and settings on a shared file or folder. update_share_template.xml

Related Topic

REST API - Overview