Overview

The remote upload indicator allows users to easily see if other users connected to the same filespace are still uploading file data changes to the object storage. This applies to all modified and newly created files.

This functionality is very useful when users need to know if the file is ready to be used in its entirety and no other user is modifying the file at this moment. This can also be leveraged for scripting and automation.

Another use case might be workflows with applications that do not natively support locking. In this case, the remote upload indicator can significantly reduce conflicts among multiple users working with the same files.

Local REST API

To query the Remote Upload Status of an entry programmatically, we provide a local REST API endpoint. You must first find the REST API port associated with the desired daemon and substitute it into the commands below. lucid list will provide you with the necessary information.

The remoteUpload value only applies to remote changes; local changes are not reflected in this status.

You can now make a simple curl call to the endpoint, for example:

curl "127.0.0.1:9781/v1/support.world/files?path=/test.txt"
{
   "files" : [
       {
           "id" : "618:43",
           "path" : "\/test.txt",
           "remoteUpload" : "no"
       }
   ]
}

The endpoint parameters are as follows:

Name: filespace.domain
Type: string
Description: Name of the Filespace containing the file being queried.
Required: yes

Name: path
Type: string
Description: Path to the file for which information is to be retrieved.
Required: yes

You can also refer to the client-api.yaml attached to this article.

• client-api.yaml4 KB