This use case uses a given file outside of enmeshed, encrypts and uploads it to the Backbone and creates a File with the respective metadata information for the Identity to access it. The File can from now on be shared by references to other Identities.

Parameters

  • content is the to-be-uploaded file content as byte array
  • filename is the name of the file from the operating system.
  • mimetype of the respective file
  • Optionally, expiresAt can be specified, which describes the ISODateTime the File expires.
  • title of the File
  • Optional description of the File.

On Success

  • An encrypted File is stored on the Backbone and can be shared by its references.
  • Only the metadata of the File is stored locally.
  • If expiresAt wasn’t specified, the expiration date of the File will be set to a default value that corresponds to zero o’clock on the 31st of December, 9999.
  • The created File is returned.

On Failure

  • The parameters are malformed.
  • The file size is too big.

How to execute this use case with the Connector?

The Connector is our first-class citizen, thus we provide you with a detailed API description for every use case. This use case can be executed with the REST API of the Connector which you can Access the Connector.
Corresponding interactive API docs excerpt: