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:
Create an ObjectStore
Operation |
Description |
---|---|
Creates an ObjectStore for a specific user. |
Create Folder
Operation |
Description |
XML Template |
---|---|---|
Create a new folder in an ObjectStore based on the GUID of the parent folder. |
<App_FileResourceInfo name=""/> |
|
Create a new folder in an ObjectStore based on the path to the parent folder. |
<App_FileResourceInfo name="" parentPath=""/> |
|
Create a new folder within a shared folder in the ObjectStore based on the GUID of the parent folder. |
<App_FileResourceInfo name=""/> |
|
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
Operation |
Description |
XML Template |
---|---|---|
Share a specific file or folder in an ObjectStore based on the file or folder GUID. |
<App_ShareInfo status="0" sharedToOperationType="2" userPermission="2"> |
|
Share a specific file or folder in an ObjectStore based on the file or folder path. |
<App_ShareInfo status="0" sharedToOperationType="2" userPermission="2"> |
Upload File
Operation |
Description |
---|---|
Upload a single file to the ObjectStore. |
|
Upload a large file in multiple data chunks to the ObjectStore. |
|
Initiate the upload session for uploading multiple file chunks to the ObjectStore. |
|
Upload a chunk or portion of the file data to the ObjectStore. |
View File or Folder Properties
Operation |
Description |
---|---|
Returns the properties associated with a file or folder in an ObjectStore based on the file or folder GUID. |
|
Returns the properties associated with a file or folder in an ObjectStore based on the file/folder path. |
|
Returns the properties associated with a file or folder within a shared folder in the ObjectStore based on the file or folder GUID. |
|
Returns the properties associated with a file or folder within a shared folder in the ObjectStore based on the file/folder path. |
|
Returns the properties associated with an ObjectStore file or folder in a public share based on the file or folder path. |
View File Versions
Operation |
Description |
---|---|
Returns the first 50 versions of a file in an ObjectStore based on the GUID of the file. |
|
Returns the first 50 versions of a file in an ObjectStore based on the file path. |
Move File or Folder
Operation |
Description |
XML Template |
---|---|---|
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, based on the file/folder path, to another folder within the ObjectStore. |
<App_FileResourceInfo path=”” parentPath=””/> |
|
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 to another location within a shared folder in the ObjectStore, based on the file or folder path. |
<App_FileResourceInfo path=”” parentPath=””/> |
Rename File or Folder
Operation |
Description |
XML Template |
---|---|---|
Renames a file or a folder in the ObjectStore based on the file or folder GUID. |
<App_FileResourceInfo name="" /> |
|
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 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 a folder within a shared folder in the ObjectStore, based on the file or folder path. |
<App_FileResourceInfo path=”” name="" /> |
Download File or Folder
Operation |
Description |
---|---|
Download a file in an ObjectStore based on the GUID of the file. |
|
Download a file in an ObjectStore based on the file path. |
|
Download a shared file in the ObjectStore based on the GUID of the file. |
|
Download a shared file in an ObjectStore based on the file path. |
|
Download a file in the ObjectStore public share based on the GUID of the file. |
|
Download a file from the ObjectStore public share based on the file path. |
Delete File or Folder
Operation |
Description |
XML Template |
---|---|---|
Deletes a file or a folder in an ObjectStore. |
||
Deletes a file or a folder in an ObjectStore based on the file/folder path. |
<App_FileResourceInfo path=””/> |
|
Deletes a shared file or folder in the ObjectStore, using the file or folder GUID. |
||
Deletes a shared file or folder in the ObjectStore, using the file or folder path. |
<App_FileResourceInfo path=””/> |
Share Operations
Operation |
Description |
XML Template |
---|---|---|
View the list of shared files and folders in an ObjectStore. |
||
Remove the sharing on a file or folder. |
||
Change the user permissions and settings on a shared file or folder. |