Integrate enmeshed

This use case loads the metadata information of a File by a reference to it. This can be the truncatedReference of the File itself, which can be obtained from the File uploader, for example, when exchanging Files using Attributes, or the truncatedReference of a Token. In the latter case, the Token for the File was previously created. Loading a File that is owned by another Identity is necessary in order to be able to download the actual content of the File using the Download File use case. If a File that has already been loaded is loaded again or its uploader loads it, this use case, like the Get File metadata use case, simply returns the metadata information of the File.

Parameters

  • reference to the File.
  • The password if the File is to be loaded from a reference to a Token that is password protected via its passwordProtection property.

On Success

  • The File that corresponds to the reference.

On Failure

  • The given reference does not resolve to a File.
  • The File is to be loaded from a reference to a Token that is personalized for a different Identity via its forIdentity property.
  • No password or an incorrect password was entered in case of a File that is to be loaded from a reference to a password protected Token.

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: